class QPageLayout#

描述页的大小、方向和边距。 更多信息…

概要#

方法#

备注

此文档可能包含从C++自动翻译到Python的代码片段。我们始终欢迎对片段翻译的贡献。如果您发现翻译有问题，您也可以通过在https:/bugreports.qt.io/projects/PYSIDE创建一个问题来告诉我们。

详细描述#

QPageLayout类定义了分页文档中页面的布局，可以设置页面大小、方向和边距，并可以通过各种单位查询由这些属性定义的全页面和可绘制页面矩形。

页面大小由QPageSize类定义，可以查询页面大小属性。请注意，QPageSize自身始终定义为纵向方向。

可以为布局定义最小边距，但通常默认为0。当与Qt的打印支持一起使用时，最小边距将反映打印机定义的最小打印区域。

在默认的StandardMode中，当前的边距和最小边距总是会被考虑进去。可绘制的矩形是整个页面矩形减去当前边距，并且当前边距可以设置为在最小边距和整个页面大小允许的最大边距之间的任何值。

在FullPageMode中，当前的边距和最小边距不会被考虑。可绘制的矩形是整个页面矩形，当前边距可以设置成任何值，而不管最小边距和页面大小。

另见

QPageSize

class Unit#

此枚举类型用于指定页面布局和边距的测量单位。

常量

描述

QPageLayout.Millimeter

QPageLayout.Point

1/72英寸

QPageLayout.Inch

QPageLayout.Pica

1/72英尺，1/6英寸，12点

QPageLayout.Didot

1/72法英寸，0.375毫米

QPageLayout.Cicero

1/6法英寸，12 Didot，4.5毫米
class Orientation#

此枚举类型定义页面方向

常量

描述

QPageLayout.Portrait

页面大小使用其默认方向

QPageLayout.Landscape

页面大小旋转90度

请注意，某些标准页面大小定义时宽度大于其高度，因此方向是相对于标准页面大小定义的，而不是相对于页面尺寸。

class Mode#

定义页面布局模式

常量

描述

QPageLayout.StandardMode

绘制矩形包括边距，边距必须介于最小和最大之间。

QPageLayout.FullPageMode

绘制矩形不包括边距，边距可以是任何值，必须手动管理。
__init__(other)#
参数：:

other - QPageLayout

复制构造函数，将other复制到当前对象。

__init__()

创建一个无效的QPageLayout对象。

__init__(pageSize, orientation, margins[, units=QPageLayout.Unit.Point[, minMargins=QMarginsF(0, 0, 0, 0)]])
参数：:

使用给定的 pageSize, orientation 和 margins 在给定的 units 中创建一个 QPageLayout。

可选地定义最小允许的边距 minMargins，例如物理打印设备能够打印的最小边距。

构造的 QPageLayout 将处于 StandardMode .

给定的 margins 将被限制在页面大小允许的最小边距和最大边距之间。

fullRect()#
返回类型：

QRectF

返回当前布局单位中的完整页面矩形。

页面矩形考虑了页面大小和页面方向，但不考虑页面边距。

fullRect(units)
参数：:

units – Unit

返回类型：

QRectF

返回所需 units 中的完整页面矩形。

页面矩形考虑了页面大小和页面方向，但不考虑页面边距。

另见

paintRect()

fullRectPixels(resolution)#
参数：:

resolution – int

返回类型：

QRect

获取给定 resolution 的整个页面矩形（以设备像素为单位）。

页面矩形考虑了页面大小和页面方向，但不考虑页面边距。

另见

paintRect()

fullRectPoints()#
返回类型：

QRect

返回整个页面矩形（以Postscript Points为单位，即每英寸的1/72）。

页面矩形考虑了页面大小和页面方向，但不考虑页面边距。

另见

paintRect()

isEquivalentTo(other)#
参数：:

other - QPageLayout

返回类型：

bool

如果此页面布局与 other 页面布局相同（即页面具有相同的大小、边距和方向），则返回 true。

isValid()#
返回类型：

bool

如果此页面布局有效，则返回 true。

margins(units)#
参数：:

units – Unit

返回类型：

QMarginsF

使用请求的 units 返回页面布局的边距。

margins()
返回类型：

QMarginsF

使用当前设置的单元返回页面布局的边距。

marginsPixels(resolution)#
参数：:

resolution – int

返回类型：

QMargins

返回给定 resolution 的页面布局的边距（以设备像素为单位）。

另见

setMargins()

marginsPoints()#
返回类型：

QMargins

返回页面布局的边距（以Postscript Points为单位，即每英寸的1/72）。

maximumMargins()#
返回类型：

QMarginsF

返回在 StandardMode 下应用的最大边距。

允许的最大边距为页面全长减去最小边距设置的计算值。例如，如果页面宽度为100点，最小右边距为10点，则最大左边距将为90点。

minimumMargins()#
返回类型：

QMarginsF

返回页面布局的最小页边距。

mode()#
返回类型：

模式

返回页面布局模式。

另见

setMode()

__ne__(rhs)#
参数：:

rhs – QPageLayout

返回类型：

bool

如果页面布局 lhs 不等于页面布局 rhs，即如果任何属性不同，则返回 true。

请注意，这是一个严格的相等性，特别是在页面大小方面，其中 QPageSize 的 ID、名称和大小必须完全匹配，并且在页边距中单位的匹配也必须。

__eq__(rhs)#
参数：:

rhs – QPageLayout

返回类型：

bool

