Skip to content

PythonQt.Qt.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 (shared captured text)
Didot attribute Any (shared captured text)
FullPageMode attribute Any (shared captured text)
Inch attribute Any (shared captured text)
Landscape attribute Any (shared captured text)
Millimeter attribute Any (shared captured text)
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 (shared captured text)
Point attribute Any (shared captured text)
Portrait attribute Any (shared captured text)
StandardMode attribute Any (shared captured text)
Unit attribute type Convert a number or string to an integer, or return 0 if no arguments are given. (shared captured text)
__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 (shared captured text)
fullRectPixels function (self, resolution: int) -> Any X.fullRectPixels(resolution) -> PythonQt.QtCore.QRect (shared captured text)
fullRectPoints function (self) -> Any X.fullRectPoints() -> PythonQt.QtCore.QRect (shared captured text)
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 (shared captured text)
isValid function (self) -> bool X.isValid() -> bool (shared captured text)
margins function (self, units: Any) -> Any X.margins(units) -> PythonQt.QtCore.QMarginsF (shared captured text)
marginsPixels function (self, resolution: int) -> Any X.marginsPixels(resolution) -> PythonQt.QtGui.QMargins (shared captured text)
marginsPoints function (self) -> Any X.marginsPoints() -> PythonQt.QtGui.QMargins (shared captured text)
maximumMargins function (self) -> Any X.maximumMargins() -> PythonQt.QtCore.QMarginsF (shared captured text)
minimumMargins function (self) -> Any X.minimumMargins() -> PythonQt.QtCore.QMarginsF (shared captured text)
mode function (self) -> Any Returns the page layout mode. (shared captured text)
operator_assign function (self, other: Any) -> Any X.operator_assign(other) -> PythonQt.QtGui.QPageLayout (shared captured text)
orientation function (self) -> Any Returns the page orientation of the page layout. (shared captured text)
pageSize function (self) -> Any X.pageSize() -> PythonQt.QtGui.QPageSize (shared captured text)
paintRect function (self, units: Any) -> Any X.paintRect(units) -> PythonQt.QtCore.QRectF (shared captured text)
paintRectPixels function (self, resolution: int) -> Any X.paintRectPixels(resolution) -> PythonQt.QtCore.QRect (shared captured text)
paintRectPoints function (self) -> Any X.paintRectPoints() -> PythonQt.QtCore.QRect (shared captured text)
setBottomMargin function (self, bottomMargin: float) -> bool X.setBottomMargin(bottomMargin) -> bool (shared captured text)
setLeftMargin function (self, leftMargin: float) -> bool X.setLeftMargin(leftMargin) -> bool (shared captured text)
setMargins function (self, margins: Any) -> bool X.setMargins(margins) -> bool (shared captured text)
setMinimumMargins function (self, minMargins: Any) -> None Sets the minimum page margins of the page layout to minMargins. (shared captured text)
setMode function (self, mode: Any) -> None Sets a page layout mode to mode. (shared captured text)
setOrientation function (self, orientation: Any) -> None Sets the page orientation of the page layout to orientation. (shared captured text)
setPageSize function (self, pageSize: Any, minMargins: Any) -> None X.setPageSize(pageSize, minMargins) (shared captured text)
setRightMargin function (self, rightMargin: float) -> bool X.setRightMargin(rightMargin) -> bool (shared captured text)
setTopMargin function (self, topMargin: float) -> bool X.setTopMargin(topMargin) -> bool (shared captured text)
setUnits function (self, units: Any) -> None Sets the units used to define the page layout. (shared captured text)
swap function (self, other: Any) -> None Swaps this page layout with other. (shared captured text)
units function (self) -> Any Returns the units the page layout is currently defined in. (shared captured text)