Skip to content

PythonQt.QtGui.QPageLayout

QPageLayout

PythonQtInstanceWrapper object

Native bases: PythonQtInstanceWrapper

Supplemental documentation: Qt 5 reference:

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.

Source: https://doc.qt.io/archives/qt-5.15/qpagelayout.html

Complete member index

Every captured member retains its own identity. Identical captured declaration text is linked once; this does not establish native inheritance or interchangeable objects.

Member Kind Signature Summary
Cicero attribute Any
Didot attribute Any
FullPageMode attribute Any
Inch attribute Any
Landscape attribute Any
Millimeter attribute Any
Mode attribute type Convert a number or string to an integer, or return 0 if no arguments are given. (shared captured text)
Orientation attribute type Convert a number or string to an integer, or return 0 if no arguments are given. (shared captured text)
Pica attribute Any
Point attribute Any
Portrait attribute Any
StandardMode attribute Any
Unit attribute type Convert a number or string to an integer, or return 0 if no arguments are given.
__init__ function (self, *args: Any, **kwargs: Any) -> None Native constructor; consult class documentation for supported overloads. (shared captured text)
className function (self, *args: Any, **kwargs: Any) -> Any Return the classname of the object (shared captured text)
delete function (self, *args: Any, **kwargs: Any) -> Any Deletes the C++ object (at your own risk, my friend!) (shared captured text)
fullRect function (self, units: Any) -> Any X.fullRect(units) -> PythonQt.QtCore.QRectF
fullRectPixels function (self, resolution: int) -> Any X.fullRectPixels(resolution) -> PythonQt.QtCore.QRect
fullRectPoints function (self) -> Any X.fullRectPoints() -> PythonQt.QtCore.QRect
help function (self, *args: Any, **kwargs: Any) -> Any Shows the help of available methods for this class (shared captured text)
inherits function (self, *args: Any, **kwargs: Any) -> Any Returns if the class inherits or is of given type name (shared captured text)
isEquivalentTo function (self, other: Any) -> bool X.isEquivalentTo(other) -> bool
isValid function (self) -> bool X.isValid() -> bool
margins function (self, units: Any) -> Any X.margins(units) -> PythonQt.QtCore.QMarginsF
marginsPixels function (self, resolution: int) -> Any X.marginsPixels(resolution) -> PythonQt.QtGui.QMargins
marginsPoints function (self) -> Any X.marginsPoints() -> PythonQt.QtGui.QMargins
maximumMargins function (self) -> Any X.maximumMargins() -> PythonQt.QtCore.QMarginsF
minimumMargins function (self) -> Any X.minimumMargins() -> PythonQt.QtCore.QMarginsF
mode function (self) -> Any Returns the page layout mode.
operator_assign function (self, other: Any) -> Any X.operator_assign(other) -> PythonQt.QtGui.QPageLayout
orientation function (self) -> Any Returns the page orientation of the page layout.
pageSize function (self) -> Any X.pageSize() -> PythonQt.QtGui.QPageSize
paintRect function (self, units: Any) -> Any X.paintRect(units) -> PythonQt.QtCore.QRectF
paintRectPixels function (self, resolution: int) -> Any X.paintRectPixels(resolution) -> PythonQt.QtCore.QRect
paintRectPoints function (self) -> Any X.paintRectPoints() -> PythonQt.QtCore.QRect
setBottomMargin function (self, bottomMargin: float) -> bool X.setBottomMargin(bottomMargin) -> bool
setLeftMargin function (self, leftMargin: float) -> bool X.setLeftMargin(leftMargin) -> bool
setMargins function (self, margins: Any) -> bool X.setMargins(margins) -> bool
setMinimumMargins function (self, minMargins: Any) -> None Sets the minimum page margins of the page layout to minMargins.
setMode function (self, mode: Any) -> None Sets a page layout mode to mode.
setOrientation function (self, orientation: Any) -> None Sets the page orientation of the page layout to orientation.
setPageSize function (self, pageSize: Any, minMargins: Any) -> None X.setPageSize(pageSize, minMargins)
setRightMargin function (self, rightMargin: float) -> bool X.setRightMargin(rightMargin) -> bool
setTopMargin function (self, topMargin: float) -> bool X.setTopMargin(topMargin) -> bool
setUnits function (self, units: Any) -> None Sets the units used to define the page layout.
swap function (self, other: Any) -> None Swaps this page layout with other.
units function (self) -> Any Returns the units the page layout is currently defined in.