Skip to content

PythonQt.QtGui.QPageLayout · declarations 001

Back to PythonQt.QtGui.QPageLayout

Cicero instance-attribute

Cicero: Any

Didot instance-attribute

Didot: Any

FullPageMode instance-attribute

FullPageMode: Any

Inch instance-attribute

Inch: Any

Landscape instance-attribute

Landscape: Any

Millimeter instance-attribute

Millimeter: Any

Pica instance-attribute

Pica: Any

Point instance-attribute

Point: Any

Portrait instance-attribute

Portrait: Any

StandardMode instance-attribute

StandardMode: Any

Unit instance-attribute

Unit: type

int([x]) -> integer int(x, base=10) -> integer

Convert a number or string to an integer, or return 0 if no arguments are given. If x is a number, return x.int(). For floating point numbers, this truncates towards zero.

If x is not a number or if base is given, then x must be a string, bytes, or bytearray instance representing an integer literal in the given base. The literal can be preceded by '+' or '-' and be surrounded by whitespace. The base defaults to 10. Valid bases are 0 and 2-36. Base 0 means to interpret the base from the string as an integer literal.

int('0b100', base=0) 4

fullRect

fullRect(units: Any) -> Any

X.fullRect(units) -> PythonQt.QtCore.QRectF

Supplemental documentation: Qt 5 reference:

QRectF QPageLayout::fullRect() const

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.

See also paintRect() and units().

QRectF QPageLayout::fullRect(QPageLayout::Unit units) const

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.

See also paintRect().

Upstream PySide2 reference signatures (binding differences may apply):

fullRect(self) -> PySide2.QtCore.QRectF
fullRect(self, units: PySide2.QtGui.QPageLayout.Unit) -> PySide2.QtCore.QRectF

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

fullRectPixels

fullRectPixels(resolution: int) -> Any

X.fullRectPixels(resolution) -> PythonQt.QtCore.QRect

Supplemental documentation: Qt 5 reference:

QRect QPageLayout::fullRectPixels(int resolution) const

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.

See also paintRect().

Upstream PySide2 reference signatures (binding differences may apply):

fullRectPixels(self, resolution: int) -> PySide2.QtCore.QRect

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

fullRectPoints

fullRectPoints() -> Any

X.fullRectPoints() -> PythonQt.QtCore.QRect

Supplemental documentation: Qt 5 reference:

QRect QPageLayout::fullRectPoints() const

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.

See also paintRect().

Upstream PySide2 reference signatures (binding differences may apply):

fullRectPoints(self) -> PySide2.QtCore.QRect

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

isEquivalentTo

isEquivalentTo(other: Any) -> bool

X.isEquivalentTo(other) -> bool

Supplemental documentation: Qt 5 reference:

bool QPageLayout::isEquivalentTo(const QPageLayout \&other) const

Returns true if this page layout is equivalent to the other page layout, i.e. if the page has the same size, margins and orientation.

Upstream PySide2 reference signatures (binding differences may apply):

isEquivalentTo(self, other: PySide2.QtGui.QPageLayout) -> bool

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

isValid

isValid() -> bool

X.isValid() -> bool

Supplemental documentation: Qt 5 reference:

bool QPageLayout::isValid() const

Returns true if this page layout is valid.

Upstream PySide2 reference signatures (binding differences may apply):

isValid(self) -> bool

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

margins

margins(units: Any) -> Any

X.margins(units) -> PythonQt.QtCore.QMarginsF

Supplemental documentation: Qt 5 reference:

QMarginsF QPageLayout::margins() const

Returns the margins of the page layout using the currently set units.

See also setMargins() and units().

QMarginsF QPageLayout::margins(QPageLayout::Unit units) const

Returns the margins of the page layout using the requested units.

See also setMargins() and margins().

Upstream PySide2 reference signatures (binding differences may apply):

margins(self) -> PySide2.QtCore.QMarginsF
margins(self, units: PySide2.QtGui.QPageLayout.Unit) -> PySide2.QtCore.QMarginsF

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

marginsPixels

marginsPixels(resolution: int) -> Any

X.marginsPixels(resolution) -> PythonQt.QtGui.QMargins

Supplemental documentation: Qt 5 reference:

QMargins QPageLayout::marginsPixels(int resolution) const

Returns the margins of the page layout in device pixels for the given resolution.

See also setMargins().

Upstream PySide2 reference signatures (binding differences may apply):

marginsPixels(self, resolution: int) -> PySide2.QtCore.QMargins

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

marginsPoints

marginsPoints() -> Any

X.marginsPoints() -> PythonQt.QtGui.QMargins

Supplemental documentation: Qt 5 reference:

QMargins QPageLayout::marginsPoints() const

Returns the margins of the page layout in Postscript Points (1/72 of an inch).

See also setMargins() and margins().

Upstream PySide2 reference signatures (binding differences may apply):

marginsPoints(self) -> PySide2.QtCore.QMargins

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

maximumMargins

maximumMargins() -> Any

