KLayout 0.29.8 (2024-11-26 926dac96c) [master]

API reference - Class QPaintDevice

Notation used in Ruby API documentation

Module: QtGui

Description: Binding of QPaintDevice

Class hierarchy: QPaintDevice

Sub-classes: PaintDeviceMetric, QFlags_PaintDeviceMetric

Public constructors

new QPaintDevicenewConstructor QPaintDevice::QPaintDevice()

Public methods

[const]QPaintDevice 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.
[const]intcolorCountMethod int QPaintDevice::colorCount()
[const]intdepthMethod int QPaintDevice::depth()
[const]intheightMethod int QPaintDevice::height()
[const]intheightMMMethod int QPaintDevice::heightMM()
[const]intlogicalDpiXMethod int QPaintDevice::logicalDpiX()
[const]intlogicalDpiYMethod int QPaintDevice::logicalDpiY()
[const]intnumColorsMethod int QPaintDevice::numColors()
[const]QPaintEngine ptrpaintEngineVirtual method QPaintEngine *QPaintDevice::paintEngine()
[const]boolpaintingActiveMethod bool QPaintDevice::paintingActive()
[const]intphysicalDpiXMethod int QPaintDevice::physicalDpiX()
[const]intphysicalDpiYMethod int QPaintDevice::physicalDpiY()
[const]intwidthMethod int QPaintDevice::width()
[const]intwidthMMMethod int QPaintDevice::widthMM()

Public static methods and constants

[static,const]QPaintDevice_PaintDeviceMetricPdmDepthEnum constant QPaintDevice::PdmDepth
[static,const]QPaintDevice_PaintDeviceMetricPdmDpiXEnum constant QPaintDevice::PdmDpiX
[static,const]QPaintDevice_PaintDeviceMetricPdmDpiYEnum constant QPaintDevice::PdmDpiY
[static,const]QPaintDevice_PaintDeviceMetricPdmHeightEnum constant QPaintDevice::PdmHeight
[static,const]QPaintDevice_PaintDeviceMetricPdmHeightMMEnum constant QPaintDevice::PdmHeightMM
[static,const]QPaintDevice_PaintDeviceMetricPdmNumColorsEnum constant QPaintDevice::PdmNumColors
[static,const]QPaintDevice_PaintDeviceMetricPdmPhysicalDpiXEnum constant QPaintDevice::PdmPhysicalDpiX
[static,const]QPaintDevice_PaintDeviceMetricPdmPhysicalDpiYEnum constant QPaintDevice::PdmPhysicalDpiY
[static,const]QPaintDevice_PaintDeviceMetricPdmWidthEnum constant QPaintDevice::PdmWidth
[static,const]QPaintDevice_PaintDeviceMetricPdmWidthMMEnum constant QPaintDevice::PdmWidthMM

Protected methods (static, non-static and constructors)

[const]intmetric(const QPaintDevice_PaintDeviceMetric metric)Virtual method int QPaintDevice::metric(QPaintDevice::PaintDeviceMetric metric)

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

PdmDepth

Signature: [static,const] QPaintDevice_PaintDeviceMetric PdmDepth

Description: Enum constant QPaintDevice::PdmDepth

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

PdmDpiX

Signature: [static,const] QPaintDevice_PaintDeviceMetric PdmDpiX

Description: Enum constant QPaintDevice::PdmDpiX

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

PdmDpiY

Signature: [static,const] QPaintDevice_PaintDeviceMetric PdmDpiY

Description: Enum constant QPaintDevice::PdmDpiY

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

PdmHeight

Signature: [static,const] QPaintDevice_PaintDeviceMetric PdmHeight

Description: Enum constant QPaintDevice::PdmHeight

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

PdmHeightMM

Signature: [static,const] QPaintDevice_PaintDeviceMetric PdmHeightMM

Description: Enum constant QPaintDevice::PdmHeightMM

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

PdmNumColors

Signature: [static,const] QPaintDevice_PaintDeviceMetric PdmNumColors

Description: Enum constant QPaintDevice::PdmNumColors

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

PdmPhysicalDpiX

Signature: [static,const] QPaintDevice_PaintDeviceMetric PdmPhysicalDpiX

Description: Enum constant QPaintDevice::PdmPhysicalDpiX

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

PdmPhysicalDpiY

Signature: [static,const] QPaintDevice_PaintDeviceMetric PdmPhysicalDpiY

Description: Enum constant QPaintDevice::PdmPhysicalDpiY

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

PdmWidth

Signature: [static,const] QPaintDevice_PaintDeviceMetric PdmWidth

Description: Enum constant QPaintDevice::PdmWidth

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

PdmWidthMM

Signature: [static,const] QPaintDevice_PaintDeviceMetric PdmWidthMM

Description: Enum constant QPaintDevice::PdmWidthMM

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

_const_cast

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

colorCount

Signature: [const] int colorCount

Description: Method int QPaintDevice::colorCount()

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.

depth

Signature: [const] int depth

Description: Method int QPaintDevice::depth()

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.

height

Signature: [const] int height

Description: Method int QPaintDevice::height()

heightMM

Signature: [const] int heightMM

Description: Method int QPaintDevice::heightMM()

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.

logicalDpiX

Signature: [const] int logicalDpiX

Description: Method int QPaintDevice::logicalDpiX()

logicalDpiY

Signature: [const] int logicalDpiY

Description: Method int QPaintDevice::logicalDpiY()

metric

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

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

This method can be reimplemented in a derived class.

new

Signature: [static] new QPaintDevice new

Description: Constructor QPaintDevice::QPaintDevice()

This method creates an object of class QPaintDevice.

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

numColors

Signature: [const] int numColors

Description: Method int QPaintDevice::numColors()

paintEngine

Signature: [const] QPaintEngine ptr paintEngine

Description: Virtual method QPaintEngine *QPaintDevice::paintEngine()

This method can be reimplemented in a derived class.

paintingActive

Signature: [const] bool paintingActive

Description: Method bool QPaintDevice::paintingActive()

physicalDpiX

Signature: [const] int physicalDpiX

Description: Method int QPaintDevice::physicalDpiX()

physicalDpiY

Signature: [const] int physicalDpiY

Description: Method int QPaintDevice::physicalDpiY()

width

Signature: [const] int width

Description: Method int QPaintDevice::width()

widthMM

Signature: [const] int widthMM

Description: Method int QPaintDevice::widthMM()