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

API reference - Class QCommonStyle

Notation used in Ruby API documentation

Module: QtWidgets

Description: Binding of QCommonStyle

Class hierarchy: QCommonStyle » QStyle » QObject

Public constructors

new QCommonStylenewConstructor QCommonStyle::QCommonStyle()

Public methods

[const]QCommonStyle 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.
[signal]voiddestroyed(QObject ptr arg1)Signal declaration for QCommonStyle::destroyed(QObject *)
[const]voiddrawComplexControl(const QStyle_ComplexControl cc,
const QStyleOptionComplex ptr opt,
QPainter ptr p,
const QWidget ptr w)
Virtual method void QCommonStyle::drawComplexControl(QStyle::ComplexControl cc, const QStyleOptionComplex *opt, QPainter *p, const QWidget *w)
[const]voiddrawControl(const QStyle_ControlElement element,
const QStyleOption ptr opt,
QPainter ptr p,
const QWidget ptr w)
Virtual method void QCommonStyle::drawControl(QStyle::ControlElement element, const QStyleOption *opt, QPainter *p, const QWidget *w)
[const]voiddrawItemPixmap(QPainter ptr painter,
const QRect rect,
int alignment,
const QPixmap pixmap)
Virtual method void QCommonStyle::drawItemPixmap(QPainter *painter, const QRect &rect, int alignment, const QPixmap &pixmap)
[const]voiddrawItemText(QPainter ptr painter,
const QRect rect,
int flags,
const QPalette pal,
bool enabled,
string text,
const QPalette_ColorRole textRole)
Virtual method void QCommonStyle::drawItemText(QPainter *painter, const QRect &rect, int flags, const QPalette &pal, bool enabled, const QString &text, QPalette::ColorRole textRole)
[const]voiddrawPrimitive(const QStyle_PrimitiveElement pe,
const QStyleOption ptr opt,
QPainter ptr p,
const QWidget ptr w)
Virtual method void QCommonStyle::drawPrimitive(QStyle::PrimitiveElement pe, const QStyleOption *opt, QPainter *p, const QWidget *w)
voidemit_destroyed(QObject ptr arg1 = nullptr)Emitter for signal void QCommonStyle::destroyed(QObject *)
voidemit_objectNameChanged(string objectName)Emitter for signal void QCommonStyle::objectNameChanged(const QString &objectName)
boolevent(QEvent ptr event)Virtual method bool QCommonStyle::event(QEvent *event)
booleventFilter(QObject ptr watched,
QEvent ptr event)
Virtual method bool QCommonStyle::eventFilter(QObject *watched, QEvent *event)
[const]QPixmapgeneratedIconPixmap(const QIcon_Mode iconMode,
const QPixmap pixmap,
const QStyleOption ptr opt)
Virtual method QPixmap QCommonStyle::generatedIconPixmap(QIcon::Mode iconMode, const QPixmap &pixmap, const QStyleOption *opt)
[const]QStyle_SubControlhitTestComplexControl(const QStyle_ComplexControl cc,
const QStyleOptionComplex ptr opt,
const QPoint pt,
const QWidget ptr w)
Virtual method QStyle::SubControl QCommonStyle::hitTestComplexControl(QStyle::ComplexControl cc, const QStyleOptionComplex *opt, const QPoint &pt, const QWidget *w)
[const]QRectitemPixmapRect(const QRect r,
int flags,
const QPixmap pixmap)
Virtual method QRect QCommonStyle::itemPixmapRect(const QRect &r, int flags, const QPixmap &pixmap)
[const]QRectitemTextRect(const QFontMetrics fm,
const QRect r,
int flags,
bool enabled,
string text)
Virtual method QRect QCommonStyle::itemTextRect(const QFontMetrics &fm, const QRect &r, int flags, bool enabled, const QString &text)
[const]intlayoutSpacing(const QSizePolicy_ControlType control1,
const QSizePolicy_ControlType control2,
const Qt_Orientation orientation,
const QStyleOption ptr option,
const QWidget ptr widget)
Virtual method int QCommonStyle::layoutSpacing(QSizePolicy::ControlType control1, QSizePolicy::ControlType control2, Qt::Orientation orientation, const QStyleOption *option, const QWidget *widget)
[signal]voidobjectNameChanged(string objectName)Signal declaration for QCommonStyle::objectNameChanged(const QString &objectName)
[const]intpixelMetric(const QStyle_PixelMetric m,
const QStyleOption ptr opt,
const QWidget ptr widget)
Virtual method int QCommonStyle::pixelMetric(QStyle::PixelMetric m, const QStyleOption *opt, const QWidget *widget)
voidpolish(QPalette arg1)Virtual method void QCommonStyle::polish(QPalette &)
voidpolish(QApplication ptr app)Virtual method void QCommonStyle::polish(QApplication *app)
voidpolish(QWidget ptr widget)Virtual method void QCommonStyle::polish(QWidget *widget)
[const]QSizesizeFromContents(const QStyle_ContentsType ct,
const QStyleOption ptr opt,
const QSize contentsSize,
const QWidget ptr widget)
Virtual method QSize QCommonStyle::sizeFromContents(QStyle::ContentsType ct, const QStyleOption *opt, const QSize &contentsSize, const QWidget *widget)
[const]QIconstandardIcon(const QStyle_StandardPixmap standardIcon,
const QStyleOption ptr opt,
const QWidget ptr widget)
Virtual method QIcon QCommonStyle::standardIcon(QStyle::StandardPixmap standardIcon, const QStyleOption *opt, const QWidget *widget)
[const]QPalettestandardPaletteVirtual method QPalette QCommonStyle::standardPalette()
[const]QPixmapstandardPixmap(const QStyle_StandardPixmap sp,
const QStyleOption ptr opt,
const QWidget ptr widget)
Virtual method QPixmap QCommonStyle::standardPixmap(QStyle::StandardPixmap sp, const QStyleOption *opt, const QWidget *widget)
[const]intstyleHint(const QStyle_StyleHint sh,
const QStyleOption ptr opt,
const QWidget ptr w,
QStyleHintReturn ptr shret)
Virtual method int QCommonStyle::styleHint(QStyle::StyleHint sh, const QStyleOption *opt, const QWidget *w, QStyleHintReturn *shret)
[const]QRectsubControlRect(const QStyle_ComplexControl cc,
const QStyleOptionComplex ptr opt,
const QStyle_SubControl sc,
const QWidget ptr w)
Virtual method QRect QCommonStyle::subControlRect(QStyle::ComplexControl cc, const QStyleOptionComplex *opt, QStyle::SubControl sc, const QWidget *w)
[const]QRectsubElementRect(const QStyle_SubElement r,
const QStyleOption ptr opt,
const QWidget ptr widget)
Virtual method QRect QCommonStyle::subElementRect(QStyle::SubElement r, const QStyleOption *opt, const QWidget *widget)
voidunpolish(QWidget ptr widget)Virtual method void QCommonStyle::unpolish(QWidget *widget)
voidunpolish(QApplication ptr application)Virtual method void QCommonStyle::unpolish(QApplication *application)

