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

API reference - Class QStylePainter

Notation used in Ruby API documentation

Module: QtWidgets

Description: Binding of QStylePainter

Class hierarchy: QStylePainter » QPainter

Public constructors

new QStylePainternewConstructor QStylePainter::QStylePainter()
new QStylePainternew(QWidget ptr w)Constructor QStylePainter::QStylePainter(QWidget *w)
new QStylePainternew(QPaintDevice ptr pd,
QWidget ptr w)
Constructor QStylePainter::QStylePainter(QPaintDevice *pd, QWidget *w)

Public methods

[const]QStylePainter 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.
boolbegin(QWidget ptr w)Method bool QStylePainter::begin(QWidget *w)
boolbegin(QPaintDevice ptr pd,
QWidget ptr w)
Method bool QStylePainter::begin(QPaintDevice *pd, QWidget *w)
voiddrawComplexControl(const QStyle_ComplexControl cc,
const QStyleOptionComplex opt)
Method void QStylePainter::drawComplexControl(QStyle::ComplexControl cc, const QStyleOptionComplex &opt)
voiddrawControl(const QStyle_ControlElement ce,
const QStyleOption opt)
Method void QStylePainter::drawControl(QStyle::ControlElement ce, const QStyleOption &opt)
voiddrawItemPixmap(const QRect r,
int flags,
const QPixmap pixmap)
Method void QStylePainter::drawItemPixmap(const QRect &r, int flags, const QPixmap &pixmap)
voiddrawItemText(const QRect r,
int flags,
const QPalette pal,
bool enabled,
string text,
const QPalette_ColorRole textRole = QPalette::NoRole)
Method void QStylePainter::drawItemText(const QRect &r, int flags, const QPalette &pal, bool enabled, const QString &text, QPalette::ColorRole textRole)
voiddrawPrimitive(const QStyle_PrimitiveElement pe,
const QStyleOption opt)
Method void QStylePainter::drawPrimitive(QStyle::PrimitiveElement pe, const QStyleOption &opt)
[const]QStyle ptrstyleMethod QStyle *QStylePainter::style()

Detailed description

_const_cast

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

begin

(1) Signature: bool begin (QWidget ptr w)

Description: Method bool QStylePainter::begin(QWidget *w)

(2) Signature: bool begin (QPaintDevice ptr pd, QWidget ptr w)

Description: Method bool QStylePainter::begin(QPaintDevice *pd, QWidget *w)

drawComplexControl

Signature: void drawComplexControl (const QStyle_ComplexControl cc, const QStyleOptionComplex opt)

Description: Method void QStylePainter::drawComplexControl(QStyle::ComplexControl cc, const QStyleOptionComplex &opt)

drawControl

Signature: void drawControl (const QStyle_ControlElement ce, const QStyleOption opt)

Description: Method void QStylePainter::drawControl(QStyle::ControlElement ce, const QStyleOption &opt)

drawItemPixmap

Signature: void drawItemPixmap (const QRect r, int flags, const QPixmap pixmap)

Description: Method void QStylePainter::drawItemPixmap(const QRect &r, int flags, const QPixmap &pixmap)

drawItemText

Signature: void drawItemText (const QRect r, int flags, const QPalette pal, bool enabled, string text, const QPalette_ColorRole textRole = QPalette::NoRole)

Description: Method void QStylePainter::drawItemText(const QRect &r, int flags, const QPalette &pal, bool enabled, const QString &text, QPalette::ColorRole textRole)

drawPrimitive

Signature: void drawPrimitive (const QStyle_PrimitiveElement pe, const QStyleOption opt)

Description: Method void QStylePainter::drawPrimitive(QStyle::PrimitiveElement pe, const QStyleOption &opt)

new

(1) Signature: [static] new QStylePainter new

Description: Constructor QStylePainter::QStylePainter()

This method creates an object of class QStylePainter.

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

(2) Signature: [static] new QStylePainter new (QWidget ptr w)

Description: Constructor QStylePainter::QStylePainter(QWidget *w)

This method creates an object of class QStylePainter.

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

(3) Signature: [static] new QStylePainter new (QPaintDevice ptr pd, QWidget ptr w)

Description: Constructor QStylePainter::QStylePainter(QPaintDevice *pd, QWidget *w)

This method creates an object of class QStylePainter.

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

style

Signature: [const] QStyle ptr style

Description: Method QStyle *QStylePainter::style()