QPageSize¶
- PyQt5.QtGui.QPageSize
Description¶
The QPageSize class describes the size and name of a defined page size.
This class implements support for the set of standard page sizes as defined in the Adobe Postscript PPD Standard v4.3. It defines the standard set of page sizes in points, millimeters and inches and ensures these sizes are consistently used. Other size units can be used but will be calculated results and so may not always be consistent. The defined point sizes are always a integer, all other sizes can be fractions of a unit.
The defined size is always in width x height order with no implied page orientation. Note that it is possible for page sizes to be defined where the width is greater than the height, such as Ledger, so you cannot rely on comparing the width and height values to determine page orientation.
For example, A4 is defined by the standard as 210mm x 297mm, 8.27in x 11.69in, or 595pt x 842pt.
You can also define custom page sizes with custom names in any units you want and this unit size will be preserved and used as the base for all other unit size calculations.
When creating a QPageSize using a custom QSize you can choose if you want QPageSize to try match the size to a standard page size. By default QPaperSize uses a FuzzyMatch mode where it will match a given page size to a standard page size if it falls within 3 postscript points of a defined standard size. You can override this to request only an exact match but this is not recommended as conversions between units can easily lose 3 points and result in incorrect page sizes.
A QPageSize instance may also be obtained by querying the supported page sizes for a print device. In this case the localized name returned is that defined by the printer itself. Note that the print device may not support the current default locale language.
The class also provides convenience methods for converting page size IDs to and from various unit sizes.
See also
Enums¶
- PageSizeId
This enum type lists the available page sizes as defined in the Postscript PPD standard. These values are duplicated in QPagedPaintDevice and QPrinter.
The defined sizes are:
Due to historic reasons is not the same as the standard Postscript and Windows Executive size, use instead.
The Postscript standard size is different to the Windows DMPAPER_FOLIO size, use the Postscript standard size if needed.
Member
Value
Description
A0 5
841 x 1189 mm
A1 6
594 x 841 mm
A10 TODO
TODO
A2 7
420 x 594 mm
A3 8
297 x 420 mm
A3Extra TODO
TODO
A4 0
210 x 297 mm, 8.26 x 11.69 inches
A4Extra TODO
TODO
A4Plus TODO
TODO
A4Small TODO
TODO
A5 9
148 x 210 mm
A5Extra TODO
TODO
A6 10
105 x 148 mm
A7 11
74 x 105 mm
A8 12
52 x 74 mm
A9 13
37 x 52 mm
AnsiA Letter
= Letter
AnsiB Ledger
= Ledger
AnsiC TODO
TODO
AnsiD TODO
TODO
AnsiE TODO
TODO
ArchA TODO
TODO
ArchB TODO
TODO
ArchC TODO
TODO
ArchD TODO
TODO
ArchE TODO
TODO
B0 14
1000 x 1414 mm
B1 15
707 x 1000 mm
B10 16
31 x 44 mm
B2 17
500 x 707 mm
B3 18
353 x 500 mm
B4 19
250 x 353 mm
B5 1
176 x 250 mm, 6.93 x 9.84 inches
B5Extra TODO
TODO
B6 20
125 x 176 mm
B7 21
88 x 125 mm
B8 22
62 x 88 mm
B9 23
44 x 62 mm
C5E 24
163 x 229 mm
Comm10E 25
105 x 241 mm, U.S. Common 10 Envelope
Custom 30
Unknown, or a user defined size.
DLE 26
110 x 220 mm
DoublePostcard TODO
TODO
Envelope10 Comm10E
=
Envelope11 TODO
TODO
Envelope12 TODO
TODO
Envelope14 TODO
TODO
Envelope9 TODO
TODO
EnvelopeB4 TODO
TODO
EnvelopeB5 TODO
TODO
EnvelopeB6 TODO
TODO
EnvelopeC0 TODO
TODO
EnvelopeC1 TODO
TODO
EnvelopeC2 TODO
TODO
EnvelopeC3 TODO
TODO
EnvelopeC4 TODO
TODO
EnvelopeC5 C5E
= C5E
EnvelopeC6 TODO
TODO
EnvelopeC65 TODO
TODO
EnvelopeC7 TODO
TODO
EnvelopeChou3 TODO
TODO
EnvelopeChou4 TODO
TODO
EnvelopeDL DLE
= DLE
EnvelopeInvite TODO
TODO
EnvelopeItalian TODO
TODO
EnvelopeKaku2 TODO
TODO
EnvelopeKaku3 TODO
TODO
EnvelopeMonarch TODO
TODO
EnvelopePersonal TODO
TODO
EnvelopePrc1 TODO
TODO
EnvelopePrc10 TODO
TODO
EnvelopePrc2 TODO
TODO
EnvelopePrc3 TODO
TODO
EnvelopePrc4 TODO
TODO
EnvelopePrc5 TODO
TODO
EnvelopePrc6 TODO
TODO
EnvelopePrc7 TODO
TODO
EnvelopePrc8 TODO
TODO
EnvelopePrc9 TODO
TODO
EnvelopeYou4 TODO
TODO
Executive 4
7.5 x 10 inches, 190.5 x 254 mm
ExecutiveStandard TODO
TODO
FanFoldGerman TODO
TODO
FanFoldGermanLegal TODO
TODO
FanFoldUS TODO
TODO
Folio 27
210 x 330 mm
Imperial10x11 TODO
TODO
Imperial10x13 TODO
TODO
Imperial10x14 TODO
TODO
Imperial12x11 TODO
TODO
Imperial15x11 TODO
TODO
Imperial7x9 TODO
TODO
Imperial8x10 TODO
TODO
Imperial9x11 TODO
TODO
Imperial9x12 TODO
TODO
JisB0 TODO
TODO
JisB1 TODO
TODO
JisB10 TODO
TODO
JisB2 TODO
TODO
JisB3 TODO
TODO
JisB4 TODO
TODO
JisB5 TODO
TODO
JisB6 44
,
JisB7 TODO
TODO
JisB8 TODO
TODO
JisB9 TODO
TODO
LastPageSize EnvelopeYou4
=
Ledger 28
431.8 x 279.4 mm
Legal 3
8.5 x 14 inches, 215.9 x 355.6 mm
LegalExtra TODO
TODO
Letter 2
8.5 x 11 inches, 215.9 x 279.4 mm
LetterExtra TODO
TODO
LetterPlus TODO
TODO
LetterSmall TODO
TODO
Note TODO
TODO
NPageSize TODO
TODO
NPaperSize TODO
TODO
Postcard TODO
TODO
Prc16K TODO
TODO
Prc32K TODO
TODO
Prc32KBig TODO
TODO
Quarto TODO
TODO
Statement TODO
TODO
SuperA TODO
TODO
SuperB TODO
TODO
Tabloid 29
279.4 x 431.8 mm
TabloidExtra TODO
TODO
- SizeMatchPolicy
Member
Value
Description
ExactMatch 2
Only match to a standard page size if the sizes match exactly.
FuzzyMatch 0
Match to a standard page size if within the margin of tolerance.
FuzzyOrientationMatch 1
Match to a standard page size if within the margin of tolerance regardless of orientation.
- Unit
This enum type is used to specify the measurement unit for page sizes.
Member
Value
Description
Cicero 5
1/6th of a French inch, 12 Didot, 4.5mm
Didot 4
1/72th of a French inch, 0.375 mm
Inch TODO
TODO
Millimeter TODO
TODO
Pica 3
1/72th of a foot, 1/6th of an inch, 12 Points
Point 1
1/72th of an inch
Methods¶
- __init__()
Creates a null QPageSize.
- __init__(PageSizeId)
Creates a QPageSize of the standard pageSize.
If pageSize is Custom then the resulting QPageSize will not be valid. Use the custom size constructor instead.
- __init__(QPageSize)
Copy constructor, copies other to this.
- __init__(QSize, name: str = '', matchPolicy: SizeMatchPolicy = FuzzyMatch)
Creates a QPageSize of the given pointSize in Points using the matching matchPolicy.
If the given pointSize matches a standard PageSizeId, then that page size will be used. Note that if the matchPolicy is FuzzyMatch this may result in the pointSize being adjusted to the standard size. To prevent this happening use a matchPolicy of ExactMatch instead.
If the given pointSize is not a standard PageSizeId then a Custom size will be created.
If name is null then the standard localized name will be used. If a custom page size then a custom name in the format “Custom (width x height)” will be created.
The matchPolicy defaults to FuzzyMatch.
- __init__(QSizeF, Unit, name: str = '', matchPolicy: SizeMatchPolicy = FuzzyMatch)
Creates a custom page of the given size in units.
If the given size matches a standard PageSizeId, then that page size will be used. Note that if the matchPolicy is FuzzyMatch this may result in the size being adjusted to the standard size. To prevent this happening use a matchPolicy of ExactMatch instead.
If the given size is not a standard PageSizeId then a Custom size will be created. The original unit size will be preserved and used as the base for all other unit size calculations.
If name is null then a custom name will be created in the form “Custom (width x height)” where the size is expressed in units provided.
- definitionSize() → QSizeF
Returns the definition size of the page size.
For a standard page size this will be the size as defined in the relevant standard, i.e. ISO A4 will be defined in millimeters while ANSI Letter will be defined in inches.
For a custom page size this will be the original size used to create the page size object.
If the QPageSize is invalid then the QSizeF will be invalid.
See also
-
@staticmethod
definitionSize(PageSizeId) → QSizeF Returns the definition size of the standard pageSizeId.
To obtain the definition units, call QPageSize::definitionUnits().
- definitionUnits() → Unit
Returns the definition units of the page size.
For a standard page size this will be the units as defined in the relevant standard, i.e. ISO A4 will be defined in millimeters while ANSI Letter will be defined in inches.
For a custom page size this will be the original units used to create the page size object.
If the QPageSize is invalid then the Unit will be invalid.
See also
-
@staticmethod
definitionUnits(PageSizeId) → Unit Returns the definition units of the standard pageSizeId.
To obtain the definition size, call QPageSize::definitionSize().
- __eq__(QPageSize) → bool
TODO
- id() → PageSizeId
Returns the standard PageSizeId of the page, or Custom.
-
@staticmethod
id(int) → PageSizeId Returns the PageSizeId for the given Windows DMPAPER enum value windowsId.
If there is no matching PageSizeId then Custom is returned.
-
@staticmethod
id(QSize, matchPolicy: SizeMatchPolicy = FuzzyMatch) → PageSizeId Returns the standard PageSizeId of the given pointSize in points using the given matchPolicy.
If using FuzzyMatch then the point size of the PageSizeId returned may not exactly match the pointSize you passed in. You should call QPageSize::sizePoints() using the returned PageSizeId to find out the actual point size of the PageSizeId before using it in any calculations.
-
@staticmethod
id(QSizeF, Unit, matchPolicy: SizeMatchPolicy = FuzzyMatch) → PageSizeId Returns the standard PageSizeId of the given size in units using the given matchPolicy.
If using FuzzyMatch then the unit size of the PageSizeId returned may not exactly match the size you passed in. You should call QPageSize::size() using the returned PageSizeId to find out the actual unit size of the PageSizeId before using it in any calculations.
- isEquivalentTo(QPageSize) → bool
Returns
trueif this page is equivalent to the other page, i.e. if the page has the same size regardless of other attributes like name.
- isValid() → bool
Returns
trueif this page size is valid.The page size may be invalid if created with an invalid PageSizeId, or a negative or invalid QSize or QSizeF, or the null constructor.
- key() → str
Returns the unique key of the page size.
By default this is the PPD standard mediaOption keyword for the page size, or the PPD custom format key. If the QPageSize instance was obtained from a print device then this will be the key provided by the print device and may differ from the standard key.
If the QPageSize is invalid then the key will be an empty string.
This key should never be shown to end users, it is an internal key only. For a human-readable name use name().
See also
-
@staticmethod
key(PageSizeId) → str Returns the PPD mediaOption keyword of the standard pageSizeId.
If the QPageSize is invalid then the key will be empty.
- name() → str
Returns a localized human-readable name for the page size.
If the QPageSize instance was obtained from a print device then the name used is that provided by the print device. Note that a print device may not support the current default locale language.
If the QPageSize is invalid then the name will be an empty string.
-
@staticmethod
name(PageSizeId) → str Returns the localized name of the standard pageSizeId.
If the QPageSize is invalid then the name will be empty.
- __ne__(QPageSize) → bool
TODO
- rectPixels(int) → QRect
Returns the page rectangle in Device Pixels at the given resolution.
- rectPoints() → QRect
Returns the page rectangle in Postscript Points (1/72 of an inch).
- size(Unit) → QSizeF
Returns the size of the page in the required units.
If the QPageSize is invalid then the QSizeF will be invalid.
-
@staticmethod
size(PageSizeId, Unit) → QSizeF Returns the size of the standard pageSizeId in the requested units.
- sizePixels(int) → QSize
Returns the size of the page in Device Pixels at the given resolution.
-
@staticmethod
sizePixels(PageSizeId, int) → QSize Returns the size of the standard pageSizeId in Device Pixels for the given resolution.
- sizePoints() → QSize
Returns the size of the page in Postscript Points (1/72 of an inch).
-
@staticmethod
sizePoints(PageSizeId) → QSize Returns the size of the standard pageSizeId in Points.
- swap(QPageSize)
TODO
- windowsId() → int
Returns the Windows DMPAPER enum value for the page size.
Not all valid PPD page sizes have a Windows equivalent, in which case 0 will be returned.
If the QPageSize is invalid then the Windows ID will be 0.
See also
id().
-
@staticmethod
windowsId(PageSizeId) → int Returns the Windows DMPAPER enum value of the standard pageSizeId.
Not all valid PPD page sizes have a Windows equivalent, in which case 0 will be returned.