如果页面布局 lhs 等于页面布局 rhs，即如果所有属性都完全相等，则返回 true。

请注意，这是一个严格的相等性，特别是在页面大小方面，其中 QPageSize 的 ID、名称和大小必须完全匹配，并且在页边距中单位的匹配也必须。

orientation()#
返回类型：

方向

返回页面布局的页面方向。

pageSize()#
返回类型：

QPageSize

返回页面布局的页面大小。

请注意，QPageSize 总是定义在纵向方向。要获取考虑设置的方向的大小，必须使用 fullRect()。

另见

setPageSize()

paintRect()#
返回类型：

QRectF

返回当前布局单位中的页面矩形。

可绘制的矩形考虑了页面大小、方向和边距。

如果设置为 FullPageMode 模式，则返回 fullRect()，并且必须手动管理边距。

paintRect(units)
参数：:

units – Unit

返回类型：

QRectF

以所需的 units 返回页面矩形。

可绘制的矩形考虑了页面大小、方向和边距。

如果设置为 FullPageMode 模式，则返回 fullRect()，并且必须手动管理边距。

paintRectPixels(resolution)#
参数：:

resolution – int

返回类型：

QRect

以给定的 resolution 返回绘制的矩形，单位为圆整后的设备像素。

可绘制的矩形考虑了页面大小、方向和边距。

如果设置为 FullPageMode 模式，则返回 fullRect()，并且必须手动管理边距。

paintRectPoints()#
返回类型：

QRect

以圆整后的Postscript Points（1英寸的1/72）为单位返回可绘制的矩形。

可绘制的矩形考虑了页面大小、方向和边距。

如果设置为 FullPageMode 模式，则返回 fullRect()，并且必须手动管理边距。

setBottomMargin(bottomMargin)#
参数：:

bottomMargin – float

返回类型：

bool

将页面布局的底部边距设置为 bottomMargin。如果成功设置边距，返回 true。

使用的单位是当前为布局定义的单位。要使用不同的单位，请先调用 setUnits()。

如果在默认的 StandardMode，则新的边距必须在设置的最低边距和页面大小允许的最大边距之间，否则不会设置边距。

如果在 FullPageMode，则任何边距值都将被接受。

setLeftMargin(leftMargin)#
参数：:

leftMargin – float

返回类型：

bool

将页面布局的左侧边距设置为 leftMargin。如果成功设置边距，返回 true。

使用的单位是当前为布局定义的单位。要使用不同的单位，请先调用 setUnits()。

如果在默认的 StandardMode，则新的边距必须在设置的最低边距和页面大小允许的最大边距之间，否则不会设置边距。

如果在 FullPageMode，则任何边距值都将被接受。

setMargins(margins)#
参数：:

margins – QMarginsF

返回类型：

bool

将页面布局的边距设置为 margins。如果成功设置边距，返回 true。

使用的单位是当前为布局定义的单位。要使用不同的单位，请先调用 setUnits()。

如果在默认的 StandardMode，则所有新的边距必须在设置的最低边距和页面大小允许的最大边距之间，否则不会设置边距。

如果在 FullPageMode，则任何边距值都将被接受。

setMinimumMargins(minMargins)#
参数：:

minMargins – QMarginsF

将页面布局的最小页边距设置为minMargins。

不建议覆盖为页面大小设置的默认值，因为这可能是一个物理打印设备的最低可打印区域。

如果设置了StandardMode 模式，则现有边距将被限制为新minMargins和页面大小允许的最大边距。如果设置FullPageMode 模式，则现有边距将保持不变。

setMode(mode)#
参数：:

mode – Mode

将页面布局的模式设置为mode。

另见

mode()

setOrientation(orientation)#
参数：:

orientation – Orientation

将页面布局的页面方向设置为orientation。

更改方向不会影响当前边距或最小边距。

另见

orientation()

setPageSize(pageSize[, minMargins=QMarginsF(0, 0, 0, 0)])#
参数：:

将页面布局的页面大小设置为pageSize。

可选地定义最小允许的边距minMargins，例如能够由物理打印设备打印的最小边距，否则默认最小边距为0。

如果设置了StandardMode，则现有边距将被限制为新最小边距和页面大小允许的最大边距。如果设置了FullPageMode，则现有边距将保持不变。

另见

pageSize()

setRightMargin(rightMargin)#
参数：:

rightMargin – float

返回类型：

bool

将页面布局的右侧边距设置为 rightMargin。如果边距成功设置，则返回 true。

使用的单位是当前为布局定义的单位。要使用不同的单位，请先调用 setUnits()。

如果在默认的 StandardMode，则新的边距必须在设置的最低边距和页面大小允许的最大边距之间，否则不会设置边距。

如果在 FullPageMode，则任何边距值都将被接受。

setTopMargin(topMargin)#
参数：:

topMargin – float

返回类型：

bool

将页面布局的顶部边距设置为 topMargin。如果边距成功设置，则返回 true。

使用的单位是当前为布局定义的单位。要使用不同的单位，请先调用 setUnits()。

如果在默认的 StandardMode，则新的边距必须在设置的最低边距和页面大小允许的最大边距之间，否则不会设置边距。

如果在 FullPageMode，则任何边距值都将被接受。

setUnits(units)#
参数：:

units – Unit

设置使用 units 定义页面布局的单位。

另见

units()

swap(other)#
参数：:

other - QPageLayout

与 other 交换此页面布局。此函数非常快速且从不失败。

units()#
返回类型：

单位

返回页面布局当前定义的单位。

另见

setUnits()