Qt
Internal/Contributor docs for the Qt SDK. Note: These are NOT official API docs; those are found at https://doc.qt.io/
Loading...
Searching...
No Matches
QStyleKitStyle Class Reference

\inmodule QtLabsStyleKit More...

#include <qstylekitstyle.h>

Inheritance diagram for QStyleKitStyle:
Collaboration diagram for QStyleKitStyle:

Signals

void stylePathChanged (const QString &stylePath)
void themeNameChanged (const QString &themeName)
void availableThemeNamesChanged (const QStringList &availableThemeNames)
void customThemeNamesChanged (const QStringList &customThemeNames)
Signals inherited from QObject
void destroyed (QObject *=nullptr)
 This signal is emitted immediately before the object obj is destroyed, after any instances of QPointer have been notified, and cannot be blocked.
void objectNameChanged (const QString &objectName, QPrivateSignal)
 This signal is emitted after the object's name has been changed.

Public Member Functions

 QStyleKitStyle ()
 Constructs a QStyleKitStyle with no style loaded.
 QStyleKitStyle (const QString &filePath)
 Constructs a QStyleKitStyle and loads the QML \l Style at filePath.
 ~QStyleKitStyle () override
 Destroys the QStyleKitStyle.
QString stylePath () const
 Returns the path most recently set for the QML \l Style file.
void setStylePath (const QString &filePath)
 Loads the QML \l Style at filePath and applies it to all widgets.
QString themeName () const
 Returns the name of the requested theme, or an empty string when no \l Style is loaded.
void setThemeName (const QString &themeName)
 Activates the theme named themeName.
QStringList availableThemeNames () const
 Returns the names of all themes that the loaded \l Style exposes.
QStringList customThemeNames () const
 Returns the names of the custom themes defined by the loaded \l Style, excluding the built-in Light and Dark themes.
void drawPrimitive (PrimitiveElement pe, const QStyleOption *opt, QPainter *p, const QWidget *w=nullptr) const override
 \reimp
void drawControl (ControlElement element, const QStyleOption *opt, QPainter *p, const QWidget *w=nullptr) const override
 \reimp
QRect subElementRect (SubElement r, const QStyleOption *opt, const QWidget *widget=nullptr) const override
 \reimp
void drawComplexControl (ComplexControl cc, const QStyleOptionComplex *opt, QPainter *p, const QWidget *w=nullptr) const override
 \reimp
SubControl hitTestComplexControl (ComplexControl cc, const QStyleOptionComplex *opt, const QPoint &pt, const QWidget *w=nullptr) const override
 \reimp
QRect subControlRect (ComplexControl cc, const QStyleOptionComplex *opt, SubControl sc, const QWidget *w=nullptr) const override
 \reimp
QSize sizeFromContents (ContentsType ct, const QStyleOption *opt, const QSize &contentsSize, const QWidget *widget=nullptr) const override
 \reimp
int pixelMetric (PixelMetric m, const QStyleOption *opt=nullptr, const QWidget *widget=nullptr) const override
 \reimp
int styleHint (StyleHint sh, const QStyleOption *opt=nullptr, const QWidget *w=nullptr, QStyleHintReturn *shret=nullptr) const override
 \reimp
QPalette standardPalette () const override
 \reimp
void polish (QWidget *widget) override
 \reimp
void polish (QApplication *application) override
 \reimp
void polish (QPalette &palette) override
 \reimp
void unpolish (QWidget *widget) override
 \reimp
void unpolish (QApplication *application) override
 \reimp
Public Member Functions inherited from QCommonStyle
 QCommonStyle ()
 Constructs a QCommonStyle.
 ~QCommonStyle ()
 Destroys the style.
QIcon standardIcon (StandardPixmap standardIcon, const QStyleOption *opt=nullptr, const QWidget *widget=nullptr) const override
QPixmap standardPixmap (StandardPixmap sp, const QStyleOption *opt=nullptr, const QWidget *widget=nullptr) const override
 \reimp
QPixmap generatedIconPixmap (QIcon::Mode iconMode, const QPixmap &pixmap, const QStyleOption *opt) const override
 \reimp
int layoutSpacing (QSizePolicy::ControlType control1, QSizePolicy::ControlType control2, Qt::Orientation orientation, const QStyleOption *option=nullptr, const QWidget *widget=nullptr) const override
 \reimp
Public Member Functions inherited from QStyle
 QStyle ()
 Constructs a style object.
virtual ~QStyle ()
 Destroys the style object.
QString name () const
 Returns the name of the style.
virtual QRect itemTextRect (const QFontMetrics &fm, const QRect &r, int flags, bool enabled, const QString &text) const
 Returns the area within the given rectangle in which to draw the provided text according to the specified font metrics and alignment.
virtual QRect itemPixmapRect (const QRect &r, int flags, const QPixmap &pixmap) const
 Returns the area within the given rectangle in which to draw the specified pixmap according to the defined alignment.
virtual void drawItemText (QPainter *painter, const QRect &rect, int flags, const QPalette &pal, bool enabled, const QString &text, QPalette::ColorRole textRole=QPalette::NoRole) const
 Draws the given text in the specified rectangle using the provided painter and palette.
virtual void drawItemPixmap (QPainter *painter, const QRect &rect, int alignment, const QPixmap &pixmap) const
 Draws the given pixmap in the specified rectangle, according to the specified alignment, using the provided painter.
int combinedLayoutSpacing (QSizePolicy::ControlTypes controls1, QSizePolicy::ControlTypes controls2, Qt::Orientation orientation, QStyleOption *option=nullptr, QWidget *widget=nullptr) const
const QStyle * proxy () const
Public Member Functions inherited from QObject
Q_INVOKABLE QObject (QObject *parent=nullptr)
 Constructs an object with parent object parent.
virtual ~QObject ()
 Destroys the object, deleting all its child objects.
QString objectName () const
Q_WEAK_OVERLOAD void setObjectName (const QString &name)
 Sets the object's name to name.
