描述页面大小、取向及边距。 更多...
| 头： |
#include <QPageLayout>
|
| CMake: |
find_package(Qt6 REQUIRED COMPONENTS Gui)
target_link_libraries(mytarget PRIVATE Qt6::Gui)
|
| qmake: |
QT += gui
|
| enum | 模式 { StandardMode, FullPageMode } |
| enum | 取向 { Portrait, Landscape } |
(从 6.8 起)
枚举类
|
OutOfBoundsPolicy { Reject, Clamp } |
| enum | Unit { Millimeter, Point, Inch, Pica, Didot, Cicero } |
| 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 ) |
| bool | operator!= (const QPageLayout & lhs , const QPageLayout & rhs ) |
| bool | operator== (const QPageLayout & lhs , const QPageLayout & rhs ) |
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.
在 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.
另请参阅 QPageSize .
定义页面布局模式
| 常量 | 值 | 描述 |
|---|---|---|
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.
另请参阅 OutOfBoundsPolicy .
此枚举类型定义页面取向
| 常量 | 值 | 描述 |
|---|---|---|
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
| 常量 | 值 | 描述 |
|---|---|---|
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. |
注意： The policy has no effect in FullPageMode , where all margins are accepted.
该枚举在 Qt 6.8 引入。
This enum type is used to specify the measurement unit for page layout and margins.
| 常量 | 值 | 描述 |
|---|---|---|
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 |
创建无效 QPageLayout。
Creates a QPageLayout with the given pageSize , orientation and margins 以给定 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.
拷贝构造函数，拷贝 other to this.
[noexcept]
QPageLayout::
~QPageLayout
()
销毁页面布局。
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.
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.
另请参阅 paintRect ().
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.
另请参阅 paintRect ().
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.
另请参阅 paintRect ().
返回
true
if this page layout is equivalent to the
other
page layout, i.e. if the page has the same size, margins and orientation.
返回
true
if this page layout is valid.
Returns the margins of the page layout using the currently set units.
另请参阅 setMargins () 和 units ().
Returns the margins of the page layout using the requested units .
另请参阅 setMargins () 和 margins ().
Returns the margins of the page layout in device pixels for the given resolution .
另请参阅 setMargins ().
Returns the margins of the page layout in Postscript Points (1/72 of an inch).
另请参阅 setMargins () 和 margins ().
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.
另请参阅 setMinimumMargins () 和 minimumMargins ().
Returns the minimum margins of the page layout.
另请参阅 setMinimumMargins () 和 maximumMargins ().
Returns the page layout mode.
另请参阅 setMode ().
Returns the page orientation of the page layout.
另请参阅 setOrientation ().
Returns the page size of the page layout.
注意， QPageSize is always defined in a Portrait orientation. To obtain a size that takes the set orientation into account you must use fullRect ().
另请参阅 setPageSize ().
Returns the page rectangle in the current layout units.
The paintable rectangle takes into account the page size, orientation and margins.
若 FullPageMode mode is set then the fullRect () is returned and the margins must be manually managed.
Returns the page rectangle in the required units .
The paintable rectangle takes into account the page size, orientation and margins.
若 FullPageMode mode is set then the fullRect () is returned and the margins must be manually managed.
Returns the paintable rectangle in rounded device pixels for the given resolution .
The paintable rectangle takes into account the page size, orientation and margins.
若 FullPageMode mode is set then the fullRect () is returned and the margins must be manually managed.
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.
若 FullPageMode mode is set then the fullRect () is returned and the margins must be manually managed.
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.
另请参阅 setMargins () 和 margins ().
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.
另请参阅 setMargins () 和 margins ().
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.
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.
若 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.
另请参阅 minimumMargins () 和 setMargins ().
Sets a page layout mode to mode .
另请参阅 mode ().
Sets the page orientation of the page layout to orientation .
Changing the orientation does not affect the current margins or the minimum margins.
另请参阅 orientation ().
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.
若 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.
另请参阅 pageSize ().
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.
另请参阅 setMargins () 和 margins ().
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.
另请参阅 setMargins () 和 margins ().
设置 units used to define the page layout.
另请参阅 units ().
[noexcept]
void
QPageLayout::
swap
(
QPageLayout
&
other
)
交换此页面布局与 other 。此操作非常快且从不失败。
Returns the units the page layout is currently defined in.
另请参阅 setUnits ().
[noexcept]
QPageLayout
&QPageLayout::
operator=
(
QPageLayout
&&
other
)
移动赋值 other 到此 QPageLayout instance, transferring the ownership of the managed pointer to this instance.
赋值运算符，赋值 other to this.
返回
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.
另请参阅 QPageLayout::isEquivalentTo ().
返回
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.
另请参阅 QPageLayout::isEquivalentTo ().