API reference - Class QPageLayout

!=

Signature: [const] bool != (const QPageLayout rhs)

Description: Operator bool ::operator!=(const QPageLayout &lhs, const QPageLayout &rhs)

This is the mapping of the global operator to the instance method.

==

Signature: [const] bool == (const QPageLayout rhs)

Description: Operator bool ::operator==(const QPageLayout &lhs, const QPageLayout &rhs)

This is the mapping of the global operator to the instance method.

Cicero

Signature: [static,const] QPageLayout_Unit Cicero

Description: Enum constant QPageLayout::Cicero

Python specific notes:
The object exposes a readable attribute 'Cicero'. This is the getter.

Didot

Signature: [static,const] QPageLayout_Unit Didot

Description: Enum constant QPageLayout::Didot

Python specific notes:
The object exposes a readable attribute 'Didot'. This is the getter.

FullPageMode

Signature: [static,const] QPageLayout_Mode FullPageMode

Description: Enum constant QPageLayout::FullPageMode

Python specific notes:
The object exposes a readable attribute 'FullPageMode'. This is the getter.

Inch

Signature: [static,const] QPageLayout_Unit Inch

Description: Enum constant QPageLayout::Inch

Python specific notes:
The object exposes a readable attribute 'Inch'. This is the getter.

Landscape

Signature: [static,const] QPageLayout_Orientation Landscape

Description: Enum constant QPageLayout::Landscape

Python specific notes:
The object exposes a readable attribute 'Landscape'. This is the getter.

Millimeter

Signature: [static,const] QPageLayout_Unit Millimeter

Description: Enum constant QPageLayout::Millimeter

Python specific notes:
The object exposes a readable attribute 'Millimeter'. This is the getter.

Pica

Signature: [static,const] QPageLayout_Unit Pica

Description: Enum constant QPageLayout::Pica

Python specific notes:
The object exposes a readable attribute 'Pica'. This is the getter.

Point

Signature: [static,const] QPageLayout_Unit Point

Description: Enum constant QPageLayout::Point

Python specific notes:
The object exposes a readable attribute 'Point'. This is the getter.

Portrait

Signature: [static,const] QPageLayout_Orientation Portrait

Description: Enum constant QPageLayout::Portrait

Python specific notes:
The object exposes a readable attribute 'Portrait'. This is the getter.

StandardMode

Signature: [static,const] QPageLayout_Mode StandardMode

Description: Enum constant QPageLayout::StandardMode

Python specific notes:
The object exposes a readable attribute 'StandardMode'. This is the getter.

_assign

Signature: void _assign (const QPageLayout other)

Description: Assigns another object to self

_const_cast

Signature: [const] QPageLayout ptr _const_cast

Description: Returns a non-const reference to self.

Basically, this method allows turning a const object reference to a non-const one. This method is provided as last resort to remove the constness from an object. Usually there is a good reason for a const object reference, so using this method may have undesired side effects.

This method has been introduced in version 0.29.6.

_create

Signature: void _create

Description: Ensures the C++ object is created

Use this method to ensure the C++ object is created, for example to ensure that resources are allocated. Usually C++ objects are created on demand and not necessarily when the script object is created.

_destroy

Signature: void _destroy

Description: Explicitly destroys the object

Explicitly destroys the object on C++ side if it was owned by the script interpreter. Subsequent access to this object will throw an exception. If the object is not owned by the script, this method will do nothing.

_destroyed?

Signature: [const] bool _destroyed?

Description: Returns a value indicating whether the object was already destroyed

This method returns true, if the object was destroyed, either explicitly or by the C++ side. The latter may happen, if the object is owned by a C++ object which got destroyed itself.

_is_const_object?

Signature: [const] bool _is_const_object?

Description: Returns a value indicating whether the reference is a const reference

This method returns true, if self is a const reference. In that case, only const methods may be called on self.

_manage

Signature: void _manage

Description: Marks the object as managed by the script side.

After calling this method on an object, the script side will be responsible for the management of the object. This method may be called if an object is returned from a C++ function and the object is known not to be owned by any C++ instance. If necessary, the script side may delete the object if the script's reference is no longer required.

Usually it's not required to call this method. It has been introduced in version 0.24.

_unmanage

Signature: void _unmanage

Description: Marks the object as no longer owned by the script side.

Calling this method will make this object no longer owned by the script's memory management. Instead, the object must be managed in some other way. Usually this method may be called if it is known that some C++ object holds and manages this object. Technically speaking, this method will turn the script's reference into a weak reference. After the script engine decides to delete the reference, the object itself will still exist. If the object is not managed otherwise, memory leaks will occur.

Usually it's not required to call this method. It has been introduced in version 0.24.

assign

Signature: QPageLayout assign (const QPageLayout other)

Description: Method QPageLayout &QPageLayout::operator=(const QPageLayout &other)

create

Signature: void create

Description: Ensures the C++ object is created

Use of this method is deprecated. Use _create instead

Use this method to ensure the C++ object is created, for example to ensure that resources are allocated. Usually C++ objects are created on demand and not necessarily when the script object is created.

destroy

Signature: void destroy

Description: Explicitly destroys the object

Use of this method is deprecated. Use _destroy instead

Explicitly destroys the object on C++ side if it was owned by the script interpreter. Subsequent access to this object will throw an exception. If the object is not owned by the script, this method will do nothing.

destroyed?

Signature: [const] bool destroyed?

Description: Returns a value indicating whether the object was already destroyed

Use of this method is deprecated. Use _destroyed? instead

This method returns true, if the object was destroyed, either explicitly or by the C++ side. The latter may happen, if the object is owned by a C++ object which got destroyed itself.

dup

Signature: [const] new QPageLayout ptr dup

Description: Creates a copy of self

Python specific notes:
This method also implements '__copy__' and '__deepcopy__'.

fullRect

(1) Signature: [const] QRectF fullRect

Description: Method QRectF QPageLayout::fullRect()

(2) Signature: [const] QRectF fullRect (const QPageLayout_Unit units)

Description: Method QRectF QPageLayout::fullRect(QPageLayout::Unit units)

fullRectPixels

Signature: [const] QRect fullRectPixels (int resolution)

Description: Method QRect QPageLayout::fullRectPixels(int resolution)

fullRectPoints

Signature: [const] QRect fullRectPoints

Description: Method QRect QPageLayout::fullRectPoints()

isEquivalentTo?

Signature: [const] bool isEquivalentTo? (const QPageLayout other)

Description: Method bool QPageLayout::isEquivalentTo(const QPageLayout &other)

isValid?

Signature: [const] bool isValid?

Description: Method bool QPageLayout::isValid()

is_const_object?

Signature: [const] bool is_const_object?

Description: Returns a value indicating whether the reference is a const reference

Use of this method is deprecated. Use _is_const_object? instead

This method returns true, if self is a const reference. In that case, only const methods may be called on self.

margins

(1) Signature: [const] QMarginsF margins

Description: Method QMarginsF QPageLayout::margins()

(2) Signature: [const] QMarginsF margins (const QPageLayout_Unit units)

Description: Method QMarginsF QPageLayout::margins(QPageLayout::Unit units)

marginsPixels

Signature: [const] QMargins marginsPixels (int resolution)

Description: Method QMargins QPageLayout::marginsPixels(int resolution)

marginsPoints

Signature: [const] QMargins marginsPoints

Description: Method QMargins QPageLayout::marginsPoints()

maximumMargins

Signature: [const] QMarginsF maximumMargins

Description: Method QMarginsF QPageLayout::maximumMargins()

minimumMargins

Signature: [const] QMarginsF minimumMargins

Description: Method QMarginsF QPageLayout::minimumMargins()

Python specific notes:
The object exposes a readable attribute 'minimumMargins'. This is the getter.

minimumMargins=

Signature: void minimumMargins= (const QMarginsF minMargins)

Description: Method void QPageLayout::setMinimumMargins(const QMarginsF &minMargins)

Python specific notes:
The object exposes a writable attribute 'minimumMargins'. This is the setter.

mode

Signature: [const] QPageLayout_Mode mode

Description: Method QPageLayout::Mode QPageLayout::mode()

Python specific notes:
The object exposes a readable attribute 'mode'. This is the getter.

mode=

Signature: void mode= (const QPageLayout_Mode mode)

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

Python specific notes:
The object exposes a writable attribute 'mode'. This is the setter.

new

(1) Signature: [static] new QPageLayout new

Description: Constructor QPageLayout::QPageLayout()