Public static methods and constants

QMetaObjectstaticMetaObjectObtains the static MetaObject for this class.
stringtr(string s,
string c = nullptr,
int n = -1)
Static method QString QCommonStyle::tr(const char *s, const char *c, int n)
stringtrUtf8(string s,
string c = nullptr,
int n = -1)
Static method QString QCommonStyle::trUtf8(const char *s, const char *c, int n)

Protected methods (static, non-static and constructors)

voidchildEvent(QChildEvent ptr event)Virtual method void QCommonStyle::childEvent(QChildEvent *event)
voidcustomEvent(QEvent ptr event)Virtual method void QCommonStyle::customEvent(QEvent *event)
voiddisconnectNotify(const QMetaMethod signal)Virtual method void QCommonStyle::disconnectNotify(const QMetaMethod &signal)
[const]boolisSignalConnected(const QMetaMethod signal)Method bool QCommonStyle::isSignalConnected(const QMetaMethod &signal)
[const]intreceivers(string signal)Method int QCommonStyle::receivers(const char *signal)
[const]QObject ptrsenderMethod QObject *QCommonStyle::sender()
[const]intsenderSignalIndexMethod int QCommonStyle::senderSignalIndex()
voidtimerEvent(QTimerEvent ptr event)Virtual method void QCommonStyle::timerEvent(QTimerEvent *event)