void setObjectName (QAnyStringView name)
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
QBindable< QString > bindableObjectName ()
bool isWidgetType () const
 Returns true if the object is a widget; otherwise returns false.
bool isWindowType () const
 Returns true if the object is a window; otherwise returns false.
bool isQuickItemType () const
 Returns true if the object is a QQuickItem; otherwise returns false.
bool isQmlExposed () const noexcept
 Returns whether the object has been created by the QML engine or ownership has been explicitly set via QJSEngine::setObjectOwnership().
bool signalsBlocked () const noexcept
 Returns true if signals are blocked; otherwise returns false.
bool blockSignals (bool b) noexcept
 If block is true, signals emitted by this object are blocked (i.e., emitting a signal will not invoke anything connected to it).
QThread * thread () const
 Returns the thread in which the object lives.
bool moveToThread (QThread *thread QT6_DECL_NEW_OVERLOAD_TAIL)
 Changes the thread affinity for this object and its children and returns true on success.
int startTimer (int interval, Qt::TimerType timerType=Qt::CoarseTimer)
 This is an overloaded function that will start a timer of type timerType and a timeout of interval milliseconds.
int startTimer (std::chrono::nanoseconds time, Qt::TimerType timerType=Qt::CoarseTimer)
void killTimer (int id)
 Kills the timer with timer identifier, id.
