PySide6.QtGui.QPageLayout¶

class QPageLayout¶

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

概要¶

方法¶

• def __init__()

• def fullRect()

• def fullRectPixels()

• def fullRectPoints()

• def isEquivalentTo()

• def isValid()

• def margins()

• def marginsPixels()

• def marginsPoints()

• def maximumMargins()

• def minimumMargins()

• def mode()

• def __ne__()

• def __eq__()

• def orientation()

• def pageSize()

• def paintRect()

• def paintRectPixels()

• def paintRectPoints()

• def setBottomMargin()

• def setLeftMargin()

• def setMargins()

• def setMinimumMargins()

• def setMode()

• def setOrientation()

• def setPageSize()

• def setRightMargin()

• def setTopMargin()

• def setUnits()

• def swap()

• def units()

注意

本文档可能包含从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迪多，4.5毫米

class Orientation¶

此枚举类型定义了页面方向

常量	描述
QPageLayout.Portrait	页面大小以其默认方向使用
QPageLayout.Landscape	页面大小旋转了90度

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

class Mode¶

定义页面布局模式

常量	描述
QPageLayout.StandardMode	绘制矩形包括边距，边距必须在最小值和最大值之间。
QPageLayout.FullPageMode	绘制矩形不包括边距，边距可以是任何值并且必须手动管理。

在StandardMode中，设置边距时，使用Clamp自动将边距限制在允许的最小值和最大值之间。

另请参阅

OutOfBoundsPolicy

class OutOfBoundsPolicy¶

定义超出边界的边距策略

常量	描述
QPageLayout.OutOfBoundsPolicy.Reject	边距必须落在最小值和最大值之间，否则将被拒绝。
QPageLayout.OutOfBoundsPolicy.Clamp	边距被限制在最小值和最大值之间，以确保它们是有效的。

注意

该策略在FullPageMode中无效，所有边距都被接受。

在版本6.8中添加。

__init__()¶

创建一个无效的 QPageLayout 。

__init__(other)

Parameters:

其他 – QPageLayout

复制构造函数，将other复制到此。

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

Parameters:

• pageSize – QPageSize

• orientation – Orientation

• margins – QMarginsF

• units – Unit

• minMargins – QMarginsF

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

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

构建的QPageLayout将处于StandardMode。

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

fullRect()¶

Return type:

QRectF

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

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

另请参阅

paintRect() units()

fullRect(units)

Parameters:

单位 – Unit

Return type:

QRectF

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

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

另请参阅

paintRect()

fullRectPixels(resolution)¶

Parameters:

分辨率 – int

Return type:

QRect

返回给定resolution的设备像素中的完整页面矩形。

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

另请参阅

paintRect()

fullRectPoints()¶

Return type:

QRect

返回以Postscript点（1/72英寸）为单位的完整页面矩形。

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

另请参阅

paintRect()

isEquivalentTo(other)¶

Parameters:

其他 – QPageLayout

Return type:

布尔

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

isValid()¶

Return type:

布尔

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

margins()¶

Return type:

QMarginsF

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

另请参阅

setMargins() units()

margins(units)

Parameters:

单位 – Unit

Return type:

QMarginsF

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

另请参阅

setMargins() margins()

marginsPixels(resolution)¶

Parameters:

分辨率 – int

Return type:

QMargins

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

另请参阅

setMargins()

marginsPoints()¶

Return type:

QMargins

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

另请参阅

setMargins() margins()

maximumMargins()¶

Return type:

QMarginsF

返回如果页面布局处于StandardMode时将应用的最大边距。

允许的最大边距计算为页面的完整大小减去设置的最小边距。例如，如果页面宽度为100点，最小右边距为10点，那么最大左边距将为90点。

另请参阅

setMinimumMargins() minimumMargins()

minimumMargins()¶

Return type:

QMarginsF

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

另请参阅

setMinimumMargins() maximumMargins()

mode()¶

Return type:

模式

返回页面布局模式。

另请参阅

setMode()

__ne__(rhs)¶

Parameters:

rhs – QPageLayout

