API reference - Class QPrintEngine

PPK_CollateCopies

Signature: [static,const] QPrintEngine_PrintEnginePropertyKey PPK_CollateCopies

Description: Enum constant QPrintEngine::PPK_CollateCopies

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

PPK_ColorMode

Signature: [static,const] QPrintEngine_PrintEnginePropertyKey PPK_ColorMode

Description: Enum constant QPrintEngine::PPK_ColorMode

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

PPK_CopyCount

Signature: [static,const] QPrintEngine_PrintEnginePropertyKey PPK_CopyCount

Description: Enum constant QPrintEngine::PPK_CopyCount

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

PPK_Creator

Signature: [static,const] QPrintEngine_PrintEnginePropertyKey PPK_Creator

Description: Enum constant QPrintEngine::PPK_Creator

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

PPK_CustomBase

Signature: [static,const] QPrintEngine_PrintEnginePropertyKey PPK_CustomBase

Description: Enum constant QPrintEngine::PPK_CustomBase

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

PPK_CustomPaperSize

Signature: [static,const] QPrintEngine_PrintEnginePropertyKey PPK_CustomPaperSize

Description: Enum constant QPrintEngine::PPK_CustomPaperSize

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

PPK_DocumentName

Signature: [static,const] QPrintEngine_PrintEnginePropertyKey PPK_DocumentName

Description: Enum constant QPrintEngine::PPK_DocumentName

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

PPK_Duplex

Signature: [static,const] QPrintEngine_PrintEnginePropertyKey PPK_Duplex

Description: Enum constant QPrintEngine::PPK_Duplex

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

PPK_FontEmbedding

Signature: [static,const] QPrintEngine_PrintEnginePropertyKey PPK_FontEmbedding

Description: Enum constant QPrintEngine::PPK_FontEmbedding

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

PPK_FullPage

Signature: [static,const] QPrintEngine_PrintEnginePropertyKey PPK_FullPage

Description: Enum constant QPrintEngine::PPK_FullPage

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

PPK_NumberOfCopies

Signature: [static,const] QPrintEngine_PrintEnginePropertyKey PPK_NumberOfCopies

Description: Enum constant QPrintEngine::PPK_NumberOfCopies

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

PPK_Orientation

Signature: [static,const] QPrintEngine_PrintEnginePropertyKey PPK_Orientation

Description: Enum constant QPrintEngine::PPK_Orientation

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

PPK_OutputFileName

Signature: [static,const] QPrintEngine_PrintEnginePropertyKey PPK_OutputFileName

Description: Enum constant QPrintEngine::PPK_OutputFileName

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

PPK_PageMargins

Signature: [static,const] QPrintEngine_PrintEnginePropertyKey PPK_PageMargins

Description: Enum constant QPrintEngine::PPK_PageMargins

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

PPK_PageOrder

Signature: [static,const] QPrintEngine_PrintEnginePropertyKey PPK_PageOrder

Description: Enum constant QPrintEngine::PPK_PageOrder

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

PPK_PageRect

Signature: [static,const] QPrintEngine_PrintEnginePropertyKey PPK_PageRect

Description: Enum constant QPrintEngine::PPK_PageRect

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

PPK_PageSize

Signature: [static,const] QPrintEngine_PrintEnginePropertyKey PPK_PageSize

Description: Enum constant QPrintEngine::PPK_PageSize

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

PPK_PaperName

Signature: [static,const] QPrintEngine_PrintEnginePropertyKey PPK_PaperName

Description: Enum constant QPrintEngine::PPK_PaperName

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

PPK_PaperRect

Signature: [static,const] QPrintEngine_PrintEnginePropertyKey PPK_PaperRect

Description: Enum constant QPrintEngine::PPK_PaperRect

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

PPK_PaperSize

Signature: [static,const] QPrintEngine_PrintEnginePropertyKey PPK_PaperSize

Description: Enum constant QPrintEngine::PPK_PaperSize

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

PPK_PaperSource

