summaryrefslogtreecommitdiffstats
path: root/doc/man/man3/qpaintdevicemetrics.3qt
blob: d400fd81c4e3b83496144e165a59c04dbbfaae47 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
'\" t
.TH QPaintDeviceMetrics 3qt "2 February 2007" "Trolltech AS" \" -*- nroff -*-
.\" Copyright 1992-2007 Trolltech ASA.  All rights reserved.  See the
.\" license file included in the distribution for a complete license
.\" statement.
.\"
.ad l
.nh
.SH NAME
QPaintDeviceMetrics \- Information about a paint device
.SH SYNOPSIS
\fC#include <qpaintdevicemetrics.h>\fR
.PP
.SS "Public Members"
.in +1c
.ti -1c
.BI "\fBQPaintDeviceMetrics\fR ( const QPaintDevice * pd )"
.br
.ti -1c
.BI "int \fBwidth\fR () const"
.br
.ti -1c
.BI "int \fBheight\fR () const"
.br
.ti -1c
.BI "int \fBwidthMM\fR () const"
.br
.ti -1c
.BI "int \fBheightMM\fR () const"
.br
.ti -1c
.BI "int \fBlogicalDpiX\fR () const"
.br
.ti -1c
.BI "int \fBlogicalDpiY\fR () const"
.br
.ti -1c
.BI "int \fBnumColors\fR () const"
.br
.ti -1c
.BI "int \fBdepth\fR () const"
.br
.in -1c
.SH DESCRIPTION
The QPaintDeviceMetrics class provides information about a paint device.
.PP
Sometimes when drawing graphics it is necessary to obtain information about the physical characteristics of a paint device. This class provides the information. For example, to compute the aspect ratio of a paint device:
.PP
.nf
.br
        QPaintDeviceMetrics pdm( myWidget );
.br
        double aspect = (double)pdm.widthMM() / (double)pdm.heightMM();
.br
.fi
.PP
QPaintDeviceMetrics contains methods to provide the width and height of a device in both pixels (width() and height()) and millimeters (widthMM() and heightMM()), the number of colors the device supports (numColors()), the number of bit planes (depth()), and the resolution of the device (logicalDpiX() and logicalDpiY()).
.PP
It is not always possible for QPaintDeviceMetrics to compute the values you ask for, particularly for external devices. The ultimate example is asking for the resolution of of a QPrinter that is set to "print to file": who knows what printer that file will end up on?
.PP
See also Graphics Classes and Image Processing Classes.
.SH MEMBER FUNCTION DOCUMENTATION
.SH "QPaintDeviceMetrics::QPaintDeviceMetrics ( const QPaintDevice * pd )"
Constructs a metric for the paint device \fIpd\fR.
.SH "int QPaintDeviceMetrics::depth () const"
Returns the bit depth (number of bit planes) of the paint device.
.SH "int QPaintDeviceMetrics::height () const"
Returns the height of the paint device in default coordinate system units (e.g. pixels for QPixmap and QWidget).
.PP
Examples:
.)l action/application.cpp, application/application.cpp, helpviewer/helpwindow.cpp, mdi/application.cpp, and qwerty/qwerty.cpp.
.SH "int QPaintDeviceMetrics::heightMM () const"
Returns the height of the paint device, measured in millimeters.
.SH "int QPaintDeviceMetrics::logicalDpiX () const"
Returns the horizontal resolution of the device in dots per inch, which is used when computing font sizes. For X, this is usually the same as could be computed from widthMM(), but it varies on Windows.
.PP
Example: qwerty/qwerty.cpp.
.SH "int QPaintDeviceMetrics::logicalDpiY () const"
Returns the vertical resolution of the device in dots per inch, which is used when computing font sizes. For X, this is usually the same as could be computed from heightMM(), but it varies on Windows.
.PP
Examples:
.)l action/application.cpp, application/application.cpp, helpviewer/helpwindow.cpp, and mdi/application.cpp.
.SH "int QPaintDeviceMetrics::numColors () const"
Returns the number of different colors available for the paint device. Since this value is an int will not be sufficient to represent the number of colors on 32 bit displays, in which case INT_MAX is returned instead.
.SH "int QPaintDeviceMetrics::width () const"
Returns the width of the paint device in default coordinate system units (e.g. pixels for QPixmap and QWidget).
.PP
Examples:
.)l action/application.cpp, application/application.cpp, helpviewer/helpwindow.cpp, mdi/application.cpp, and qwerty/qwerty.cpp.
.SH "int QPaintDeviceMetrics::widthMM () const"
Returns the width of the paint device, measured in millimeters.

.SH "SEE ALSO"
.BR http://doc.trolltech.com/qpaintdevicemetrics.html
.BR http://www.trolltech.com/faq/tech.html
.SH COPYRIGHT
Copyright 1992-2007 Trolltech ASA, http://www.trolltech.com.  See the
license file included in the distribution for a complete license
statement.
.SH AUTHOR
Generated automatically from the source code.
.SH BUGS
If you find a bug in Qt, please report it as described in
.BR http://doc.trolltech.com/bughowto.html .
Good bug reports help us to help you. Thank you.
.P
The definitive Qt documentation is provided in HTML format; it is
located at $QTDIR/doc/html and can be read using Qt Assistant or with
a web browser. This man page is provided as a convenience for those
users who prefer man pages, although this format is not officially
supported by Trolltech. 
.P
If you find errors in this manual page, please report them to
.BR qt-bugs@trolltech.com .
Please include the name of the manual page (qpaintdevicemetrics.3qt) and the Qt
version (3.3.8).