This method creates an object of class QPageLayout.

Python specific notes:
This method is the default initializer of the object.

(2) Signature: [static] new QPageLayout new (const QPageSize pageSize, const QPageLayout_Orientation orientation, const QMarginsF margins, const QPageLayout_Unit units = QPageLayout::Point, const QMarginsF minMargins = QMarginsF(0, 0, 0, 0))

Description: Constructor QPageLayout::QPageLayout(const QPageSize &pageSize, QPageLayout::Orientation orientation, const QMarginsF &margins, QPageLayout::Unit units, const QMarginsF &minMargins)

This method creates an object of class QPageLayout.

Python specific notes:
This method is the default initializer of the object.

(3) Signature: [static] new QPageLayout new (const QPageLayout other)

Description: Constructor QPageLayout::QPageLayout(const QPageLayout &other)

This method creates an object of class QPageLayout.

Python specific notes:
This method is the default initializer of the object.

orientation

Signature: [const] QPageLayout_Orientation orientation

Description: Method QPageLayout::Orientation QPageLayout::orientation()

Python specific notes:
The object exposes a readable attribute 'orientation'. This is the getter.

orientation=

Signature: void orientation= (const QPageLayout_Orientation orientation)

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

Python specific notes:
The object exposes a writable attribute 'orientation'. This is the setter.

pageSize

Signature: [const] QPageSize pageSize

Description: Method QPageSize QPageLayout::pageSize()

Python specific notes:
The object exposes a readable attribute 'pageSize'. This is the getter.

paintRect

(1) Signature: [const] QRectF paintRect

Description: Method QRectF QPageLayout::paintRect()

(2) Signature: [const] QRectF paintRect (const QPageLayout_Unit units)

Description: Method QRectF QPageLayout::paintRect(QPageLayout::Unit units)

paintRectPixels

Signature: [const] QRect paintRectPixels (int resolution)

Description: Method QRect QPageLayout::paintRectPixels(int resolution)

paintRectPoints

Signature: [const] QRect paintRectPoints

Description: Method QRect QPageLayout::paintRectPoints()

setBottomMargin

Signature: bool setBottomMargin (double bottomMargin)

Description: Method bool QPageLayout::setBottomMargin(double bottomMargin)

setLeftMargin

Signature: bool setLeftMargin (double leftMargin)

Description: Method bool QPageLayout::setLeftMargin(double leftMargin)

setMargins

Signature: bool setMargins (const QMarginsF margins)

Description: Method bool QPageLayout::setMargins(const QMarginsF &margins)

setMinimumMargins

Signature: void setMinimumMargins (const QMarginsF minMargins)

Description: Method void QPageLayout::setMinimumMargins(const QMarginsF &minMargins)

Python specific notes:
The object exposes a writable attribute 'minimumMargins'. This is the setter.

setMode

Signature: void setMode (const QPageLayout_Mode mode)

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

Python specific notes:
The object exposes a writable attribute 'mode'. This is the setter.

setOrientation

Signature: void setOrientation (const QPageLayout_Orientation orientation)

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

Python specific notes:
The object exposes a writable attribute 'orientation'. This is the setter.

setPageSize

Signature: void setPageSize (const QPageSize pageSize, const QMarginsF minMargins = QMarginsF(0, 0, 0, 0))

Description: Method void QPageLayout::setPageSize(const QPageSize &pageSize, const QMarginsF &minMargins)

setRightMargin

Signature: bool setRightMargin (double rightMargin)

Description: Method bool QPageLayout::setRightMargin(double rightMargin)

setTopMargin

Signature: bool setTopMargin (double topMargin)

Description: Method bool QPageLayout::setTopMargin(double topMargin)

setUnits

Signature: void setUnits (const QPageLayout_Unit units)

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

Python specific notes:
The object exposes a writable attribute 'units'. This is the setter.

swap

Signature: void swap (QPageLayout other)

Description: Method void QPageLayout::swap(QPageLayout &other)

units

Signature: [const] QPageLayout_Unit units

Description: Method QPageLayout::Unit QPageLayout::units()

Python specific notes:
The object exposes a readable attribute 'units'. This is the getter.

units=

Signature: void units= (const QPageLayout_Unit units)

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

Python specific notes:
The object exposes a writable attribute 'units'. This is the setter.