void killTimer (Qt::TimerId id)
template<typename T>
T findChild (QAnyStringView aName, Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
 Returns the child of this object that can be cast into type T and that is called name, or \nullptr if there is no such object.
template<typename T>
QList< T > findChildren (QAnyStringView aName, Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
 Returns all children of this object with the given name that can be cast to type T, or an empty list if there are no such objects.
template<typename T>
T findChild (Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
template<typename T>
QList< T > findChildren (Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
const QObjectList & children () const
 Returns a list of child objects.
void setParent (QObject *parent)
 Makes the object a child of parent.
void installEventFilter (QObject *filterObj)
 Installs an event filter filterObj on this object.
void removeEventFilter (QObject *obj)
 Removes an event filter object obj from this object.
QMetaObject::Connection connect (const QObject *sender, const char *signal, const char *member, Qt::ConnectionType type=Qt::AutoConnection) const
bool disconnect (const char *signal=nullptr, const QObject *receiver=nullptr, const char *member=nullptr) const
bool disconnect (const QObject *receiver, const char *member=nullptr) const
void dumpObjectTree () const
 Dumps a tree of children to the debug output.
void dumpObjectInfo () const
 Dumps information about signal connections, etc.
bool setProperty (const char *name, const QVariant &value)
 Sets the value of the object's name property to value.
bool setProperty (const char *name, QVariant &&value)
QVariant property (const char *name) const
 Returns the value of the object's name property.
QList< QByteArray > dynamicPropertyNames () const
QBindingStorage * bindingStorage ()
const QBindingStorage * bindingStorage () const
QObject * parent () const
 Returns a pointer to the parent object.
bool inherits (const char *classname) const
 Returns true if this object is an instance of a class that inherits className or a QObject subclass that inherits className; otherwise returns false.

Protected Member Functions

bool eventFilter (QObject *watched, QEvent *event) override
 \reimp
bool event (QEvent *event) override
 \reimp
Protected Member Functions inherited from QCommonStyle
 QCommonStyle (QCommonStylePrivate &dd)
Protected Member Functions inherited from QStyle
 QStyle (QStylePrivate &dd)
Protected Member Functions inherited from QObject
QObject * sender () const
 Returns a pointer to the object that sent the signal, if called in a slot activated by a signal; otherwise it returns \nullptr.
int senderSignalIndex () const
int receivers (const char *signal) const
 Returns the number of receivers connected to the signal.
bool isSignalConnected (const QMetaMethod &signal) const
virtual void timerEvent (QTimerEvent *event)
 This event handler can be reimplemented in a subclass to receive timer events for the object.
virtual void childEvent (QChildEvent *event)
 This event handler can be reimplemented in a subclass to receive child events.
virtual void customEvent (QEvent *event)
 This event handler can be reimplemented in a subclass to receive custom events.
virtual void connectNotify (const QMetaMethod &signal)
virtual void disconnectNotify (const QMetaMethod &signal)
 QObject (QObjectPrivate &dd, QObject *parent=nullptr)

Properties

QString stylePath
 the path to the QML \l Style file driving this style.
QString themeName
 the name of the active theme.
QStringList availableThemeNames
 the list of theme names exposed by the loaded \l Style.
QStringList customThemeNames
 the list of custom theme names defined by the loaded \l Style.
Properties inherited from QObject
QString objectName
 the name of this object

Additional Inherited Members

Public Types inherited from QStyle
enum  StateFlag {
  State_None = 0x00000000 , State_Enabled = 0x00000001 , State_Raised = 0x00000002 , State_Sunken = 0x00000004 ,
  State_Off = 0x00000008 , State_NoChange = 0x00000010 , State_On = 0x00000020 , State_DownArrow = 0x00000040 ,
  State_Horizontal = 0x00000080 , State_HasFocus = 0x00000100 , State_Top = 0x00000200 , State_Bottom = 0x00000400 ,
  State_FocusAtBorder = 0x00000800 , State_AutoRaise = 0x00001000 , State_MouseOver = 0x00002000 , State_UpArrow = 0x00004000 ,
  State_Selected = 0x00008000 , State_Active = 0x00010000 , State_Window = 0x00020000 , State_Open = 0x00040000 ,
  State_Children = 0x00080000 , State_Item = 0x00100000 , State_Sibling = 0x00200000 , State_KeyboardFocusChange = 0x00800000 ,
  State_ReadOnly = 0x02000000 , State_Small = 0x04000000 , State_Mini = 0x08000000
}
 This enum describes flags that are used when drawing primitive elements. More...
enum  PrimitiveElement {
  PE_Frame , PE_FrameDefaultButton , PE_FrameDockWidget , PE_FrameFocusRect ,
  PE_FrameGroupBox , PE_FrameLineEdit , PE_FrameMenu , PE_FrameStatusBarItem ,
  PE_FrameTabWidget , PE_FrameWindow , PE_FrameButtonBevel , PE_FrameButtonTool ,
  PE_FrameTabBarBase , PE_PanelButtonCommand , PE_PanelButtonBevel , PE_PanelButtonTool ,
  PE_PanelMenuBar , PE_PanelToolBar , PE_PanelLineEdit , PE_IndicatorArrowDown ,
  PE_IndicatorArrowLeft , PE_IndicatorArrowRight , PE_IndicatorArrowUp , PE_IndicatorBranch ,
  PE_IndicatorButtonDropDown , PE_IndicatorItemViewItemCheck , PE_IndicatorCheckBox , PE_IndicatorDockWidgetResizeHandle ,
  PE_IndicatorHeaderArrow , PE_IndicatorMenuCheckMark , PE_IndicatorProgressChunk , PE_IndicatorRadioButton ,
  PE_IndicatorSpinDown , PE_IndicatorSpinMinus , PE_IndicatorSpinPlus , PE_IndicatorSpinUp ,
  PE_IndicatorToolBarHandle , PE_IndicatorToolBarSeparator , PE_PanelTipLabel , PE_IndicatorTabTear ,
  PE_IndicatorTabTearLeft = PE_IndicatorTabTear , PE_PanelScrollAreaCorner , PE_Widget , PE_IndicatorColumnViewArrow ,
  PE_IndicatorItemViewItemDrop , PE_PanelItemViewItem , PE_PanelItemViewRow , PE_PanelStatusBar ,
  PE_IndicatorTabClose , PE_PanelMenu , PE_IndicatorTabTearRight , PE_CustomBase = 0xf000000
}
 This enum describes the various primitive elements. More...
enum  ControlElement {
  CE_PushButton , CE_PushButtonBevel , CE_PushButtonLabel , CE_CheckBox ,
  CE_CheckBoxLabel , CE_RadioButton , CE_RadioButtonLabel , CE_TabBarTab ,
  CE_TabBarTabShape , CE_TabBarTabLabel , CE_ProgressBar , CE_ProgressBarGroove ,
  CE_ProgressBarContents , CE_ProgressBarLabel , CE_MenuItem , CE_MenuScroller ,
  CE_MenuVMargin , CE_MenuHMargin , CE_MenuTearoff , CE_MenuEmptyArea ,
  CE_MenuBarItem , CE_MenuBarEmptyArea , CE_ToolButtonLabel , CE_Header ,
  CE_HeaderSection , CE_HeaderLabel , CE_ToolBoxTab , CE_SizeGrip ,
  CE_Splitter , CE_RubberBand , CE_DockWidgetTitle , CE_ScrollBarAddLine ,
  CE_ScrollBarSubLine , CE_ScrollBarAddPage , CE_ScrollBarSubPage , CE_ScrollBarSlider ,
  CE_ScrollBarFirst , CE_ScrollBarLast , CE_FocusFrame , CE_ComboBoxLabel ,
  CE_ToolBar , CE_ToolBoxTabShape , CE_ToolBoxTabLabel , CE_HeaderEmptyArea ,
  CE_ColumnViewGrip , CE_ItemViewItem , CE_ShapedFrame , CE_CustomBase = 0xf0000000
}
 This enum represents a control element. More...
enum  SubElement {
  SE_PushButtonContents , SE_PushButtonFocusRect , SE_CheckBoxIndicator , SE_CheckBoxContents ,
  SE_CheckBoxFocusRect , SE_CheckBoxClickRect , SE_RadioButtonIndicator , SE_RadioButtonContents ,
  SE_RadioButtonFocusRect , SE_RadioButtonClickRect , SE_ComboBoxFocusRect , SE_SliderFocusRect ,
  SE_ProgressBarGroove , SE_ProgressBarContents , SE_ProgressBarLabel , SE_ToolBoxTabContents ,
  SE_HeaderLabel , SE_HeaderArrow , SE_TabWidgetTabBar , SE_TabWidgetTabPane ,
  SE_TabWidgetTabContents , SE_TabWidgetLeftCorner , SE_TabWidgetRightCorner , SE_ItemViewItemCheckIndicator ,
  SE_TabBarTearIndicator , SE_TabBarTearIndicatorLeft = SE_TabBarTearIndicator , SE_TreeViewDisclosureItem , SE_LineEditContents ,
  SE_FrameContents , SE_DockWidgetCloseButton , SE_DockWidgetFloatButton , SE_DockWidgetTitleBarText ,
  SE_DockWidgetIcon , SE_CheckBoxLayoutItem , SE_ComboBoxLayoutItem , SE_DateTimeEditLayoutItem ,
  SE_LabelLayoutItem , SE_ProgressBarLayoutItem , SE_PushButtonLayoutItem , SE_RadioButtonLayoutItem ,
  SE_SliderLayoutItem , SE_SpinBoxLayoutItem , SE_ToolButtonLayoutItem , SE_FrameLayoutItem ,
  SE_GroupBoxLayoutItem , SE_TabWidgetLayoutItem , SE_ItemViewItemDecoration , SE_ItemViewItemText ,
  SE_ItemViewItemFocusRect , SE_TabBarTabLeftButton , SE_TabBarTabRightButton , SE_TabBarTabText ,
  SE_ShapedFrameContents , SE_ToolBarHandle , SE_TabBarScrollLeftButton , SE_TabBarScrollRightButton ,
  SE_TabBarTearIndicatorRight , SE_PushButtonBevel , SE_CustomBase = 0xf0000000
}
 This enum represents a sub-area of a widget. More...
enum  ComplexControl {
  CC_SpinBox , CC_ComboBox , CC_ScrollBar , CC_Slider ,
  CC_ToolButton , CC_TitleBar , CC_Dial , CC_GroupBox ,
  CC_MdiControls , CC_CustomBase = 0xf0000000
}
 This enum describes the available complex controls. More...
enum  SubControl {
  SC_None = 0x00000000 , SC_ScrollBarAddLine = 0x00000001 , SC_ScrollBarSubLine = 0x00000002 , SC_ScrollBarAddPage = 0x00000004 ,
  SC_ScrollBarSubPage = 0x00000008 , SC_ScrollBarFirst = 0x00000010 , SC_ScrollBarLast = 0x00000020 , SC_ScrollBarSlider = 0x00000040 ,
  SC_ScrollBarGroove = 0x00000080 , SC_SpinBoxUp = 0x00000001 , SC_SpinBoxDown = 0x00000002 , SC_SpinBoxFrame = 0x00000004 ,
  SC_SpinBoxEditField = 0x00000008 , SC_ComboBoxFrame = 0x00000001 , SC_ComboBoxEditField = 0x00000002 , SC_ComboBoxArrow = 0x00000004 ,
  SC_ComboBoxListBoxPopup = 0x00000008 , SC_SliderGroove = 0x00000001 , SC_SliderHandle = 0x00000002 , SC_SliderTickmarks = 0x00000004 ,
  SC_ToolButton = 0x00000001 , SC_ToolButtonMenu = 0x00000002 , SC_TitleBarSysMenu = 0x00000001 , SC_TitleBarMinButton = 0x00000002 ,
  SC_TitleBarMaxButton = 0x00000004 , SC_TitleBarCloseButton = 0x00000008 , SC_TitleBarNormalButton = 0x00000010 , SC_TitleBarShadeButton = 0x00000020 ,
  SC_TitleBarUnshadeButton = 0x00000040 , SC_TitleBarContextHelpButton = 0x00000080 , SC_TitleBarLabel = 0x00000100 , SC_DialGroove = 0x00000001 ,
  SC_DialHandle = 0x00000002 , SC_DialTickmarks = 0x00000004 , SC_GroupBoxCheckBox = 0x00000001 , SC_GroupBoxLabel = 0x00000002 ,
  SC_GroupBoxContents = 0x00000004 , SC_GroupBoxFrame = 0x00000008 , SC_MdiMinButton = 0x00000001 , SC_MdiNormalButton = 0x00000002 ,
  SC_MdiCloseButton = 0x00000004 , SC_CustomBase = 0xf0000000 , SC_All = 0xffffffff
}
 This enum describes the available sub controls. More...
enum  PixelMetric {
  PM_ButtonMargin , PM_ButtonDefaultIndicator , PM_MenuButtonIndicator , PM_ButtonShiftHorizontal ,
  PM_ButtonShiftVertical , PM_DefaultFrameWidth , PM_SpinBoxFrameWidth , PM_ComboBoxFrameWidth ,
  PM_MaximumDragDistance , PM_ScrollBarExtent , PM_ScrollBarSliderMin , PM_SliderThickness ,
  PM_SliderControlThickness , PM_SliderLength , PM_SliderTickmarkOffset , PM_SliderSpaceAvailable ,
  PM_DockWidgetSeparatorExtent , PM_DockWidgetHandleExtent , PM_DockWidgetFrameWidth , PM_TabBarTabOverlap ,
  PM_TabBarTabHSpace , PM_TabBarTabVSpace , PM_TabBarBaseHeight , PM_TabBarBaseOverlap ,
  PM_ProgressBarChunkWidth , PM_SplitterWidth , PM_TitleBarHeight , PM_MenuScrollerHeight ,
  PM_MenuHMargin , PM_MenuVMargin , PM_MenuPanelWidth , PM_MenuTearoffHeight ,
  PM_MenuDesktopFrameWidth , PM_MenuBarPanelWidth , PM_MenuBarItemSpacing , PM_MenuBarVMargin ,
  PM_MenuBarHMargin , PM_IndicatorWidth , PM_IndicatorHeight , PM_ExclusiveIndicatorWidth ,
  PM_ExclusiveIndicatorHeight , PM_MdiSubWindowFrameWidth = 44 , PM_MdiSubWindowMinimizedWidth , PM_HeaderMargin ,
  PM_HeaderMarkSize , PM_HeaderGripMargin , PM_TabBarTabShiftHorizontal , PM_TabBarTabShiftVertical ,
  PM_TabBarScrollButtonWidth , PM_ToolBarFrameWidth , PM_ToolBarHandleExtent , PM_ToolBarItemSpacing ,
  PM_ToolBarItemMargin , PM_ToolBarSeparatorExtent , PM_ToolBarExtensionExtent , PM_SpinBoxSliderHeight ,
  PM_ToolBarIconSize , PM_ListViewIconSize , PM_IconViewIconSize , PM_SmallIconSize ,
  PM_LargeIconSize , PM_FocusFrameVMargin , PM_FocusFrameHMargin , PM_ToolTipLabelFrameWidth ,
  PM_CheckBoxLabelSpacing , PM_TabBarIconSize , PM_SizeGripSize , PM_DockWidgetTitleMargin ,
  PM_MessageBoxIconSize , PM_ButtonIconSize , PM_DockWidgetTitleBarButtonMargin , PM_RadioButtonLabelSpacing ,
  PM_LayoutLeftMargin , PM_LayoutTopMargin , PM_LayoutRightMargin , PM_LayoutBottomMargin ,
  PM_LayoutHorizontalSpacing , PM_LayoutVerticalSpacing , PM_TabBar_ScrollButtonOverlap , PM_TextCursorWidth ,
  PM_TabCloseIndicatorWidth , PM_TabCloseIndicatorHeight , PM_ScrollView_ScrollBarSpacing , PM_ScrollView_ScrollBarOverlap ,
  PM_SubMenuOverlap , PM_TreeViewIndentation , PM_HeaderDefaultSectionSizeHorizontal , PM_HeaderDefaultSectionSizeVertical ,
  PM_TitleBarButtonIconSize , PM_TitleBarButtonSize , PM_LineEditIconSize , PM_LineEditIconMargin ,
  PM_CustomBase = 0xf0000000
}
 This enum describes the various available pixel metrics. More...
enum  ContentsType {
  CT_PushButton , CT_CheckBox , CT_RadioButton , CT_ToolButton ,
  CT_ComboBox , CT_Splitter , CT_ProgressBar , CT_MenuItem ,
  CT_MenuBarItem , CT_MenuBar , CT_Menu , CT_TabBarTab ,
  CT_Slider , CT_ScrollBar , CT_LineEdit , CT_SpinBox ,
  CT_SizeGrip , CT_TabWidget , CT_DialogButtons , CT_HeaderSection ,
  CT_GroupBox , CT_MdiControls , CT_ItemViewItem , CT_CustomBase = 0xf0000000
}
 This enum describes the available contents types. More...
enum  RequestSoftwareInputPanel { RSIP_OnMouseClickAndAlreadyFocused , RSIP_OnMouseClick }
 This enum describes under what circumstances a software input panel will be requested by input capable widgets. More...
enum  StyleHint {
  SH_EtchDisabledText , SH_DitherDisabledText , SH_ScrollBar_MiddleClickAbsolutePosition , SH_ScrollBar_ScrollWhenPointerLeavesControl ,
  SH_TabBar_SelectMouseType , SH_TabBar_Alignment , SH_Header_ArrowAlignment , SH_Slider_SnapToValue ,
  SH_Slider_SloppyKeyEvents , SH_ProgressDialog_CenterCancelButton , SH_ProgressDialog_TextLabelAlignment , SH_PrintDialog_RightAlignButtons ,
  SH_MainWindow_SpaceBelowMenuBar , SH_FontDialog_SelectAssociatedText , SH_Menu_AllowActiveAndDisabled , SH_Menu_SpaceActivatesItem ,
  SH_Menu_SubMenuPopupDelay , SH_ScrollView_FrameOnlyAroundContents , SH_MenuBar_AltKeyNavigation , SH_ComboBox_ListMouseTracking ,
  SH_ComboBox_ListMouseTracking_Current = SH_ComboBox_ListMouseTracking , SH_Menu_MouseTracking , SH_MenuBar_MouseTracking , SH_ItemView_ChangeHighlightOnFocus ,
  SH_Widget_ShareActivation , SH_Workspace_FillSpaceOnMaximize , SH_ComboBox_Popup , SH_TitleBar_NoBorder ,
  SH_Slider_StopMouseOverSlider , SH_BlinkCursorWhenTextSelected , SH_RichText_FullWidthSelection , SH_Menu_Scrollable ,
  SH_GroupBox_TextLabelVerticalAlignment , SH_GroupBox_TextLabelColor , SH_Menu_SloppySubMenus , SH_Table_GridLineColor ,
  SH_LineEdit_PasswordCharacter , SH_DialogButtons_DefaultButton , SH_ToolBox_SelectedPageTitleBold , SH_TabBar_PreferNoArrows ,
  SH_ScrollBar_LeftClickAbsolutePosition , SH_ListViewExpand_SelectMouseType , SH_UnderlineShortcut , SH_SpinBox_AnimateButton ,
  SH_SpinBox_KeyPressAutoRepeatRate , SH_SpinBox_ClickAutoRepeatRate , SH_Menu_FillScreenWithScroll , SH_ToolTipLabel_Opacity ,
  SH_DrawMenuBarSeparator , SH_TitleBar_ModifyNotification , SH_Button_FocusPolicy , SH_MessageBox_UseBorderForButtonSpacing ,
  SH_TitleBar_AutoRaise , SH_ToolButton_PopupDelay , SH_FocusFrame_Mask , SH_RubberBand_Mask ,
  SH_WindowFrame_Mask , SH_SpinControls_DisableOnBounds , SH_Dial_BackgroundRole , SH_ComboBox_LayoutDirection ,
  SH_ItemView_EllipsisLocation , SH_ItemView_ShowDecorationSelected , SH_ItemView_ActivateItemOnSingleClick , SH_ScrollBar_ContextMenu ,
  SH_ScrollBar_RollBetweenButtons , SH_Slider_AbsoluteSetButtons , SH_Slider_PageSetButtons , SH_Menu_KeyboardSearch ,
  SH_TabBar_ElideMode , SH_DialogButtonLayout , SH_ComboBox_PopupFrameStyle , SH_MessageBox_TextInteractionFlags ,
  SH_DialogButtonBox_ButtonsHaveIcons , SH_MessageBox_CenterButtons , SH_Menu_SelectionWrap , SH_ItemView_MovementWithoutUpdatingSelection ,
  SH_ToolTip_Mask , SH_FocusFrame_AboveWidget , SH_TextControl_FocusIndicatorTextCharFormat , SH_WizardStyle ,
  SH_ItemView_ArrowKeysNavigateIntoChildren , SH_Menu_Mask , SH_Menu_FlashTriggeredItem , SH_Menu_FadeOutOnHide ,
  SH_SpinBox_ClickAutoRepeatThreshold , SH_ItemView_PaintAlternatingRowColorsForEmptyArea , SH_FormLayoutWrapPolicy , SH_TabWidget_DefaultTabPosition ,
  SH_ToolBar_Movable , SH_FormLayoutFieldGrowthPolicy , SH_FormLayoutFormAlignment , SH_FormLayoutLabelAlignment ,
  SH_ItemView_DrawDelegateFrame , SH_TabBar_CloseButtonPosition , SH_DockWidget_ButtonsHaveFrame , SH_ToolButtonStyle ,
  SH_RequestSoftwareInputPanel , SH_ScrollBar_Transient , SH_Menu_SupportsSections , SH_ToolTip_WakeUpDelay ,
  SH_ToolTip_FallAsleepDelay , SH_Widget_Animate , SH_Splitter_OpaqueResize , SH_ComboBox_UseNativePopup ,
  SH_LineEdit_PasswordMaskDelay , SH_TabBar_ChangeCurrentDelay , SH_Menu_SubMenuUniDirection , SH_Menu_SubMenuUniDirectionFailCount ,
  SH_Menu_SubMenuSloppySelectOtherActions , SH_Menu_SubMenuSloppyCloseTimeout , SH_Menu_SubMenuResetWhenReenteringParent , SH_Menu_SubMenuDontStartSloppyOnLeave ,
  SH_ItemView_ScrollMode , SH_TitleBar_ShowToolTipsOnButtons , SH_Widget_Animation_Duration , SH_ComboBox_AllowWheelScrolling ,
  SH_SpinBox_ButtonsInsideFrame , SH_SpinBox_StepModifier , SH_TabBar_AllowWheelScrolling , SH_Table_AlwaysDrawLeftTopGridLines ,
  SH_SpinBox_SelectOnStep , SH_ComboBox_ListMouseTracking_Active , SH_CustomBase = 0xf0000000
}
 This enum describes the available style hints. More...
enum  StandardPixmap {
  SP_TitleBarMenuButton , SP_TitleBarMinButton , SP_TitleBarMaxButton , SP_TitleBarCloseButton ,
  SP_TitleBarNormalButton , SP_TitleBarShadeButton , SP_TitleBarUnshadeButton , SP_TitleBarContextHelpButton ,
  SP_DockWidgetCloseButton , SP_MessageBoxInformation , SP_MessageBoxWarning , SP_MessageBoxCritical ,
  SP_MessageBoxQuestion , SP_DesktopIcon , SP_TrashIcon , SP_ComputerIcon ,
  SP_DriveFDIcon , SP_DriveHDIcon , SP_DriveCDIcon , SP_DriveDVDIcon ,
  SP_DriveNetIcon , SP_DirOpenIcon , SP_DirClosedIcon , SP_DirLinkIcon ,
  SP_DirLinkOpenIcon , SP_FileIcon , SP_FileLinkIcon , SP_ToolBarHorizontalExtensionButton ,
  SP_ToolBarVerticalExtensionButton , SP_FileDialogStart , SP_FileDialogEnd , SP_FileDialogToParent ,
  SP_FileDialogNewFolder , SP_FileDialogDetailedView , SP_FileDialogInfoView , SP_FileDialogContentsView ,
  SP_FileDialogListView , SP_FileDialogBack , SP_DirIcon , SP_DialogOkButton ,
  SP_DialogCancelButton , SP_DialogHelpButton , SP_DialogOpenButton , SP_DialogSaveButton ,
  SP_DialogCloseButton , SP_DialogApplyButton , SP_DialogResetButton , SP_DialogDiscardButton ,
  SP_DialogYesButton , SP_DialogNoButton , SP_ArrowUp , SP_ArrowDown ,
  SP_ArrowLeft , SP_ArrowRight , SP_ArrowBack , SP_ArrowForward ,
  SP_DirHomeIcon , SP_CommandLink , SP_VistaShield , SP_BrowserReload ,
  SP_BrowserStop , SP_MediaPlay , SP_MediaStop , SP_MediaPause ,
  SP_MediaSkipForward , SP_MediaSkipBackward , SP_MediaSeekForward , SP_MediaSeekBackward ,
  SP_MediaVolume , SP_MediaVolumeMuted , SP_LineEditClearButton , SP_DialogYesToAllButton ,
  SP_DialogNoToAllButton , SP_DialogSaveAllButton , SP_DialogAbortButton , SP_DialogRetryButton ,
  SP_DialogIgnoreButton , SP_RestoreDefaultsButton , SP_TabCloseButton , SP_TabScrollLeftButton ,
  SP_TabScrollRightButton , SP_TabScrollUpButton , SP_TabScrollDownButton , NStandardPixmap ,
  SP_CustomBase = 0xf0000000
}
 This enum describes the available standard pixmaps. More...
Public Slots inherited from QObject
void deleteLater ()
 \threadsafe
Static Public Member Functions inherited from QStyle
static QRect visualRect (Qt::LayoutDirection direction, const QRect &boundingRect, const QRect &logicalRect)
 Returns the given logicalRectangle converted to screen coordinates based on the specified direction.
static QPoint visualPos (Qt::LayoutDirection direction, const QRect &boundingRect, const QPoint &logicalPos)
 Returns the given logicalPosition converted to screen coordinates based on the specified direction.
static int sliderPositionFromValue (int min, int max, int val, int space, bool upsideDown=false)
 Converts the given logicalValue to a pixel position.
static int sliderValueFromPosition (int min, int max, int pos, int space, bool upsideDown=false)
 Converts the given pixel position to a logical value.
static Qt::Alignment visualAlignment (Qt::LayoutDirection direction, Qt::Alignment alignment)
 Transforms an alignment of Qt::AlignLeft or Qt::AlignRight without Qt::AlignAbsolute into Qt::AlignLeft or Qt::AlignRight with Qt::AlignAbsolute according to the layout direction.
static QRect alignedRect (Qt::LayoutDirection direction, Qt::Alignment alignment, const QSize &size, const QRect &rectangle)
 Returns a new rectangle of the specified size that is aligned to the given rectangle according to the specified alignment and direction.
Static Public Member Functions inherited from QObject
static QMetaObject::Connection connect (const QObject *sender, const char *signal, const QObject *receiver, const char *member, Qt::ConnectionType=Qt::AutoConnection)
 \threadsafe
static QMetaObject::Connection connect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method, Qt::ConnectionType type=Qt::AutoConnection)
template<typename Func1, typename Func2>
static QMetaObject::Connection connect (const typename QtPrivate::FunctionPointer< Func1 >::Object *sender, Func1 signal, const typename QtPrivate::ContextTypeForFunctor< Func2 >::ContextType *context, Func2 &&slot, Qt::ConnectionType type=Qt::AutoConnection)
template<typename Func1, typename Func2>
static QMetaObject::Connection connect (const typename QtPrivate::FunctionPointer< Func1 >::Object *sender, Func1 signal, Func2 &&slot)
static bool disconnect (const QObject *sender, const char *signal, const QObject *receiver, const char *member)
 \threadsafe
static bool disconnect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &member)
static bool disconnect (const QMetaObject::Connection &)
 Disconnects connection and resets it to \l{QMetaObject::Connection::operator bool()}{invalid}.
static bool disconnect (QMetaObject::Connection &)
static bool disconnect (QMetaObject::Connection &&conn)
 Disconnect a connection.
template<typename Func1, typename Func2>
static bool disconnect (const typename QtPrivate::FunctionPointer< Func1 >::Object *sender, Func1 signal, const typename QtPrivate::FunctionPointer< Func2 >::Object *receiver, Func2 slot)
template<typename Func1>
static bool disconnect (const typename QtPrivate::FunctionPointer< Func1 >::Object *sender, Func1 signal, const QObject *receiver, void **zero)
Protected Attributes inherited from QObject
QScopedPointer< QObjectData > d_ptr
Related Symbols inherited from QObject
 Returns the given object cast to type T if the object is of type T (or of a subclass); otherwise returns \nullptr.
 \macro Q_CLASSINFO(Name, Value)

Detailed Description

\inmodule QtLabsStyleKit

Since
6.12

The QStyleKitStyle class applies a \l {Qt Labs StyleKit} style to Qt Widgets.

QStyleKitStyle is a QStyle implementation that uses a \l StyleKit \l Style to style Qt Widgets. The \l Style is a QML file that declaratively describes the visual design (colors, sizes, radii, borders, and other properties) for each widget type and state. Those property values drive the painting, which is done entirely with QPainter. Qt Quick and the scene graph play no part in the rendering.

This separation means the same \l Style QML file can drive both Qt Quick Controls and Qt Widgets, sharing one design definition across both systems.

Note
StyleKit is a Qt Labs module, and its API may change between Qt releases.

Definition at line 14 of file qstylekitstyle.h.

Constructor & Destructor Documentation

◆ QStyleKitStyle() [1/2]

QStyleKitStyle::QStyleKitStyle ( )

Constructs a QStyleKitStyle with no style loaded.

Use \l setStylePath() to load a QML \l Style after construction. Until a Style loads successfully, the widgets use an empty fallback style.

Definition at line 1610 of file qstylekitstyle.cpp.

◆ QStyleKitStyle() [2/2]

QStyleKitStyle::QStyleKitStyle ( const QString & filePath)
explicit

Constructs a QStyleKitStyle and loads the QML \l Style at filePath.

See the \l stylePath property for the accepted path forms.

If the path is invalid or the root object of the loaded component is not a \l Style, QStyleKitStyle emits a warning and the widgets use an empty fallback style until a valid \l stylePath is set.

Definition at line 1623 of file qstylekitstyle.cpp.

◆ ~QStyleKitStyle()

QStyleKitStyle::~QStyleKitStyle ( )
override

Destroys the QStyleKitStyle.

Definition at line 1637 of file qstylekitstyle.cpp.

Member Function Documentation

◆ availableThemeNames()

QStringList QStyleKitStyle::availableThemeNames ( ) const

Returns the names of all themes that the loaded \l Style exposes.

The list always includes System, and includes Light and Dark when the Style defines those themes, together with any custom themes that the style author defines. Returns an empty list when no style is loaded.

See also
customThemeNames(), themeName()

Definition at line 1741 of file qstylekitstyle.cpp.

◆ availableThemeNamesChanged

void QStyleKitStyle::availableThemeNamesChanged ( const QStringList & availableThemeNames)
signal

◆ customThemeNames()

QStringList QStyleKitStyle::customThemeNames ( ) const

Returns the names of the custom themes defined by the loaded \l Style, excluding the built-in Light and Dark themes.

Returns an empty list when no style is loaded.

See also
availableThemeNames()

Definition at line 1754 of file qstylekitstyle.cpp.

◆ customThemeNamesChanged

void QStyleKitStyle::customThemeNamesChanged ( const QStringList & customThemeNames)
signal

◆ drawComplexControl()

void QStyleKitStyle::drawComplexControl ( ComplexControl cc,
const QStyleOptionComplex * opt,
QPainter * p,
const QWidget * w = nullptr ) const
overridevirtual

\reimp

Reimplemented from QCommonStyle.

Definition at line 3055 of file qstylekitstyle.cpp.

◆ drawControl()

void QStyleKitStyle::drawControl ( ControlElement element,
const QStyleOption * opt,
QPainter * p,
const QWidget * w = nullptr ) const
overridevirtual

\reimp

Reimplemented from QCommonStyle.

Definition at line 1994 of file qstylekitstyle.cpp.

◆ drawPrimitive()

void QStyleKitStyle::drawPrimitive ( PrimitiveElement pe,
const QStyleOption * opt,
QPainter * p,
const QWidget * w = nullptr ) const
overridevirtual

\reimp

Reimplemented from QCommonStyle.

Definition at line 1761 of file qstylekitstyle.cpp.

◆ event()

bool QStyleKitStyle::event ( QEvent * event)
overrideprotectedvirtual

\reimp

Reimplemented from QObject.

Definition at line 4496 of file qstylekitstyle.cpp.

◆ eventFilter()

bool QStyleKitStyle::eventFilter ( QObject * watched,
QEvent * event )
overrideprotectedvirtual

\reimp

Reimplemented from QObject.

Definition at line 4467 of file qstylekitstyle.cpp.

◆ hitTestComplexControl()

QStyle::SubControl QStyleKitStyle::hitTestComplexControl ( ComplexControl cc,
const QStyleOptionComplex * opt,
const QPoint & pt,
const QWidget * w = nullptr ) const
overridevirtual

\reimp

Reimplemented from QCommonStyle.

Definition at line 3322 of file qstylekitstyle.cpp.

◆ pixelMetric()

int QStyleKitStyle::pixelMetric ( PixelMetric m,
const QStyleOption * opt = nullptr,
const QWidget * widget = nullptr ) const
overridevirtual

\reimp

Reimplemented from QCommonStyle.

Definition at line 4172 of file qstylekitstyle.cpp.

◆ polish() [1/3]

void QStyleKitStyle::polish ( QApplication * application)
overridevirtual

\reimp

Reimplemented from QCommonStyle.

Definition at line 4414 of file qstylekitstyle.cpp.

◆ polish() [2/3]

void QStyleKitStyle::polish ( QPalette & palette)
overridevirtual

\reimp

Reimplemented from QCommonStyle.

Definition at line 4420 of file qstylekitstyle.cpp.

◆ polish() [3/3]

void QStyleKitStyle::polish ( QWidget * widget)
overridevirtual

\reimp

Reimplemented from QCommonStyle.

Definition at line 4285 of file qstylekitstyle.cpp.

◆ setStylePath()

void QStyleKitStyle::setStylePath ( const QString & filePath)

Loads the QML \l Style at filePath and applies it to all widgets.

filePath is a path to a local file or a path to a file in the resource file system; see the \l stylePath property for the accepted forms. If it is the same as the current \l stylePath, this function does nothing.

If the new style does not load, QStyleKitStyle emits a warning, keeps the previously loaded style active, and does not emit \l stylePathChanged().

See also
stylePath()

Definition at line 1664 of file qstylekitstyle.cpp.

◆ setThemeName()

void QStyleKitStyle::setThemeName ( const QString & themeName)

Activates the theme named themeName.

themeName must be one of the entries in \l availableThemeNames(), which includes the special name System for following the platform color scheme. The comparison ignores case.

If no \l Style is loaded, this function emits a warning and returns without changing the active theme. If a Style is loaded but themeName matches none of its themes, the Style emits a warning and applies no theme.

See also
themeName(), availableThemeNames()

Definition at line 1718 of file qstylekitstyle.cpp.

◆ sizeFromContents()

QSize QStyleKitStyle::sizeFromContents ( ContentsType ct,
const QStyleOption * opt,
const QSize & contentsSize,
const QWidget * widget = nullptr ) const
overridevirtual

\reimp

Reimplemented from QCommonStyle.

Definition at line 3768 of file qstylekitstyle.cpp.

◆ standardPalette()

QPalette QStyleKitStyle::standardPalette ( ) const
overridevirtual

\reimp

Reimplemented from QStyle.

Definition at line 4279 of file qstylekitstyle.cpp.

◆ styleHint()

int QStyleKitStyle::styleHint ( StyleHint sh,
const QStyleOption * opt = nullptr,
const QWidget * w = nullptr,
QStyleHintReturn * shret = nullptr ) const
overridevirtual

\reimp

Reimplemented from QCommonStyle.

Definition at line 4259 of file qstylekitstyle.cpp.

◆ stylePath()

QString QStyleKitStyle::stylePath ( ) const

Returns the path most recently set for the QML \l Style file.

See also
setStylePath()

Definition at line 1646 of file qstylekitstyle.cpp.

◆ stylePathChanged

void QStyleKitStyle::stylePathChanged ( const QString & stylePath)
signal

◆ subControlRect()

QRect QStyleKitStyle::subControlRect ( ComplexControl cc,
const QStyleOptionComplex * opt,
SubControl sc,
const QWidget * w = nullptr ) const
overridevirtual

\reimp

Reimplemented from QCommonStyle.

Definition at line 3330 of file qstylekitstyle.cpp.

◆ subElementRect()

QRect QStyleKitStyle::subElementRect ( SubElement r,
const QStyleOption * opt,
const QWidget * widget = nullptr ) const
overridevirtual

\reimp

Reimplemented from QCommonStyle.

Definition at line 2639 of file qstylekitstyle.cpp.

◆ themeName()

QString QStyleKitStyle::themeName ( ) const

Returns the name of the requested theme, or an empty string when no \l Style is loaded.

When the theme name is System, this function returns System rather than the Light or Dark theme that the platform color scheme resolves to.

See also
setThemeName(), availableThemeNames()

Definition at line 1698 of file qstylekitstyle.cpp.

◆ themeNameChanged

void QStyleKitStyle::themeNameChanged ( const QString & themeName)
signal

◆ unpolish() [1/2]

void QStyleKitStyle::unpolish ( QApplication * application)
overridevirtual

\reimp

Reimplemented from QCommonStyle.

Definition at line 4459 of file qstylekitstyle.cpp.

◆ unpolish() [2/2]

void QStyleKitStyle::unpolish ( QWidget * widget)
overridevirtual

\reimp

Reimplemented from QCommonStyle.

Definition at line 4426 of file qstylekitstyle.cpp.

Property Documentation

◆ availableThemeNames

QStringList QStyleKitStyle::availableThemeNames
read

the list of theme names exposed by the loaded \l Style.

This list always includes System, which follows the platform color scheme. It also includes Light and Dark when the \l Style defines those themes, together with any custom themes that the style author defines. The list is empty when no style is loaded.

Definition at line 19 of file qstylekitstyle.h.

◆ customThemeNames

QStringList QStyleKitStyle::customThemeNames
read

the list of custom theme names defined by the loaded \l Style.

Unlike \l availableThemeNames, this list excludes System, Light, and Dark, and contains only the themes that the style author defines explicitly. The list is empty when no style is loaded.

See also
availableThemeNames, themeName

Definition at line 20 of file qstylekitstyle.h.

◆ stylePath

QString QStyleKitStyle::stylePath
readwrite

the path to the QML \l Style file driving this style.

The value is a path to a local file or to a file in the resource file system, (for example, {:/styles/MyStyle.qml} or {qrc:/qt/qml/MyQmlModule/Style.qml}). QStyleKitStyle resolves a relative path against the application's working directory. The file must contain a QML component whose root object is a \l Style. Setting this property reloads the style. If the new file does not load, QStyleKitStyle emits a warning and keeps the previously loaded style and style path.

Definition at line 17 of file qstylekitstyle.h.

◆ themeName

QString QStyleKitStyle::themeName
readwrite

the name of the active theme.

The value must be one of the entries in \l availableThemeNames. That list includes the special name System, which makes the style follow the platform color scheme. The comparison ignores case.

Setting this property repolishes all widgets so that they repaint with the new theme. If the name matches no theme, the \l Style emits a warning and applies no theme.

Definition at line 18 of file qstylekitstyle.h.

The documentation for this class was generated from the following files: