API reference - Class QPrintEngine

Notation used in Ruby API documentation

Description: Binding of QPrintEngine

Class hierarchy: QPrintEngine

Sub-classes: PrintEnginePropertyKey

Public constructors

new QPrintEnginenewConstructor QPrintEngine::QPrintEngine()

Public methods

void_createEnsures the C++ object is created
void_destroyExplicitly destroys the object
[const]bool_destroyed?Returns a value indicating whether the object was already destroyed
[const]bool_is_const_object?Returns a value indicating whether the reference is a const reference
void_manageMarks the object as managed by the script side.
void_unmanageMarks the object as no longer owned by the script side.
[virtual]boolabortVirtual method bool QPrintEngine::abort()
voidassign(const QPrintEngine other)Assigns another object to self
[const]new QPrintEngine ptrdupCreates a copy of self
[virtual,const]intmetric(const QPaintDevice_PaintDeviceMetric arg1)Virtual method int QPrintEngine::metric(QPaintDevice::PaintDeviceMetric)
[virtual]boolnewPageVirtual method bool QPrintEngine::newPage()
[virtual,const]QPrinter_PrinterStateprinterStateVirtual method QPrinter::PrinterState QPrintEngine::printerState()
[virtual,const]QVariantproperty(const QPrintEngine_PrintEnginePropertyKey key)Virtual method QVariant QPrintEngine::property(QPrintEngine::PrintEnginePropertyKey key)
[virtual]voidsetProperty(const QPrintEngine_PrintEnginePropertyKey key,
const QVariant value)
Virtual method void QPrintEngine::setProperty(QPrintEngine::PrintEnginePropertyKey key, const QVariant &value)

Public static methods and constants

[static,const]new QPrintEngine_PrintEnginePropertyKey ptrPPK_CollateCopiesEnum constant QPrintEngine::PPK_CollateCopies
[static,const]new QPrintEngine_PrintEnginePropertyKey ptrPPK_ColorModeEnum constant QPrintEngine::PPK_ColorMode
[static,const]new QPrintEngine_PrintEnginePropertyKey ptrPPK_CreatorEnum constant QPrintEngine::PPK_Creator
[static,const]new QPrintEngine_PrintEnginePropertyKey ptrPPK_CustomBaseEnum constant QPrintEngine::PPK_CustomBase
[static,const]new QPrintEngine_PrintEnginePropertyKey ptrPPK_CustomPaperSizeEnum constant QPrintEngine::PPK_CustomPaperSize
[static,const]new QPrintEngine_PrintEnginePropertyKey ptrPPK_DocumentNameEnum constant QPrintEngine::PPK_DocumentName
[static,const]new QPrintEngine_PrintEnginePropertyKey ptrPPK_DuplexEnum constant QPrintEngine::PPK_Duplex
[static,const]new QPrintEngine_PrintEnginePropertyKey ptrPPK_FontEmbeddingEnum constant QPrintEngine::PPK_FontEmbedding
[static,const]new QPrintEngine_PrintEnginePropertyKey ptrPPK_FullPageEnum constant QPrintEngine::PPK_FullPage
[static,const]new QPrintEngine_PrintEnginePropertyKey ptrPPK_NumberOfCopiesEnum constant QPrintEngine::PPK_NumberOfCopies
[static,const]new QPrintEngine_PrintEnginePropertyKey ptrPPK_OrientationEnum constant QPrintEngine::PPK_Orientation
[static,const]new QPrintEngine_PrintEnginePropertyKey ptrPPK_OutputFileNameEnum constant QPrintEngine::PPK_OutputFileName
[static,const]new QPrintEngine_PrintEnginePropertyKey ptrPPK_PageMarginsEnum constant QPrintEngine::PPK_PageMargins
[static,const]new QPrintEngine_PrintEnginePropertyKey ptrPPK_PageOrderEnum constant QPrintEngine::PPK_PageOrder
[static,const]new QPrintEngine_PrintEnginePropertyKey ptrPPK_PageRectEnum constant QPrintEngine::PPK_PageRect
[static,const]new QPrintEngine_PrintEnginePropertyKey ptrPPK_PageSizeEnum constant QPrintEngine::PPK_PageSize
[static,const]new QPrintEngine_PrintEnginePropertyKey ptrPPK_PaperRectEnum constant QPrintEngine::PPK_PaperRect
[static,const]new QPrintEngine_PrintEnginePropertyKey ptrPPK_PaperSizeEnum constant QPrintEngine::PPK_PaperSize
[static,const]new QPrintEngine_PrintEnginePropertyKey ptrPPK_PaperSourceEnum constant QPrintEngine::PPK_PaperSource
[static,const]new QPrintEngine_PrintEnginePropertyKey ptrPPK_PaperSourcesEnum constant QPrintEngine::PPK_PaperSources
[static,const]new QPrintEngine_PrintEnginePropertyKey ptrPPK_PrinterNameEnum constant QPrintEngine::PPK_PrinterName
[static,const]new QPrintEngine_PrintEnginePropertyKey ptrPPK_PrinterProgramEnum constant QPrintEngine::PPK_PrinterProgram
[static,const]new QPrintEngine_PrintEnginePropertyKey ptrPPK_ResolutionEnum constant QPrintEngine::PPK_Resolution
[static,const]new QPrintEngine_PrintEnginePropertyKey ptrPPK_SelectionOptionEnum constant QPrintEngine::PPK_SelectionOption
[static,const]new QPrintEngine_PrintEnginePropertyKey ptrPPK_SupportedResolutionsEnum constant QPrintEngine::PPK_SupportedResolutions
[static,const]new QPrintEngine_PrintEnginePropertyKey ptrPPK_SuppressSystemPrintStatusEnum constant QPrintEngine::PPK_SuppressSystemPrintStatus
[static,const]new QPrintEngine_PrintEnginePropertyKey ptrPPK_WindowsPageSizeEnum constant QPrintEngine::PPK_WindowsPageSize