Detailed description

_const_cast

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

childEvent

Signature: void childEvent (QChildEvent ptr event)

Description: Virtual method void QCommonStyle::childEvent(QChildEvent *event)

This method can be reimplemented in a derived class.

customEvent

Signature: void customEvent (QEvent ptr event)

Description: Virtual method void QCommonStyle::customEvent(QEvent *event)

This method can be reimplemented in a derived class.

destroyed

Signature: [signal] void destroyed (QObject ptr arg1)

Description: Signal declaration for QCommonStyle::destroyed(QObject *)

You can bind a procedure to this signal.

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

disconnectNotify

Signature: void disconnectNotify (const QMetaMethod signal)

Description: Virtual method void QCommonStyle::disconnectNotify(const QMetaMethod &signal)

This method can be reimplemented in a derived class.

drawComplexControl

Signature: [const] void drawComplexControl (const QStyle_ComplexControl cc, const QStyleOptionComplex ptr opt, QPainter ptr p, const QWidget ptr w)

Description: Virtual method void QCommonStyle::drawComplexControl(QStyle::ComplexControl cc, const QStyleOptionComplex *opt, QPainter *p, const QWidget *w)

This method can be reimplemented in a derived class.

drawControl

Signature: [const] void drawControl (const QStyle_ControlElement element, const QStyleOption ptr opt, QPainter ptr p, const QWidget ptr w)

Description: Virtual method void QCommonStyle::drawControl(QStyle::ControlElement element, const QStyleOption *opt, QPainter *p, const QWidget *w)

This method can be reimplemented in a derived class.

drawItemPixmap

Signature: [const] void drawItemPixmap (QPainter ptr painter, const QRect rect, int alignment, const QPixmap pixmap)

Description: Virtual method void QCommonStyle::drawItemPixmap(QPainter *painter, const QRect &rect, int alignment, const QPixmap &pixmap)

This method can be reimplemented in a derived class.

drawItemText

Signature: [const] void drawItemText (QPainter ptr painter, const QRect rect, int flags, const QPalette pal, bool enabled, string text, const QPalette_ColorRole textRole)

Description: Virtual method void QCommonStyle::drawItemText(QPainter *painter, const QRect &rect, int flags, const QPalette &pal, bool enabled, const QString &text, QPalette::ColorRole textRole)

This method can be reimplemented in a derived class.

drawPrimitive

Signature: [const] void drawPrimitive (const QStyle_PrimitiveElement pe, const QStyleOption ptr opt, QPainter ptr p, const QWidget ptr w)

Description: Virtual method void QCommonStyle::drawPrimitive(QStyle::PrimitiveElement pe, const QStyleOption *opt, QPainter *p, const QWidget *w)

This method can be reimplemented in a derived class.

emit_destroyed

Signature: void emit_destroyed (QObject ptr arg1 = nullptr)

Description: Emitter for signal void QCommonStyle::destroyed(QObject *)

Call this method to emit this signal.

emit_objectNameChanged

Signature: void emit_objectNameChanged (string objectName)

Description: Emitter for signal void QCommonStyle::objectNameChanged(const QString &objectName)

Call this method to emit this signal.

event

Signature: bool event (QEvent ptr event)