X.maximumMargins() -> PythonQt.QtCore.QMarginsF

Supplemental documentation: Qt 5 reference:

QMarginsF QPageLayout::maximumMargins() const

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.

See also setMinimumMargins() and minimumMargins().

Upstream PySide2 reference signatures (binding differences may apply):

maximumMargins(self) -> PySide2.QtCore.QMarginsF

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

minimumMargins

minimumMargins() -> Any

X.minimumMargins() -> PythonQt.QtCore.QMarginsF

Supplemental documentation: Qt 5 reference:

QMarginsF QPageLayout::minimumMargins() const

Returns the minimum margins of the page layout.

See also setMinimumMargins() and maximumMargins().

Upstream PySide2 reference signatures (binding differences may apply):

minimumMargins(self) -> PySide2.QtCore.QMarginsF

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

mode

mode() -> Any

X.mode()

Supplemental documentation: Qt 5 reference:

QPageLayout::Mode QPageLayout::mode() const

Returns the page layout mode.

See also setMode().

Upstream PySide2 reference signatures (binding differences may apply):

mode(self) -> PySide2.QtGui.QPageLayout.Mode

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

operator_assign

operator_assign(other: Any) -> Any

X.operator_assign(other) -> PythonQt.QtGui.QPageLayout

orientation

orientation() -> Any

X.orientation()

Supplemental documentation: Qt 5 reference:

QPageLayout::Orientation QPageLayout::orientation() const

Returns the page orientation of the page layout.

See also setOrientation().

Upstream PySide2 reference signatures (binding differences may apply):

orientation(self) -> PySide2.QtGui.QPageLayout.Orientation

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

pageSize

pageSize() -> Any

X.pageSize() -> PythonQt.QtGui.QPageSize

Supplemental documentation: Qt 5 reference:

QPageSize QPageLayout::pageSize() const

Returns the page size of the page layout.

Note that the QPageSize is always defined in a Portrait orientation. To obtain a size that takes the set orientation into account you must use fullRect().

See also setPageSize().

Upstream PySide2 reference signatures (binding differences may apply):

pageSize(self) -> PySide2.QtGui.QPageSize

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

paintRect

paintRect(units: Any) -> Any

X.paintRect(units) -> PythonQt.QtCore.QRectF

Supplemental documentation: Qt 5 reference:

QRectF QPageLayout::paintRect() const

Returns the page rectangle in the current layout units.

The paintable rectangle takes into account the page size, orientation and margins.

If the FullPageMode mode is set then the fullRect() is returned and the margins must be manually managed.

QRectF QPageLayout::paintRect(QPageLayout::Unit units) const

Returns the page rectangle in the required units.

The paintable rectangle takes into account the page size, orientation and margins.

If the FullPageMode mode is set then the fullRect() is returned and the margins must be manually managed.

Upstream PySide2 reference signatures (binding differences may apply):

paintRect(self) -> PySide2.QtCore.QRectF
paintRect(self, units: PySide2.QtGui.QPageLayout.Unit) -> PySide2.QtCore.QRectF

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

paintRectPixels

paintRectPixels(resolution: int) -> Any

X.paintRectPixels(resolution) -> PythonQt.QtCore.QRect

Supplemental documentation: Qt 5 reference:

QRect QPageLayout::paintRectPixels(int resolution) const

Returns the paintable rectangle in rounded device pixels for the given resolution.

The paintable rectangle takes into account the page size, orientation and margins.

If the FullPageMode mode is set then the fullRect() is returned and the margins must be manually managed.

Upstream PySide2 reference signatures (binding differences may apply):

paintRectPixels(self, resolution: int) -> PySide2.QtCore.QRect

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

paintRectPoints

paintRectPoints() -> Any

X.paintRectPoints() -> PythonQt.QtCore.QRect

Supplemental documentation: Qt 5 reference:

QRect QPageLayout::paintRectPoints() const

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.

If the FullPageMode mode is set then the fullRect() is returned and the margins must be manually managed.

Upstream PySide2 reference signatures (binding differences may apply):

paintRectPoints(self) -> PySide2.QtCore.QRect

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

setBottomMargin

setBottomMargin(bottomMargin: float) -> bool

X.setBottomMargin(bottomMargin) -> bool

Supplemental documentation: Qt 5 reference:

bool QPageLayout::setBottomMargin(qreal bottomMargin)

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.

If in the default StandardMode then the new margin must fall between the minimum margin set and the maximum margin allowed by the page size, otherwise the margin will not be set.

If in FullPageMode then any margin values will be accepted.

See also setMargins() and margins().

Upstream PySide2 reference signatures (binding differences may apply):

setBottomMargin(self, bottomMargin: float) -> bool

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

setLeftMargin

setLeftMargin(leftMargin: float) -> bool

X.setLeftMargin(leftMargin) -> bool

Supplemental documentation: Qt 5 reference:

bool QPageLayout::setLeftMargin(qreal leftMargin)

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.

