QPageLayout Class
Describes the size, orientation and margins of a page. More...
| Header: | #include <QPageLayout> |
| CMake: | find_package(Qt6 REQUIRED COMPONENTS Gui)target_link_libraries(mytarget PRIVATE Qt6::Gui) |
| qmake: | QT += gui |
Public Types
| enum | Mode { StandardMode, FullPageMode } |
| enum | Orientation { Portrait, Landscape } |
(since 6.8) enum class | OutOfBoundsPolicy { Reject, Clamp } |
| enum | Unit { Millimeter, Point, Inch, Pica, Didot, Cicero } |
Public Functions
| QPageLayout() | |
| QPageLayout(const QPageSize &pageSize, QPageLayout::Orientation orientation, const QMarginsF &margins, QPageLayout::Unit units = Point, const QMarginsF &minMargins = QMarginsF(0, 0, 0, 0)) | |
| QPageLayout(const QPageLayout &other) | |
| ~QPageLayout() | |
| QRectF | fullRect() const |
| QRectF | fullRect(QPageLayout::Unit units) const |
| QRect | fullRectPixels(int resolution) const |
| QRect | fullRectPoints() const |
| bool | isEquivalentTo(const QPageLayout &other) const |
| bool | isValid() const |
| QMarginsF | margins() const |
| QMarginsF | margins(QPageLayout::Unit units) const |
| QMargins | marginsPixels(int resolution) const |
| QMargins | marginsPoints() const |
| QMarginsF | maximumMargins() const |
| QMarginsF | minimumMargins() const |
| QPageLayout::Mode | mode() const |
| QPageLayout::Orientation | orientation() const |
| QPageSize | pageSize() const |
| QRectF | paintRect() const |
| QRectF | paintRect(QPageLayout::Unit units) const |
| QRect | paintRectPixels(int resolution) const |
| QRect | paintRectPoints() const |
| bool | setBottomMargin(qreal bottomMargin, QPageLayout::OutOfBoundsPolicy outOfBoundsPolicy = OutOfBoundsPolicy::Reject) |
| bool | setLeftMargin(qreal leftMargin, QPageLayout::OutOfBoundsPolicy outOfBoundsPolicy = OutOfBoundsPolicy::Reject) |
| bool | setMargins(const QMarginsF &margins, QPageLayout::OutOfBoundsPolicy outOfBoundsPolicy = OutOfBoundsPolicy::Reject) |
| void | setMinimumMargins(const QMarginsF &minMargins) |
| void | setMode(QPageLayout::Mode mode) |
| void | setOrientation(QPageLayout::Orientation orientation) |
| void | setPageSize(const QPageSize &pageSize, const QMarginsF &minMargins = QMarginsF(0, 0, 0, 0)) |
| bool | setRightMargin(qreal rightMargin, QPageLayout::OutOfBoundsPolicy outOfBoundsPolicy = OutOfBoundsPolicy::Reject) |
| bool | setTopMargin(qreal topMargin, QPageLayout::OutOfBoundsPolicy outOfBoundsPolicy = OutOfBoundsPolicy::Reject) |
| void | setUnits(QPageLayout::Unit units) |
| void | swap(QPageLayout &other) |
| QPageLayout::Unit | units() const |
| QPageLayout & | operator=(QPageLayout &&other) |
| QPageLayout & | operator=(const QPageLayout &other) |
Related Non-Members
| bool | operator!=(const QPageLayout &lhs, const QPageLayout &rhs) |
| bool | operator==(const QPageLayout &lhs, const QPageLayout &rhs) |
Detailed Description
The QPageLayout class defines the layout of a page in a paged document, with the page size, orientation and margins able to be set and the full page and paintable page rectangles defined by those attributes able to be queried in a variety of units.
The page size is defined by the QPageSize class which can be queried for page size attributes. Note that the QPageSize itself is always defined in a Portrait orientation.
The minimum margins can be defined for the layout but normally default to 0. When used in conjunction with Qt's printing support the minimum margins will reflect the minimum printable area defined by the printer.
In the default StandardMode the current margins and minimum margins are always taken into account. The paintable rectangle is the full page rectangle less the current margins, and the current margins can only be set to values between the minimum margins and the maximum margins allowed by the full page size.
In FullPageMode the current margins and minimum margins are not taken into account. The paintable rectangle is the full page rectangle, and the current margins can be set to any values regardless of the minimum margins and page size.
See also QPageSize.
Member Type Documentation
enum QPageLayout::Mode
Defines the page layout mode
| Constant | Value | Description |
|---|---|---|
QPageLayout::StandardMode | 0 | Paint Rect includes margins, margins must fall between the minimum and maximum. |
QPageLayout::FullPageMode | 1 | Paint Rect excludes margins, margins can be any value and must be managed manually. |
In StandardMode, when setting margins, use Clamp to automatically clamp the margins to fall between the minimum and maximum allowed values.
See also OutOfBoundsPolicy.
enum QPageLayout::Orientation
This enum type defines the page orientation
| Constant | Value | Description |
|---|---|---|
QPageLayout::Portrait | 0 | The page size is used in its default orientation |
QPageLayout::Landscape | 1 | The page size is rotated through 90 degrees |
Note that some standard page sizes are defined with a width larger than their height, hence the orientation is defined relative to the standard page size and not using the relative page dimensions.
[since 6.8] enum class QPageLayout::OutOfBoundsPolicy
Defines the policy for margins that are out of bounds
| Constant | Value | Description |
|---|---|---|
QPageLayout::OutOfBoundsPolicy::Reject | 0 | The margins must fall within the minimum and maximum values, otherwise they will be rejected. |
QPageLayout::OutOfBoundsPolicy::Clamp | 1 | The margins are clamped between the minimum and maximum values to ensure they are valid. |
Note: The policy has no effect in FullPageMode, where all margins are accepted.
This enum was introduced in Qt 6.8.
enum QPageLayout::Unit
This enum type is used to specify the measurement unit for page layout and margins.
| Constant | Value | Description |
|---|---|---|
QPageLayout::Millimeter | 0 | |
QPageLayout::Point | 1 | 1/72th of an inch |
QPageLayout::Inch | 2 | |
QPageLayout::Pica | 3 | 1/72th of a foot, 1/6th of an inch, 12 Points |
QPageLayout::Didot | 4 | 1/72th of a French inch, 0.375 mm |
QPageLayout::Cicero | 5 | 1/6th of a French inch, 12 Didot, 4.5mm |
Member Function Documentation
QPageLayout::QPageLayout()
Creates an invalid QPageLayout.
QPageLayout::QPageLayout(const QPageSize &pageSize, QPageLayout::Orientation orientation, const QMarginsF &margins, QPageLayout::Unit units = Point, const QMarginsF &minMargins = QMarginsF(0, 0, 0, 0))
Creates a QPageLayout with the given pageSize, orientation and margins in the given units.
Optionally define the minimum allowed margins minMargins, e.g. the minimum margins able to be printed by a physical print device.
The constructed QPageLayout will be in StandardMode.
The margins given will be clamped to the minimum margins and the maximum margins allowed by the page size.
QPageLayout::QPageLayout(const QPageLayout &other)
Copy constructor, copies other to this.
[noexcept] QPageLayout::~QPageLayout()
Destroys the page layout.
QRectF QPageLayout::fullRect() const
Returns the full page rectangle in the current layout units.
The page rectangle takes into account the page size and page orientation, but not the page margins.
See also paintRect() and units().
QRectF QPageLayout::fullRect(QPageLayout::Unit units) const
Returns the full page rectangle in the required units.
The page rectangle takes into account the page size and page orientation, but not the page margins.
See also paintRect().
QRect QPageLayout::fullRectPixels(int resolution) const
Returns the full page rectangle in device pixels for the given resolution.
The page rectangle takes into account the page size and page orientation, but not the page margins.
See also paintRect().
QRect QPageLayout::fullRectPoints() const
Returns the full page rectangle in Postscript Points (1/72 of an inch).
The page rectangle takes into account the page size and page orientation, but not the page margins.
See also paintRect().
bool QPageLayout::isEquivalentTo(const QPageLayout &other) const
Returns true if this page layout is equivalent to the other page layout, i.e. if the page has the same size, margins and orientation.
bool QPageLayout::isValid() const
Returns true if this page layout is valid.
QMarginsF QPageLayout::margins() const
Returns the margins of the page layout using the currently set units.
See also setMargins() and units().
QMarginsF QPageLayout::margins(QPageLayout::Unit units) const
Returns the margins of the page layout using the requested units.
See also setMargins() and margins().
QMargins QPageLayout::marginsPixels(int resolution) const
Returns the margins of the page layout in device pixels for the given resolution.
See also setMargins().
QMargins QPageLayout::marginsPoints() const
Returns the margins of the page layout in Postscript Points (1/72 of an inch).
See also setMargins() and margins().
QMarginsF QPageLayout::maximumMargins() const
Returns the maximum margins that would be applied if the page layout was in StandardMode.
The maximum margins allowed are calculated as the full size of the page minus the minimum margins set. For example, if the page width is 100 points and the minimum right margin is 10 points, then the maximum left margin will be 90 points.
See also setMinimumMargins() and minimumMargins().
QMarginsF QPageLayout::minimumMargins() const
Returns the minimum margins of the page layout.
See also setMinimumMargins() and maximumMargins().
QPageLayout::Mode QPageLayout::mode() const
Returns the page layout mode.
See also setMode().
QPageLayout::Orientation QPageLayout::orientation() const
Returns the page orientation of the page layout.
See also setOrientation().
QPageSize QPageLayout::pageSize() const
Returns the page size of the page layout.
Note that the QPageSize is always defined in a Portrait orientation. To obtain a size that takes the set orientation into account you must use fullRect().
See also setPageSize().
QRectF QPageLayout::paintRect() const
Returns the page rectangle in the current layout units.
The paintable rectangle takes into account the page size, orientation and margins.
If the FullPageMode mode is set then the fullRect() is returned and the margins must be manually managed.
QRectF QPageLayout::paintRect(QPageLayout::Unit units) const
Returns the page rectangle in the required units.
The paintable rectangle takes into account the page size, orientation and margins.
If the FullPageMode mode is set then the fullRect() is returned and the margins must be manually managed.
QRect QPageLayout::paintRectPixels(int resolution) const
Returns the paintable rectangle in rounded device pixels for the given resolution.
The paintable rectangle takes into account the page size, orientation and margins.
If the FullPageMode mode is set then the fullRect() is returned and the margins must be manually managed.
QRect QPageLayout::paintRectPoints() const
Returns the paintable rectangle in rounded Postscript Points (1/72 of an inch).
The paintable rectangle takes into account the page size, orientation and margins.
If the FullPageMode mode is set then the fullRect() is returned and the margins must be manually managed.
bool QPageLayout::setBottomMargin(qreal bottomMargin, QPageLayout::OutOfBoundsPolicy outOfBoundsPolicy = OutOfBoundsPolicy::Reject)
Sets the bottom page margin of the page layout to bottomMargin. Returns true if the margin was successfully set.
The units used are those currently defined for the layout. To use different units call setUnits() first.
Since Qt 6.8, the optional outOfBoundsPolicy can be used to specify how margins that are out of bounds are handled.
See also setMargins() and margins().
bool QPageLayout::setLeftMargin(qreal leftMargin, QPageLayout::OutOfBoundsPolicy outOfBoundsPolicy = OutOfBoundsPolicy::Reject)
Sets the left page margin of the page layout to leftMargin. Returns true if the margin was successfully set.
The units used are those currently defined for the layout. To use different units call setUnits() first.
Since Qt 6.8, the optional outOfBoundsPolicy can be used to specify how margins that are out of bounds are handled.
See also setMargins() and margins().
bool QPageLayout::setMargins(const QMarginsF &margins, QPageLayout::OutOfBoundsPolicy outOfBoundsPolicy = OutOfBoundsPolicy::Reject)
Sets the page margins of the page layout to margins. Returns true if the margins were successfully set.
The units used are those currently defined for the layout. To use different units then call setUnits() first.
Since Qt 6.8, the optional outOfBoundsPolicy can be used to specify how margins that are out of bounds are handled.
See also margins() and units().
void QPageLayout::setMinimumMargins(const QMarginsF &minMargins)
Sets the minimum page margins of the page layout to minMargins.
It is not recommended to override the default values set for a page size as this may be the minimum printable area for a physical print device.
If the StandardMode mode is set then the existing margins will be clamped to the new minMargins and the maximum allowed by the page size. If the FullPageMode is set then the existing margins will be unchanged.
See also minimumMargins() and setMargins().
void QPageLayout::setMode(QPageLayout::Mode mode)
Sets a page layout mode to mode.
See also mode().
void QPageLayout::setOrientation(QPageLayout::Orientation orientation)
Sets the page orientation of the page layout to orientation.
Changing the orientation does not affect the current margins or the minimum margins.
See also orientation().
void QPageLayout::setPageSize(const QPageSize &pageSize, const QMarginsF &minMargins = QMarginsF(0, 0, 0, 0))
Sets the page size of the page layout to pageSize.
Optionally define the minimum allowed margins minMargins, e.g. the minimum margins able to be printed by a physical print device, otherwise the minimum margins will default to 0.
If StandardMode is set then the existing margins will be clamped to the new minimum margins and the maximum margins allowed by the page size. If FullPageMode is set then the existing margins will be unchanged.
See also pageSize().
bool QPageLayout::setRightMargin(qreal rightMargin, QPageLayout::OutOfBoundsPolicy outOfBoundsPolicy = OutOfBoundsPolicy::Reject)
Sets the right page margin of the page layout to rightMargin. Returns true if the margin was successfully set.
The units used are those currently defined for the layout. To use different units call setUnits() first.
Since Qt 6.8, the optional outOfBoundsPolicy can be used to specify how margins that are out of bounds are handled.
See also setMargins() and margins().
bool QPageLayout::setTopMargin(qreal topMargin, QPageLayout::OutOfBoundsPolicy outOfBoundsPolicy = OutOfBoundsPolicy::Reject)
Sets the top page margin of the page layout to topMargin. Returns true if the margin was successfully set.
The units used are those currently defined for the layout. To use different units call setUnits() first.
Since Qt 6.8, the optional outOfBoundsPolicy can be used to specify how margins that are out of bounds are handled.
See also setMargins() and margins().
void QPageLayout::setUnits(QPageLayout::Unit units)
Sets the units used to define the page layout.
See also units().
[noexcept] void QPageLayout::swap(QPageLayout &other)
Swaps this page layout with other. This function is very fast and never fails.
QPageLayout::Unit QPageLayout::units() const
Returns the units the page layout is currently defined in.
See also setUnits().
[noexcept] QPageLayout &QPageLayout::operator=(QPageLayout &&other)
Move-assigns other to this QPageLayout instance, transferring the ownership of the managed pointer to this instance.
QPageLayout &QPageLayout::operator=(const QPageLayout &other)
Assignment operator, assigns other to this.
Related Non-Members
bool operator!=(const QPageLayout &lhs, const QPageLayout &rhs)
Returns true if page layout lhs is not equal to page layout rhs, i.e. if any of the attributes differ.
Note that this is a strict equality, especially for page size where the QPageSize ID, name and size must exactly match, and the margins where the units must match.
See also QPageLayout::isEquivalentTo().
bool operator==(const QPageLayout &lhs, const QPageLayout &rhs)
Returns true if page layout lhs is equal to page layout rhs, i.e. if all the attributes are exactly equal.
Note that this is a strict equality, especially for page size where the QPageSize ID, name and size must exactly match, and the margins where the units must match.
See also QPageLayout::isEquivalentTo().