Signature: [static,const] QPrintEngine_PrintEnginePropertyKey PPK_PaperSource

Description: Enum constant QPrintEngine::PPK_PaperSource

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

PPK_PaperSources

Signature: [static,const] QPrintEngine_PrintEnginePropertyKey PPK_PaperSources

Description: Enum constant QPrintEngine::PPK_PaperSources

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

PPK_PrinterName

Signature: [static,const] QPrintEngine_PrintEnginePropertyKey PPK_PrinterName

Description: Enum constant QPrintEngine::PPK_PrinterName

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

PPK_PrinterProgram

Signature: [static,const] QPrintEngine_PrintEnginePropertyKey PPK_PrinterProgram

Description: Enum constant QPrintEngine::PPK_PrinterProgram

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

PPK_QPageLayout

Signature: [static,const] QPrintEngine_PrintEnginePropertyKey PPK_QPageLayout

Description: Enum constant QPrintEngine::PPK_QPageLayout

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

PPK_QPageMargins

Signature: [static,const] QPrintEngine_PrintEnginePropertyKey PPK_QPageMargins

Description: Enum constant QPrintEngine::PPK_QPageMargins

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

PPK_QPageSize

Signature: [static,const] QPrintEngine_PrintEnginePropertyKey PPK_QPageSize

Description: Enum constant QPrintEngine::PPK_QPageSize

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

PPK_Resolution

Signature: [static,const] QPrintEngine_PrintEnginePropertyKey PPK_Resolution

Description: Enum constant QPrintEngine::PPK_Resolution

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

PPK_SelectionOption

Signature: [static,const] QPrintEngine_PrintEnginePropertyKey PPK_SelectionOption

Description: Enum constant QPrintEngine::PPK_SelectionOption

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

PPK_SupportedResolutions

Signature: [static,const] QPrintEngine_PrintEnginePropertyKey PPK_SupportedResolutions

Description: Enum constant QPrintEngine::PPK_SupportedResolutions

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

PPK_SupportsMultipleCopies

Signature: [static,const] QPrintEngine_PrintEnginePropertyKey PPK_SupportsMultipleCopies

Description: Enum constant QPrintEngine::PPK_SupportsMultipleCopies

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

PPK_WindowsPageSize

Signature: [static,const] QPrintEngine_PrintEnginePropertyKey PPK_WindowsPageSize

Description: Enum constant QPrintEngine::PPK_WindowsPageSize

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

_const_cast

Signature: [const] QPrintEngine 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.

abort

Signature: bool abort

Description: Virtual method bool QPrintEngine::abort()

This method can be reimplemented in a derived class.

assign

Signature: void assign (const QPrintEngine other)

Description: Assigns another object to self

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 QPrintEngine ptr dup

Description: Creates a copy of self

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

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.

metric

Signature: [const] int metric (const QPaintDevice_PaintDeviceMetric arg1)

Description: Virtual method int QPrintEngine::metric(QPaintDevice::PaintDeviceMetric)

This method can be reimplemented in a derived class.

new

Signature: [static] new QPrintEngine new

Description: Constructor QPrintEngine::QPrintEngine()

This method creates an object of class QPrintEngine.

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

newPage

Signature: bool newPage

Description: Virtual method bool QPrintEngine::newPage()

This method can be reimplemented in a derived class.

printerState

Signature: [const] QPrinter_PrinterState printerState

Description: Virtual method QPrinter::PrinterState QPrintEngine::printerState()

This method can be reimplemented in a derived class.

property

Signature: [const] variant property (const QPrintEngine_PrintEnginePropertyKey key)

Description: Virtual method QVariant QPrintEngine::property(QPrintEngine::PrintEnginePropertyKey key)

This method can be reimplemented in a derived class.

setProperty

Signature: void setProperty (const QPrintEngine_PrintEnginePropertyKey key, variant value)

Description: Virtual method void QPrintEngine::setProperty(QPrintEngine::PrintEnginePropertyKey key, const QVariant &value)

This method can be reimplemented in a derived class.