If in the default StandardMode then the new margin must fall between the minimum margin set and the maximum margin allowed by the page size, otherwise the margin will not be set.

If in FullPageMode then any margin values will be accepted.

See also setMargins() and margins().

Upstream PySide2 reference signatures (binding differences may apply):

setLeftMargin(self, leftMargin: float) -> bool

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

setMargins

setMargins(margins: Any) -> bool

X.setMargins(margins) -> bool

Supplemental documentation: Qt 5 reference:

bool QPageLayout::setMargins(const QMarginsF \&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.

If in the default StandardMode then all the new margins must fall between the minimum margins set and the maximum margins allowed by the page size, otherwise the margins will not be set.

If in FullPageMode then any margin values will be accepted.

See also margins() and units().

Upstream PySide2 reference signatures (binding differences may apply):

setMargins(self, margins: PySide2.QtCore.QMarginsF) -> bool

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

setMinimumMargins

setMinimumMargins(minMargins: Any) -> None

X.setMinimumMargins(minMargins)

Supplemental documentation: Qt 5 reference:

void QPageLayout::setMinimumMargins(const QMarginsF \&minMargins)

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.

If the 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.

See also minimumMargins() and setMargins().

Upstream PySide2 reference signatures (binding differences may apply):

setMinimumMargins(self, minMargins: PySide2.QtCore.QMarginsF) -> None

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

setMode

setMode(mode: Any) -> None

X.setMode(mode)

Supplemental documentation: Qt 5 reference:

void QPageLayout::setMode(QPageLayout::Mode mode)

Sets a page layout mode to mode.

See also mode().

Upstream PySide2 reference signatures (binding differences may apply):

setMode(self, mode: PySide2.QtGui.QPageLayout.Mode) -> None

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

setOrientation

setOrientation(orientation: Any) -> None

X.setOrientation(orientation)

Supplemental documentation: Qt 5 reference:

void QPageLayout::setOrientation(QPageLayout::Orientation orientation)

Sets the page orientation of the page layout to orientation.

Changing the orientation does not affect the current margins or the minimum margins.

See also orientation().

Upstream PySide2 reference signatures (binding differences may apply):

setOrientation(self, orientation: PySide2.QtGui.QPageLayout.Orientation) -> None

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

setPageSize

setPageSize(pageSize: Any, minMargins: Any) -> None

X.setPageSize(pageSize, minMargins)

Supplemental documentation: Qt 5 reference:

void QPageLayout::setPageSize(const QPageSize \&pageSize, const QMarginsF \&minMargins \= QMarginsF(0, 0, 0, 0))

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.

If 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.

See also pageSize().

Upstream PySide2 reference signatures (binding differences may apply):

setPageSize(self, pageSize: PySide2.QtGui.QPageSize, minMargins: PySide2.QtCore.QMarginsF=...) -> None

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

setRightMargin

setRightMargin(rightMargin: float) -> bool

X.setRightMargin(rightMargin) -> bool

Supplemental documentation: Qt 5 reference:

bool QPageLayout::setRightMargin(qreal rightMargin)

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.

If in the default StandardMode then the new margin must fall between the minimum margin set and the maximum margin allowed by the page size, otherwise the margin will not be set.

If in FullPageMode then any margin values will be accepted.

See also setMargins() and margins().

Upstream PySide2 reference signatures (binding differences may apply):

setRightMargin(self, rightMargin: float) -> bool

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

setTopMargin

setTopMargin(topMargin: float) -> bool

X.setTopMargin(topMargin) -> bool

Supplemental documentation: Qt 5 reference:

bool QPageLayout::setTopMargin(qreal topMargin)

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.

If in the default StandardMode then the new margin must fall between the minimum margin set and the maximum margin allowed by the page size, otherwise the margin will not be set.

If in FullPageMode then any margin values will be accepted.

See also setMargins() and margins().

Upstream PySide2 reference signatures (binding differences may apply):

setTopMargin(self, topMargin: float) -> bool

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

setUnits

setUnits(units: Any) -> None

X.setUnits(units)

Supplemental documentation: Qt 5 reference:

void QPageLayout::setUnits(QPageLayout::Unit units)

Sets the units used to define the page layout.

See also units().

Upstream PySide2 reference signatures (binding differences may apply):

setUnits(self, units: PySide2.QtGui.QPageLayout.Unit) -> None

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

swap

swap(other: Any) -> None

X.swap(other)

Supplemental documentation: Qt 5 reference:

void QPageLayout::swap(QPageLayout \&other)

Swaps this page layout with other. This function is very fast and never fails.

Upstream PySide2 reference signatures (binding differences may apply):

swap(self, other: PySide2.QtGui.QPageLayout) -> None

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

units

units() -> Any

X.units()

Supplemental documentation: Qt 5 reference:

QPageLayout::Unit QPageLayout::units() const

Returns the units the page layout is currently defined in.

See also setUnits().

Upstream PySide2 reference signatures (binding differences may apply):

units(self) -> PySide2.QtGui.QPageLayout.Unit

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