Deprecated methods (protected, public, static, non-static and constructors)

voidcreateUse of this method is deprecated. Use _create instead
voiddestroyUse of this method is deprecated. Use _destroy instead
[const]booldestroyed?Use of this method is deprecated. Use _destroyed? instead
[const]boolis_const_object?Use of this method is deprecated. Use _is_const_object? instead

Detailed description

[static,const] new QPrintEngine_PrintEnginePropertyKey ptr PPK_CollateCopies

Description: Enum constant QPrintEngine::PPK_CollateCopies

[static,const] new QPrintEngine_PrintEnginePropertyKey ptr PPK_ColorMode

Description: Enum constant QPrintEngine::PPK_ColorMode

[static,const] new QPrintEngine_PrintEnginePropertyKey ptr PPK_Creator

Description: Enum constant QPrintEngine::PPK_Creator

[static,const] new QPrintEngine_PrintEnginePropertyKey ptr PPK_CustomBase

Description: Enum constant QPrintEngine::PPK_CustomBase

[static,const] new QPrintEngine_PrintEnginePropertyKey ptr PPK_CustomPaperSize

Description: Enum constant QPrintEngine::PPK_CustomPaperSize

[static,const] new QPrintEngine_PrintEnginePropertyKey ptr PPK_DocumentName

Description: Enum constant QPrintEngine::PPK_DocumentName

[static,const] new QPrintEngine_PrintEnginePropertyKey ptr PPK_Duplex

Description: Enum constant QPrintEngine::PPK_Duplex

[static,const] new QPrintEngine_PrintEnginePropertyKey ptr PPK_FontEmbedding

Description: Enum constant QPrintEngine::PPK_FontEmbedding

[static,const] new QPrintEngine_PrintEnginePropertyKey ptr PPK_FullPage

Description: Enum constant QPrintEngine::PPK_FullPage

[static,const] new QPrintEngine_PrintEnginePropertyKey ptr PPK_NumberOfCopies

Description: Enum constant QPrintEngine::PPK_NumberOfCopies

[static,const] new QPrintEngine_PrintEnginePropertyKey ptr PPK_Orientation