Description: Virtual method bool QCommonStyle::event(QEvent *event)

This method can be reimplemented in a derived class.

eventFilter

Signature: bool eventFilter (QObject ptr watched, QEvent ptr event)

Description: Virtual method bool QCommonStyle::eventFilter(QObject *watched, QEvent *event)

This method can be reimplemented in a derived class.

generatedIconPixmap

Signature: [const] QPixmap generatedIconPixmap (const QIcon_Mode iconMode, const QPixmap pixmap, const QStyleOption ptr opt)

Description: Virtual method QPixmap QCommonStyle::generatedIconPixmap(QIcon::Mode iconMode, const QPixmap &pixmap, const QStyleOption *opt)

This method can be reimplemented in a derived class.

hitTestComplexControl

Signature: [const] QStyle_SubControl hitTestComplexControl (const QStyle_ComplexControl cc, const QStyleOptionComplex ptr opt, const QPoint pt, const QWidget ptr w)

Description: Virtual method QStyle::SubControl QCommonStyle::hitTestComplexControl(QStyle::ComplexControl cc, const QStyleOptionComplex *opt, const QPoint &pt, const QWidget *w)

This method can be reimplemented in a derived class.

isSignalConnected

Signature: [const] bool isSignalConnected (const QMetaMethod signal)

Description: Method bool QCommonStyle::isSignalConnected(const QMetaMethod &signal)

This method is protected and can only be called from inside a derived class.

itemPixmapRect

Signature: [const] QRect itemPixmapRect (const QRect r, int flags, const QPixmap pixmap)

Description: Virtual method QRect QCommonStyle::itemPixmapRect(const QRect &r, int flags, const QPixmap &pixmap)

This method can be reimplemented in a derived class.

itemTextRect

Signature: [const] QRect itemTextRect (const QFontMetrics fm, const QRect r, int flags, bool enabled, string text)

Description: Virtual method QRect QCommonStyle::itemTextRect(const QFontMetrics &fm, const QRect &r, int flags, bool enabled, const QString &text)

This method can be reimplemented in a derived class.

layoutSpacing

Signature: [const] int layoutSpacing (const QSizePolicy_ControlType control1, const QSizePolicy_ControlType control2, const Qt_Orientation orientation, const QStyleOption ptr option, const QWidget ptr widget)

Description: Virtual method int QCommonStyle::layoutSpacing(QSizePolicy::ControlType control1, QSizePolicy::ControlType control2, Qt::Orientation orientation, const QStyleOption *option, const QWidget *widget)

This method can be reimplemented in a derived class.

new

Signature: [static] new QCommonStyle new

Description: Constructor QCommonStyle::QCommonStyle()

This method creates an object of class QCommonStyle.

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

objectNameChanged

Signature: [signal] void objectNameChanged (string objectName)

Description: Signal declaration for QCommonStyle::objectNameChanged(const QString &objectName)

You can bind a procedure to this signal.

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

pixelMetric

Signature: [const] int pixelMetric (const QStyle_PixelMetric m, const QStyleOption ptr opt, const QWidget ptr widget)

Description: Virtual method int QCommonStyle::pixelMetric(QStyle::PixelMetric m, const QStyleOption *opt, const QWidget *widget)

This method can be reimplemented in a derived class.

polish

(1) Signature: void polish (QPalette arg1)

Description: Virtual method void QCommonStyle::polish(QPalette &)

This method can be reimplemented in a derived class.

(2) Signature: void polish (QApplication ptr app)

Description: Virtual method void QCommonStyle::polish(QApplication *app)

This method can be reimplemented in a derived class.

(3) Signature: void polish (QWidget ptr widget)

Description: Virtual method void QCommonStyle::polish(QWidget *widget)

This method can be reimplemented in a derived class.

receivers

Signature: [const] int receivers (string signal)

Description: Method int QCommonStyle::receivers(const char *signal)

This method is protected and can only be called from inside a derived class.

sender

Signature: [const] QObject ptr sender

Description: Method QObject *QCommonStyle::sender()

This method is protected and can only be called from inside a derived class.

senderSignalIndex

Signature: [const] int senderSignalIndex

Description: Method int QCommonStyle::senderSignalIndex()

This method is protected and can only be called from inside a derived class.

sizeFromContents

Signature: [const] QSize sizeFromContents (const QStyle_ContentsType ct, const QStyleOption ptr opt, const QSize contentsSize, const QWidget ptr widget)

Description: Virtual method QSize QCommonStyle::sizeFromContents(QStyle::ContentsType ct, const QStyleOption *opt, const QSize &contentsSize, const QWidget *widget)

This method can be reimplemented in a derived class.

standardIcon

Signature: [const] QIcon standardIcon (const QStyle_StandardPixmap standardIcon, const QStyleOption ptr opt, const QWidget ptr widget)

Description: Virtual method QIcon QCommonStyle::standardIcon(QStyle::StandardPixmap standardIcon, const QStyleOption *opt, const QWidget *widget)

This method can be reimplemented in a derived class.

standardPalette

Signature: [const] QPalette standardPalette

Description: Virtual method QPalette QCommonStyle::standardPalette()

This method can be reimplemented in a derived class.

standardPixmap

Signature: [const] QPixmap standardPixmap (const QStyle_StandardPixmap sp, const QStyleOption ptr opt, const QWidget ptr widget)

Description: Virtual method QPixmap QCommonStyle::standardPixmap(QStyle::StandardPixmap sp, const QStyleOption *opt, const QWidget *widget)

This method can be reimplemented in a derived class.

staticMetaObject

Signature: [static] QMetaObject staticMetaObject

Description: Obtains the static MetaObject for this class.

styleHint

Signature: [const] int styleHint (const QStyle_StyleHint sh, const QStyleOption ptr opt, const QWidget ptr w, QStyleHintReturn ptr shret)

Description: Virtual method int QCommonStyle::styleHint(QStyle::StyleHint sh, const QStyleOption *opt, const QWidget *w, QStyleHintReturn *shret)

This method can be reimplemented in a derived class.

subControlRect

Signature: [const] QRect subControlRect (const QStyle_ComplexControl cc, const QStyleOptionComplex ptr opt, const QStyle_SubControl sc, const QWidget ptr w)

Description: Virtual method QRect QCommonStyle::subControlRect(QStyle::ComplexControl cc, const QStyleOptionComplex *opt, QStyle::SubControl sc, const QWidget *w)

This method can be reimplemented in a derived class.

subElementRect

Signature: [const] QRect subElementRect (const QStyle_SubElement r, const QStyleOption ptr opt, const QWidget ptr widget)

Description: Virtual method QRect QCommonStyle::subElementRect(QStyle::SubElement r, const QStyleOption *opt, const QWidget *widget)

This method can be reimplemented in a derived class.

timerEvent

Signature: void timerEvent (QTimerEvent ptr event)

Description: Virtual method void QCommonStyle::timerEvent(QTimerEvent *event)

This method can be reimplemented in a derived class.

tr

Signature: [static] string tr (string s, string c = nullptr, int n = -1)

Description: Static method QString QCommonStyle::tr(const char *s, const char *c, int n)

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

trUtf8

Signature: [static] string trUtf8 (string s, string c = nullptr, int n = -1)

Description: Static method QString QCommonStyle::trUtf8(const char *s, const char *c, int n)

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

unpolish

(1) Signature: void unpolish (QWidget ptr widget)

Description: Virtual method void QCommonStyle::unpolish(QWidget *widget)

This method can be reimplemented in a derived class.

(2) Signature: void unpolish (QApplication ptr application)

Description: Virtual method void QCommonStyle::unpolish(QApplication *application)

This method can be reimplemented in a derived class.