API reference - Class QPaintDevice

Notation used in Ruby API documentation

Description: Binding of QPaintDevice

Class hierarchy: QPaintDevice

Sub-classes: PaintDeviceMetric

Public constructors

new QPaintDevice ptrnewCreates a new object of this class

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.
[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()
[virtual,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]new QPaintDevice_PaintDeviceMetric ptrPdmDepthEnum constant QPaintDevice::PdmDepth
[static,const]new QPaintDevice_PaintDeviceMetric ptrPdmDpiXEnum constant QPaintDevice::PdmDpiX
[static,const]new QPaintDevice_PaintDeviceMetric ptrPdmDpiYEnum constant QPaintDevice::PdmDpiY
[static,const]new QPaintDevice_PaintDeviceMetric ptrPdmHeightEnum constant QPaintDevice::PdmHeight
[static,const]new QPaintDevice_PaintDeviceMetric ptrPdmHeightMMEnum constant QPaintDevice::PdmHeightMM
[static,const]new QPaintDevice_PaintDeviceMetric ptrPdmNumColorsEnum constant QPaintDevice::PdmNumColors
[static,const]new QPaintDevice_PaintDeviceMetric ptrPdmPhysicalDpiXEnum constant QPaintDevice::PdmPhysicalDpiX
[static,const]new QPaintDevice_PaintDeviceMetric ptrPdmPhysicalDpiYEnum constant QPaintDevice::PdmPhysicalDpiY
[static,const]new QPaintDevice_PaintDeviceMetric ptrPdmWidthEnum constant QPaintDevice::PdmWidth
[static,const]new QPaintDevice_PaintDeviceMetric ptrPdmWidthMMEnum constant QPaintDevice::PdmWidthMM

Protected methods (static, non-static and constructors)

[virtual,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

[static,const] new QPaintDevice_PaintDeviceMetric ptr PdmDepth

Description: Enum constant QPaintDevice::PdmDepth

[static,const] new QPaintDevice_PaintDeviceMetric ptr PdmDpiX

Description: Enum constant QPaintDevice::PdmDpiX

[static,const] new QPaintDevice_PaintDeviceMetric ptr PdmDpiY

Description: Enum constant QPaintDevice::PdmDpiY

[static,const] new QPaintDevice_PaintDeviceMetric ptr PdmHeight

Description: Enum constant QPaintDevice::PdmHeight

[static,const] new QPaintDevice_PaintDeviceMetric ptr PdmHeightMM

Description: Enum constant QPaintDevice::PdmHeightMM

[static,const] new QPaintDevice_PaintDeviceMetric ptr PdmNumColors

Description: Enum constant QPaintDevice::PdmNumColors

[static,const] new QPaintDevice_PaintDeviceMetric ptr PdmPhysicalDpiX

Description: Enum constant QPaintDevice::PdmPhysicalDpiX

[static,const] new QPaintDevice_PaintDeviceMetric ptr PdmPhysicalDpiY

Description: Enum constant QPaintDevice::PdmPhysicalDpiY

[static,const] new QPaintDevice_PaintDeviceMetric ptr PdmWidth

Description: Enum constant QPaintDevice::PdmWidth

[static,const] new QPaintDevice_PaintDeviceMetric ptr PdmWidthMM

Description: Enum constant QPaintDevice::PdmWidthMM

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.

[const] int colorCount

Description: Method int QPaintDevice::colorCount()

void create

Description: Ensures the C++ object is created

Use of this method is deprecated. Use _create instead

[const] int depth

Description: Method int QPaintDevice::depth()

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] int height

Description: Method int QPaintDevice::height()

[const] int heightMM

Description: Method int QPaintDevice::heightMM()

[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

[const] int logicalDpiX

Description: Method int QPaintDevice::logicalDpiX()

[const] int logicalDpiY

Description: Method int QPaintDevice::logicalDpiY()

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

[static] new QPaintDevice ptr new

Description: Creates a new object of this class

Python specific notes:

This method is the default initializer of the object

[const] int numColors

Description: Method int QPaintDevice::numColors()

[virtual,const] QPaintEngine ptr paintEngine

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

This method can be reimplemented in a derived class.

[const] bool paintingActive

Description: Method bool QPaintDevice::paintingActive()

[const] int physicalDpiX

Description: Method int QPaintDevice::physicalDpiX()

[const] int physicalDpiY

Description: Method int QPaintDevice::physicalDpiY()

[const] int width

Description: Method int QPaintDevice::width()

[const] int widthMM

Description: Method int QPaintDevice::widthMM()