Description: Enum constant QPrintEngine::PPK_Orientation

[static,const] new QPrintEngine_PrintEnginePropertyKey ptr PPK_OutputFileName

Description: Enum constant QPrintEngine::PPK_OutputFileName

[static,const] new QPrintEngine_PrintEnginePropertyKey ptr PPK_PageMargins

Description: Enum constant QPrintEngine::PPK_PageMargins

[static,const] new QPrintEngine_PrintEnginePropertyKey ptr PPK_PageOrder

Description: Enum constant QPrintEngine::PPK_PageOrder

[static,const] new QPrintEngine_PrintEnginePropertyKey ptr PPK_PageRect

Description: Enum constant QPrintEngine::PPK_PageRect

[static,const] new QPrintEngine_PrintEnginePropertyKey ptr PPK_PageSize

Description: Enum constant QPrintEngine::PPK_PageSize

[static,const] new QPrintEngine_PrintEnginePropertyKey ptr PPK_PaperRect

Description: Enum constant QPrintEngine::PPK_PaperRect

[static,const] new QPrintEngine_PrintEnginePropertyKey ptr PPK_PaperSize

Description: Enum constant QPrintEngine::PPK_PaperSize

[static,const] new QPrintEngine_PrintEnginePropertyKey ptr PPK_PaperSource

Description: Enum constant QPrintEngine::PPK_PaperSource

[static,const] new QPrintEngine_PrintEnginePropertyKey ptr PPK_PaperSources

Description: Enum constant QPrintEngine::PPK_PaperSources

[static,const] new QPrintEngine_PrintEnginePropertyKey ptr PPK_PrinterName

Description: Enum constant QPrintEngine::PPK_PrinterName

[static,const] new QPrintEngine_PrintEnginePropertyKey ptr PPK_PrinterProgram

Description: Enum constant QPrintEngine::PPK_PrinterProgram

[static,const] new QPrintEngine_PrintEnginePropertyKey ptr PPK_Resolution

Description: Enum constant QPrintEngine::PPK_Resolution

[static,const] new QPrintEngine_PrintEnginePropertyKey ptr PPK_SelectionOption

Description: Enum constant QPrintEngine::PPK_SelectionOption

[static,const] new QPrintEngine_PrintEnginePropertyKey ptr PPK_SupportedResolutions

Description: Enum constant QPrintEngine::PPK_SupportedResolutions

[static,const] new QPrintEngine_PrintEnginePropertyKey ptr PPK_SuppressSystemPrintStatus

Description: Enum constant QPrintEngine::PPK_SuppressSystemPrintStatus

[static,const] new QPrintEngine_PrintEnginePropertyKey ptr PPK_WindowsPageSize

Description: Enum constant QPrintEngine::PPK_WindowsPageSize

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.

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.

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

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

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.

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.

[virtual] bool abort

Description: Virtual method bool QPrintEngine::abort()

This method can be reimplemented in a derived class.

void assign(const QPrintEngine other)

Description: Assigns another object to self

void create

Description: Ensures the C++ object is created

Use of this method is deprecated. Use _create instead

void destroy

Description: Explicitly destroys the object

Use of this method is deprecated. Use _destroy instead

[const] bool destroyed?

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

Use of this method is deprecated. Use _destroyed? instead

[const] new QPrintEngine ptr dup

Description: Creates a copy of self

[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

[virtual,const] int metric(const QPaintDevice_PaintDeviceMetric arg1)

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

This method can be reimplemented in a derived class.

[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

[virtual] bool newPage

Description: Virtual method bool QPrintEngine::newPage()

This method can be reimplemented in a derived class.

[virtual,const] QPrinter_PrinterState printerState

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

This method can be reimplemented in a derived class.

[virtual,const] QVariant property(const QPrintEngine_PrintEnginePropertyKey key)

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

This method can be reimplemented in a derived class.

[virtual] void setProperty(const QPrintEngine_PrintEnginePropertyKey key,const QVariant value)

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

This method can be reimplemented in a derived class.