KLayout 0.29.8 (2024-10-28 63dd591e5) [master]

API reference - Class QPrinterInfo

Notation used in Ruby API documentation

Module: QtPrintSupport

Description: Binding of QPrinterInfo

Public constructors

new QPrinterInfonewConstructor QPrinterInfo::QPrinterInfo()
new QPrinterInfonew(const QPrinterInfo other)Constructor QPrinterInfo::QPrinterInfo(const QPrinterInfo &other)
new QPrinterInfonew(const QPrinter printer)Constructor QPrinterInfo::QPrinterInfo(const QPrinter &printer)

Public methods

void_assign(const QPrinterInfo other)Assigns another object to self
[const]QPrinterInfo ptr_const_castReturns a non-const reference to self.
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.
QPrinterInfoassign(const QPrinterInfo other)Method QPrinterInfo &QPrinterInfo::operator=(const QPrinterInfo &other)
[const]QPrinter_DuplexModedefaultDuplexModeMethod QPrinter::DuplexMode QPrinterInfo::defaultDuplexMode()
[const]QPageSizedefaultPageSizeMethod QPageSize QPrinterInfo::defaultPageSize()
[const]stringdescriptionMethod QString QPrinterInfo::description()
[const]new QPrinterInfo ptrdupCreates a copy of self
[const]boolisDefault?Method bool QPrinterInfo::isDefault()
[const]boolisNull?Method bool QPrinterInfo::isNull()
[const]boolisRemote?Method bool QPrinterInfo::isRemote()
[const]stringlocationMethod QString QPrinterInfo::location()
[const]stringmakeAndModelMethod QString QPrinterInfo::makeAndModel()
[const]QPageSizemaximumPhysicalPageSizeMethod QPageSize QPrinterInfo::maximumPhysicalPageSize()
[const]QPageSizeminimumPhysicalPageSizeMethod QPageSize QPrinterInfo::minimumPhysicalPageSize()
[const]stringprinterNameMethod QString QPrinterInfo::printerName()
[const]QPrinter_PrinterStatestateMethod QPrinter::PrinterState QPrinterInfo::state()
[const]QPrinter_DuplexMode[]supportedDuplexModesMethod QList<QPrinter::DuplexMode> QPrinterInfo::supportedDuplexModes()
[const]QPageSize[]supportedPageSizesMethod QList<QPageSize> QPrinterInfo::supportedPageSizes()
[const]QPagedPaintDevice_PageSize[]supportedPaperSizesMethod QList<QPrinter::PaperSize> QPrinterInfo::supportedPaperSizes()
[const]int[]supportedResolutionsMethod QList<int> QPrinterInfo::supportedResolutions()
[const]QPair_QString_QSizeF[]supportedSizesWithNamesMethod QList<QPair<QString, QSizeF> > QPrinterInfo::supportedSizesWithNames()
[const]boolsupportsCustomPageSizesMethod bool QPrinterInfo::supportsCustomPageSizes()

Public static methods and constants

string[]availablePrinterNamesStatic method QStringList QPrinterInfo::availablePrinterNames()
QPrinterInfo[]availablePrintersStatic method QList<QPrinterInfo> QPrinterInfo::availablePrinters()
QPrinterInfodefaultPrinterStatic method QPrinterInfo QPrinterInfo::defaultPrinter()
stringdefaultPrinterNameStatic method QString QPrinterInfo::defaultPrinterName()
QPrinterInfoprinterInfo(string printerName)Static method QPrinterInfo QPrinterInfo::printerInfo(const QString &printerName)

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

_assign

Signature: void _assign (const QPrinterInfo other)

Description: Assigns another object to self

_const_cast

Signature: [const] QPrinterInfo 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: QPrinterInfo assign (const QPrinterInfo other)

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

availablePrinterNames

Signature: [static] string[] availablePrinterNames

Description: Static method QStringList QPrinterInfo::availablePrinterNames()

This method is static and can be called without an instance.

availablePrinters

Signature: [static] QPrinterInfo[] availablePrinters

Description: Static method QList<QPrinterInfo> QPrinterInfo::availablePrinters()

This method is static and can be called without an instance.

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.

defaultDuplexMode

Signature: [const] QPrinter_DuplexMode defaultDuplexMode

Description: Method QPrinter::DuplexMode QPrinterInfo::defaultDuplexMode()

defaultPageSize

Signature: [const] QPageSize defaultPageSize

Description: Method QPageSize QPrinterInfo::defaultPageSize()

defaultPrinter

Signature: [static] QPrinterInfo defaultPrinter

Description: Static method QPrinterInfo QPrinterInfo::defaultPrinter()

This method is static and can be called without an instance.

defaultPrinterName

Signature: [static] string defaultPrinterName

Description: Static method QString QPrinterInfo::defaultPrinterName()

This method is static and can be called without an instance.

description

Signature: [const] string description

Description: Method QString QPrinterInfo::description()

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

Description: Creates a copy of self

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

isDefault?

Signature: [const] bool isDefault?

Description: Method bool QPrinterInfo::isDefault()

isNull?

Signature: [const] bool isNull?

Description: Method bool QPrinterInfo::isNull()

isRemote?

Signature: [const] bool isRemote?

Description: Method bool QPrinterInfo::isRemote()

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.

location

Signature: [const] string location

Description: Method QString QPrinterInfo::location()

makeAndModel

Signature: [const] string makeAndModel

Description: Method QString QPrinterInfo::makeAndModel()

maximumPhysicalPageSize

Signature: [const] QPageSize maximumPhysicalPageSize

Description: Method QPageSize QPrinterInfo::maximumPhysicalPageSize()

minimumPhysicalPageSize

Signature: [const] QPageSize minimumPhysicalPageSize

Description: Method QPageSize QPrinterInfo::minimumPhysicalPageSize()

new

(1) Signature: [static] new QPrinterInfo new

Description: Constructor QPrinterInfo::QPrinterInfo()

This method creates an object of class QPrinterInfo.

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

(2) Signature: [static] new QPrinterInfo new (const QPrinterInfo other)

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

This method creates an object of class QPrinterInfo.

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

(3) Signature: [static] new QPrinterInfo new (const QPrinter printer)

Description: Constructor QPrinterInfo::QPrinterInfo(const QPrinter &printer)

This method creates an object of class QPrinterInfo.

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

printerInfo

Signature: [static] QPrinterInfo printerInfo (string printerName)

Description: Static method QPrinterInfo QPrinterInfo::printerInfo(const QString &printerName)

This method is static and can be called without an instance.

printerName

Signature: [const] string printerName

Description: Method QString QPrinterInfo::printerName()

state

Signature: [const] QPrinter_PrinterState state

Description: Method QPrinter::PrinterState QPrinterInfo::state()

supportedDuplexModes

Signature: [const] QPrinter_DuplexMode[] supportedDuplexModes

Description: Method QList<QPrinter::DuplexMode> QPrinterInfo::supportedDuplexModes()

supportedPageSizes

Signature: [const] QPageSize[] supportedPageSizes

Description: Method QList<QPageSize> QPrinterInfo::supportedPageSizes()

supportedPaperSizes

Signature: [const] QPagedPaintDevice_PageSize[] supportedPaperSizes

Description: Method QList<QPrinter::PaperSize> QPrinterInfo::supportedPaperSizes()

supportedResolutions

Signature: [const] int[] supportedResolutions

Description: Method QList<int> QPrinterInfo::supportedResolutions()

supportedSizesWithNames

Signature: [const] QPair_QString_QSizeF[] supportedSizesWithNames

Description: Method QList<QPair<QString, QSizeF> > QPrinterInfo::supportedSizesWithNames()

supportsCustomPageSizes

Signature: [const] bool supportsCustomPageSizes

Description: Method bool QPrinterInfo::supportsCustomPageSizes()