Return type:

布尔

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

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

另请参阅

isEquivalentTo()

__eq__(rhs)¶

Parameters:

rhs – QPageLayout

Return type:

布尔

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

请注意，这是一个严格的等式，特别是对于页面大小，其中QPageSize的ID、名称和大小必须完全匹配，以及边距的单位必须匹配。

另请参阅

isEquivalentTo()

orientation()¶

Return type:

方向

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

另请参阅

setOrientation()

pageSize()¶

Return type:

QPageSize

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

请注意，QPageSize 始终以纵向方向定义。要获得考虑到设置方向的大小，您必须使用 fullRect()。

另请参阅

setPageSize()

paintRect()¶

Return type:

QRectF

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

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

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

paintRect(units)

Parameters:

单位 – Unit

Return type:

QRectF

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

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

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

paintRectPixels(resolution)¶

Parameters:

分辨率 – int

Return type:

QRect

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

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

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

paintRectPoints()¶

Return type:

QRect

返回可绘制的矩形，单位为圆角Postscript点（1/72英寸）。

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

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

setBottomMargin(bottomMargin[, outOfBoundsPolicy=QPageLayout.OutOfBoundsPolicy.Reject])¶

Parameters:

• bottomMargin – float

• outOfBoundsPolicy – OutOfBoundsPolicy

Return type:

布尔

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

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

自 Qt 6.8 起，可选的 outOfBoundsPolicy 可用于指定如何处理超出边界的边距。

另请参阅

setMargins() margins()

setLeftMargin(leftMargin[, outOfBoundsPolicy=QPageLayout.OutOfBoundsPolicy.Reject])¶

Parameters:

• leftMargin – 浮点数

• outOfBoundsPolicy – OutOfBoundsPolicy

Return type:

布尔

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

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

自 Qt 6.8 起，可选的 outOfBoundsPolicy 可用于指定如何处理超出边界的边距。

另请参阅

setMargins() margins()

setMargins(margins[, outOfBoundsPolicy=QPageLayout.OutOfBoundsPolicy.Reject])¶

Parameters:

• margins – QMarginsF

• outOfBoundsPolicy – OutOfBoundsPolicy

Return type:

布尔

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

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

自 Qt 6.8 起，可选的 outOfBoundsPolicy 可用于指定如何处理超出边界的边距。

另请参阅

margins() units()

setMinimumMargins(minMargins)¶

Parameters:

minMargins – QMarginsF

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

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

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

另请参阅

minimumMargins() setMargins()

setMode(mode)¶

Parameters:

mode – Mode

设置页面布局模式为 mode。

另请参阅

mode()

setOrientation(orientation)¶

Parameters:

方向 – Orientation

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

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

另请参阅

orientation()

setPageSize(pageSize[, minMargins=QMarginsF(0, 0, 0, 0)])¶

Parameters:

• pageSize – QPageSize

• minMargins – QMarginsF

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

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

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

另请参阅

pageSize()

setRightMargin(rightMargin[, outOfBoundsPolicy=QPageLayout.OutOfBoundsPolicy.Reject])¶

Parameters:

• rightMargin – 浮点数

• outOfBoundsPolicy – OutOfBoundsPolicy

Return type:

布尔

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

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

自 Qt 6.8 起，可选的 outOfBoundsPolicy 可用于指定如何处理超出边界的边距。

另请参阅

setMargins() margins()

setTopMargin(topMargin[, outOfBoundsPolicy=QPageLayout.OutOfBoundsPolicy.Reject])¶

Parameters:

• topMargin – 浮点数

• outOfBoundsPolicy – OutOfBoundsPolicy

Return type:

布尔

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

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

自 Qt 6.8 起，可选的 outOfBoundsPolicy 可用于指定如何处理超出边界的边距。

另请参阅

setMargins() margins()

setUnits(units)¶

Parameters:

单位 – Unit

设置用于定义页面布局的units。

另请参阅

units()

swap(other)¶

Parameters:

其他 – QPageLayout

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

units()¶

Return type:

Unit

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

另请参阅

setUnits()