QStyle Class

The QStyle class is an abstract base class that encapsulates the look and feel of a GUI. More...

Header: #include <QStyle>
qmake: QT += widgets
Inherits: QObject
Inherited By:

QCommonStyle

Public Types

enum ComplexControl { CC_SpinBox, CC_ComboBox, CC_ScrollBar, CC_Slider, CC_ToolButton, …, CC_CustomBase }
enum ContentsType { CT_CheckBox, CT_ComboBox, CT_HeaderSection, CT_LineEdit, CT_Menu, …, CT_MdiControls }
enum ControlElement { CE_PushButton, CE_PushButtonBevel, CE_PushButtonLabel, CE_DockWidgetTitle, CE_Splitter, …, CE_ShapedFrame }
enum PixelMetric { PM_ButtonMargin, PM_DockWidgetTitleBarButtonMargin, PM_ButtonDefaultIndicator, PM_MenuButtonIndicator, PM_ButtonShiftHorizontal, …, PM_DefaultLayoutSpacing }
enum PrimitiveElement { PE_FrameStatusBar, PE_PanelButtonCommand, PE_FrameDefaultButton, PE_PanelButtonBevel, PE_PanelButtonTool, …, PE_PanelMenu }
enum RequestSoftwareInputPanel { RSIP_OnMouseClickAndAlreadyFocused, RSIP_OnMouseClick }
enum StandardPixmap { SP_TitleBarMinButton, SP_TitleBarMenuButton, SP_TitleBarMaxButton, SP_TitleBarCloseButton, SP_TitleBarNormalButton, …, SP_CustomBase }
flags State
enum StateFlag { State_None, State_Active, State_AutoRaise, State_Children, State_DownArrow, …, State_Small }
enum StyleHint { SH_EtchDisabledText, SH_DitherDisabledText, SH_ScrollBar_ContextMenu, SH_ScrollBar_MiddleClickAbsolutePosition, SH_ScrollBar_LeftClickAbsolutePosition, …, SH_SpinBox_StepModifier }
enum SubControl { SC_None, SC_ScrollBarAddLine, SC_ScrollBarSubLine, SC_ScrollBarAddPage, SC_ScrollBarSubPage, …, SC_All }
flags SubControls
enum SubElement { SE_PushButtonContents, SE_PushButtonFocusRect, SE_PushButtonLayoutItem, SE_PushButtonBevel, SE_CheckBoxIndicator, …, SE_ToolBarHandle }

Public Functions

QStyle()
virtual ~QStyle()
int combinedLayoutSpacing(QSizePolicy::ControlTypes controls1, QSizePolicy::ControlTypes controls2, Qt::Orientation orientation, QStyleOption *option = nullptr, QWidget *widget = nullptr) const
virtual void drawComplexControl(QStyle::ComplexControl control, const QStyleOptionComplex *option, QPainter *painter, const QWidget *widget = nullptr) const = 0
virtual void drawControl(QStyle::ControlElement element, const QStyleOption *option, QPainter *painter, const QWidget *widget = nullptr) const = 0
virtual void drawItemPixmap(QPainter *painter, const QRect &rectangle, int alignment, const QPixmap &pixmap) const
virtual void drawItemText(QPainter *painter, const QRect &rectangle, int alignment, const QPalette &palette, bool enabled, const QString &text, QPalette::ColorRole textRole = QPalette::NoRole) const
virtual void drawPrimitive(QStyle::PrimitiveElement element, const QStyleOption *option, QPainter *painter, const QWidget *widget = nullptr) const = 0
virtual QPixmap generatedIconPixmap(QIcon::Mode iconMode, const QPixmap &pixmap, const QStyleOption *option) const = 0
virtual QStyle::SubControl hitTestComplexControl(QStyle::ComplexControl control, const QStyleOptionComplex *option, const QPoint &position, const QWidget *widget = nullptr) const = 0
virtual QRect itemPixmapRect(const QRect &rectangle, int alignment, const QPixmap &pixmap) const
virtual QRect itemTextRect(const QFontMetrics &metrics, const QRect &rectangle, int alignment, bool enabled, const QString &text) const
virtual int layoutSpacing(QSizePolicy::ControlType control1, QSizePolicy::ControlType control2, Qt::Orientation orientation, const QStyleOption *option = nullptr, const QWidget *widget = nullptr) const = 0
virtual int pixelMetric(QStyle::PixelMetric metric, const QStyleOption *option = nullptr, const QWidget *widget = nullptr) const = 0
virtual void polish(QWidget *widget)
virtual void polish(QApplication *application)
virtual void polish(QPalette &palette)
const QStyle *proxy() const
virtual QSize sizeFromContents(QStyle::ContentsType type, const QStyleOption *option, const QSize &contentsSize, const QWidget *widget = nullptr) const = 0
virtual QIcon standardIcon(QStyle::StandardPixmap standardIcon, const QStyleOption *option = 0, const QWidget *widget = 0) const = 0
virtual QPalette standardPalette() const
virtual int styleHint(QStyle::StyleHint hint, const QStyleOption *option = nullptr, const QWidget *widget = nullptr, QStyleHintReturn *returnData = nullptr) const = 0
virtual QRect subControlRect(QStyle::ComplexControl control, const QStyleOptionComplex *option, QStyle::SubControl subControl, const QWidget *widget = nullptr) const = 0
virtual QRect subElementRect(QStyle::SubElement element, const QStyleOption *option, const QWidget *widget = nullptr) const = 0
virtual void unpolish(QWidget *widget)
virtual void unpolish(QApplication *application)

Static Public Members

QRect alignedRect(Qt::LayoutDirection direction, Qt::Alignment alignment, const QSize &size, const QRect &rectangle)
int sliderPositionFromValue(int min, int max, int logicalValue, int span, bool upsideDown = false)
int sliderValueFromPosition(int min, int max, int position, int span, bool upsideDown = false)
Qt::Alignment visualAlignment(Qt::LayoutDirection direction, Qt::Alignment alignment)
QPoint visualPos(Qt::LayoutDirection direction, const QRect &boundingRectangle, const QPoint &logicalPosition)
QRect visualRect(Qt::LayoutDirection direction, const QRect &boundingRectangle, const QRect &logicalRectangle)

Detailed Description

Qt contains a set of QStyle subclasses that emulate the styles of the different platforms supported by Qt (QWindowsStyle, QMacStyle etc.). By default, these styles are built into the Qt GUI module. Styles can also be made available as plugins.

Qt's built-in widgets use QStyle to perform nearly all of their drawing, ensuring that they look exactly like the equivalent native widgets. The diagram below shows a QComboBox in nine different styles.

Nine combo boxes

Topics:

Setting a Style

The style of the entire application can be set using the QApplication::setStyle() function. It can also be specified by the user of the application, using the -style command-line option:

./myapplication -style windows

If no style is specified, Qt will choose the most appropriate style for the user's platform or desktop environment.

A style can also be set on an individual widget using the QWidget::setStyle() function.

Developing Style-Aware Custom Widgets

If you are developing custom widgets and want them to look good on all platforms, you can use QStyle functions to perform parts of the widget drawing, such as drawItemText(), drawItemPixmap(), drawPrimitive(), drawControl(), and drawComplexControl().

Most QStyle draw functions take four arguments:

  • an enum value specifying which graphical element to draw
  • a QStyleOption specifying how and where to render that element
  • a QPainter that should be used to draw the element
  • a QWidget on which the drawing is performed (optional)

For example, if you want to draw a focus rectangle on your widget, you can write:

void MyWidget::paintEvent(QPaintEvent * /* event */)
{
    QPainter painter(this);

    QStyleOptionFocusRect option;
    option.initFrom(this);
    option.backgroundColor = palette().color(QPalette::Background);

    style()->drawPrimitive(QStyle::PE_FrameFocusRect, &option, &painter, this);
}

QStyle gets all the information it needs to render the graphical element from QStyleOption. The widget is passed as the last argument in case the style needs it to perform special effects (such as animated default buttons on macOS), but it isn't mandatory. In fact, you can use QStyle to draw on any paint device, not just widgets, by setting the QPainter properly.

QStyleOption has various subclasses for the various types of graphical elements that can be drawn. For example, PE_FrameFocusRect expects a QStyleOptionFocusRect argument.

To ensure that drawing operations are as fast as possible, QStyleOption and its subclasses have public data members. See the QStyleOption class documentation for details on how to use it.

For convenience, Qt provides the QStylePainter class, which combines a QStyle, a QPainter, and a QWidget. This makes it possible to write

    QStylePainter painter(this);
    ...
    painter.drawPrimitive(QStyle::PE_FrameFocusRect, option);

instead of

    QPainter painter(this);
    ...
    style()->drawPrimitive(QStyle::PE_FrameFocusRect, &option, &painter, this);

Creating a Custom Style

You can create a custom look and feel for your application by creating a custom style. There are two approaches to creating a custom style. In the static approach, you either choose an existing QStyle class, subclass it, and reimplement virtual functions to provide the custom behavior, or you create an entire QStyle class from scratch. In the dynamic approach, you modify the behavior of your system style at runtime. The static approach is described below. The dynamic approach is described in QProxyStyle.

The first step in the static approach is to pick one of the styles provided by Qt from which you will build your custom style. Your choice of QStyle class will depend on which style resembles your desired style the most. The most general class that you can use as a base is QCommonStyle (not QStyle). This is because Qt requires its styles to be QCommonStyles.

Depending on which parts of the base style you want to change, you must reimplement the functions that are used to draw those parts of the interface. To illustrate this, we will modify the look of the spin box arrows drawn by QWindowsStyle. The arrows are primitive elements that are drawn by the drawPrimitive() function, so we need to reimplement that function. We need the following class declaration:

class CustomStyle : public QProxyStyle
{
    Q_OBJECT

public:
    CustomStyle();
    ~CustomStyle() {}

    void drawPrimitive(PrimitiveElement element, const QStyleOption *option,
                       QPainter *painter, const QWidget *widget) const override;
};

To draw its up and down arrows, QSpinBox uses the PE_IndicatorSpinUp and PE_IndicatorSpinDown primitive elements. Here's how to reimplement the drawPrimitive() function to draw them differently:

void CustomStyle::drawPrimitive(PrimitiveElement element, const QStyleOption *option,
                                QPainter *painter, const QWidget *widget) const
{
    if (element == PE_IndicatorSpinUp || element == PE_IndicatorSpinDown) {
        QPolygon points(3);
        int x = option->rect.x();
        int y = option->rect.y();
        int w = option->rect.width() / 2;
        int h = option->rect.height() / 2;
        x += (option->rect.width() - w) / 2;
        y += (option->rect.height() - h) / 2;

        if (element == PE_IndicatorSpinUp) {
            points[0] = QPoint(x, y + h);
            points[1] = QPoint(x + w, y + h);
            points[2] = QPoint(x + w / 2, y);
        } else { // PE_SpinBoxDown
            points[0] = QPoint(x, y);
            points[1] = QPoint(x + w, y);
            points[2] = QPoint(x + w / 2, y + h);
        }

        if (option->state & State_Enabled) {
            painter->setPen(option->palette.mid().color());
            painter->setBrush(option->palette.buttonText());
        } else {
            painter->setPen(option->palette.buttonText().color());
            painter->setBrush(option->palette.mid());
        }
        painter->drawPolygon(points);
    } else {
    QProxyStyle::drawPrimitive(element, option, painter, widget);
    }
}

Notice that we don't use the widget argument, except to pass it on to the QWindowStyle::drawPrimitive() function. As mentioned earlier, the information about what is to be drawn and how it should be drawn is specified by a QStyleOption object, so there is no need to ask the widget.

If you need to use the widget argument to obtain additional information, be careful to ensure that it isn't 0 and that it is of the correct type before using it. For example:

    const QSpinBox *spinBox = qobject_cast<const QSpinBox *>(widget);
    if (spinBox) {
    ...
    }

When implementing a custom style, you cannot assume that the widget is a QSpinBox just because the enum value is called PE_IndicatorSpinUp or PE_IndicatorSpinDown.

The documentation for the Styles example covers this topic in more detail.

Warning: Qt style sheets are currently not supported for custom QStyle subclasses. We plan to address this in some future release.

Using a Custom Style

There are several ways of using a custom style in a Qt application. The simplest way is to pass the custom style to the QApplication::setStyle() static function before creating the QApplication object:

#include <QtWidgets>

#include "customstyle.h"

int main(int argc, char *argv[])
{
    QApplication::setStyle(new CustomStyle);
    QApplication app(argc, argv);
    QSpinBox spinBox;
    spinBox.show();
    return app.exec();
}

You can call QApplication::setStyle() at any time, but by calling it before the constructor, you ensure that the user's preference, set using the -style command-line option, is respected.

You may want to make your custom style available for use in other applications, which may not be yours and hence not available for you to recompile. The Qt Plugin system makes it possible to create styles as plugins. Styles created as plugins are loaded as shared objects at runtime by Qt itself. Please refer to the Qt Plugin documentation for more information on how to go about creating a style plugin.

Compile your plugin and put it into Qt's plugins/styles directory. We now have a pluggable style that Qt can load automatically. To use your new style with existing applications, simply start the application with the following argument:

./myapplication -style custom

The application will use the look and feel from the custom style you implemented.

Right-to-Left Desktops

Languages written from right to left (such as Arabic and Hebrew) usually also mirror the whole layout of widgets, and require the light to come from the screen's top-right corner instead of top-left.

If you create a custom style, you should take special care when drawing asymmetric elements to make sure that they also look correct in a mirrored layout. An easy way to test your styles is to run applications with the -reverse command-line option or to call QApplication::setLayoutDirection() in your main() function.

Here are some things to keep in mind when making a style work well in a right-to-left environment:

Styles in Item Views

The painting of items in views is performed by a delegate. Qt's default delegate, QStyledItemDelegate, is also used for calculating bounding rectangles of items, and their sub-elements for the various kind of item data roles QStyledItemDelegate supports. See the QStyledItemDelegate class description to find out which datatypes and roles are supported. You can read more about item data roles in Model/View Programming.

When QStyledItemDelegate paints its items, it draws CE_ItemViewItem, and calculates their size with CT_ItemViewItem. Note also that it uses SE_ItemViewItemText to set the size of editors. When implementing a style to customize drawing of item views, you need to check the implementation of QCommonStyle (and any other subclasses from which your style inherits). This way, you find out which and how other style elements are painted, and you can then reimplement the painting of elements that should be drawn differently.

We include a small example where we customize the drawing of item backgrounds.

    switch (element) {
        case (PE_PanelItemViewItem): {
            painter->save();

            QPoint topLeft = option->rect.topLeft();
            QPoint bottomRight = option->rect.topRight();
            QLinearGradient backgroundGradient(topLeft, bottomRight);
            backgroundGradient.setColorAt(0.0, QColor(Qt::yellow).lighter(190));
            backgroundGradient.setColorAt(1.0, Qt::white);
            painter->fillRect(option->rect, QBrush(backgroundGradient));

            painter->restore();
        break;
        }
        default:
            QProxyStyle::drawPrimitive(element, option, painter, widget);
    }

The primitive element PE_PanelItemViewItem is responsible for painting the background of items, and is called from QCommonStyle's implementation of CE_ItemViewItem.

To add support for drawing of new datatypes and item data roles, it is necessary to create a custom delegate. But if you only need to support the datatypes implemented by the default delegate, a custom style does not need an accompanying delegate. The QStyledItemDelegate class description gives more information on custom delegates.

The drawing of item view headers is also done by the style, giving control over size of header items and row and column sizes.

See also QStyleOption, QStylePainter, Styles Example, Styles and Style Aware Widgets, QStyledItemDelegate, and Styling.

Member Type Documentation

enum QStyle::ComplexControl

This enum describes the available complex controls. Complex controls have different behavior depending upon where the user clicks on them or which keys are pressed.

ConstantValueDescription
QStyle::CC_SpinBox0A spinbox, like QSpinBox.
QStyle::CC_ComboBox1A combobox, like QComboBox.
QStyle::CC_ScrollBar2A scroll bar, like QScrollBar.
QStyle::CC_Slider3A slider, like QSlider.
QStyle::CC_ToolButton4A tool button, like QToolButton.
QStyle::CC_TitleBar5A Title bar, like those used in QMdiSubWindow.
QStyle::CC_GroupBox7A group box, like QGroupBox.
QStyle::CC_Dial6A dial, like QDial.
QStyle::CC_MdiControls8The minimize, close, and normal button in the menu bar for a maximized MDI subwindow.
QStyle::CC_CustomBase0xf0000000Base value for custom complex controls. Custom values must be greater than this value.

See also SubControl and drawComplexControl().

enum QStyle::ContentsType

This enum describes the available contents types. These are used to calculate sizes for the contents of various widgets.

ConstantValueDescription
QStyle::CT_CheckBox1A check box, like QCheckBox.
QStyle::CT_ComboBox4A combo box, like QComboBox.
QStyle::CT_HeaderSection19A header section, like QHeader.
QStyle::CT_LineEdit14A line edit, like QLineEdit.
QStyle::CT_Menu10A menu, like QMenu.
QStyle::CT_MenuBar9A menu bar, like QMenuBar.
QStyle::CT_MenuBarItem8A menu bar item, like the buttons in a QMenuBar.
QStyle::CT_MenuItem7A menu item, like QMenuItem.
QStyle::CT_ProgressBar6A progress bar, like QProgressBar.
QStyle::CT_PushButton0A push button, like QPushButton.
QStyle::CT_RadioButton2A radio button, like QRadioButton.
QStyle::CT_SizeGrip16A size grip, like QSizeGrip.
QStyle::CT_Slider12A slider, like QSlider.
QStyle::CT_ScrollBar13A scroll bar, like QScrollBar.
QStyle::CT_SpinBox15A spin box, like QSpinBox.
QStyle::CT_Splitter5A splitter, like QSplitter.
QStyle::CT_TabBarTab11A tab on a tab bar, like QTabBar.
QStyle::CT_TabWidget17A tab widget, like QTabWidget.
QStyle::CT_ToolButton3A tool button, like QToolButton.
QStyle::CT_GroupBox20A group box, like QGroupBox.
QStyle::CT_ItemViewItem22An item inside an item view.
QStyle::CT_CustomBase0xf0000000Base value for custom contents types. Custom values must be greater than this value.
QStyle::CT_MdiControls21The minimize, normal, and close button in the menu bar for a maximized MDI subwindow.

See also sizeFromContents().

enum QStyle::ControlElement

This enum represents a control element. A control element is a part of a widget that performs some action or displays information to the user.

ConstantValueDescription
QStyle::CE_PushButton0A QPushButton, draws CE_PushButtonBevel, CE_PushButtonLabel and PE_FrameFocusRect.
QStyle::CE_PushButtonBevel1The bevel and default indicator of a QPushButton.
QStyle::CE_PushButtonLabel2The label (an icon with text or pixmap) of a QPushButton.
QStyle::CE_DockWidgetTitle30Dock window title.
QStyle::CE_Splitter28Splitter handle; see also QSplitter.
QStyle::CE_CheckBox3A QCheckBox, draws a PE_IndicatorCheckBox, a CE_CheckBoxLabel and a PE_FrameFocusRect.
QStyle::CE_CheckBoxLabel4The label (text or pixmap) of a QCheckBox.
QStyle::CE_RadioButton5A QRadioButton, draws a PE_IndicatorRadioButton, a CE_RadioButtonLabel and a PE_FrameFocusRect.
QStyle::CE_RadioButtonLabel6The label (text or pixmap) of a QRadioButton.
QStyle::CE_TabBarTab7The tab and label within a QTabBar.
QStyle::CE_TabBarTabShape8The tab shape within a tab bar.
QStyle::CE_TabBarTabLabel9The label within a tab.
QStyle::CE_ProgressBar10A QProgressBar, draws CE_ProgressBarGroove, CE_ProgressBarContents and CE_ProgressBarLabel.
QStyle::CE_ProgressBarGroove11The groove where the progress indicator is drawn in a QProgressBar.
QStyle::CE_ProgressBarContents12The progress indicator of a QProgressBar.
QStyle::CE_ProgressBarLabel13The text label of a QProgressBar.
QStyle::CE_ToolButtonLabel22A tool button's label.
QStyle::CE_MenuBarItem20A menu item in a QMenuBar.
QStyle::CE_MenuBarEmptyArea21The empty area of a QMenuBar.
QStyle::CE_MenuItem14A menu item in a QMenu.
QStyle::CE_MenuScroller15Scrolling areas in a QMenu when the style supports scrolling.
QStyle::CE_MenuTearoff18A menu item representing the tear off section of a QMenu.
QStyle::CE_MenuEmptyArea19The area in a menu without menu items.
QStyle::CE_MenuHMargin17The horizontal extra space on the left/right of a menu.
QStyle::CE_MenuVMargin16The vertical extra space on the top/bottom of a menu.
QStyle::CE_ToolBoxTab26The toolbox's tab and label within a QToolBox.
QStyle::CE_SizeGrip27Window resize handle; see also QSizeGrip.
QStyle::CE_Header23A header.
QStyle::CE_HeaderSection24A header section.
QStyle::CE_HeaderLabel25The header's label.
QStyle::CE_ScrollBarAddLine31Scroll bar line increase indicator. (i.e., scroll down); see also QScrollBar.
QStyle::CE_ScrollBarSubLine32Scroll bar line decrease indicator (i.e., scroll up).
QStyle::CE_ScrollBarAddPage33Scolllbar page increase indicator (i.e., page down).
QStyle::CE_ScrollBarSubPage34Scroll bar page decrease indicator (i.e., page up).
QStyle::CE_ScrollBarSlider35Scroll bar slider.
QStyle::CE_ScrollBarFirst36Scroll bar first line indicator (i.e., home).
QStyle::CE_ScrollBarLast37Scroll bar last line indicator (i.e., end).
QStyle::CE_RubberBand29Rubber band used in for example an icon view.
QStyle::CE_FocusFrame38Focus frame that is style controlled.
QStyle::CE_ItemViewItem45An item inside an item view.
QStyle::CE_CustomBase0xf0000000Base value for custom control elements; custom values must be greater than this value.
QStyle::CE_ComboBoxLabel39The label of a non-editable QComboBox.
QStyle::CE_ToolBar40A toolbar like QToolBar.
QStyle::CE_ToolBoxTabShape41The toolbox's tab shape.
QStyle::CE_ToolBoxTabLabel42The toolbox's tab label.
QStyle::CE_HeaderEmptyArea43The area of a header view where there are no header sections.
QStyle::CE_ShapedFrame46The frame with the shape specified in the QStyleOptionFrame; see QFrame.

See also drawControl().

enum QStyle::PixelMetric

This enum describes the various available pixel metrics. A pixel metric is a style dependent size represented by a single pixel value.

ConstantValueDescription
QStyle::PM_ButtonMargin0Amount of whitespace between push button labels and the frame.
QStyle::PM_DockWidgetTitleBarButtonMargin76Amount of whitespace between dock widget's title bar button labels and the frame.
QStyle::PM_ButtonDefaultIndicator1Width of the default-button indicator frame.
QStyle::PM_MenuButtonIndicator2Width of the menu button indicator proportional to the widget height.
QStyle::PM_ButtonShiftHorizontal3Horizontal contents shift of a button when the button is down.
QStyle::PM_ButtonShiftVertical4Vertical contents shift of a button when the button is down.
QStyle::PM_DefaultFrameWidth5Default frame width (usually 2).
QStyle::PM_SpinBoxFrameWidth6Frame width of a spin box, defaults to PM_DefaultFrameWidth.
QStyle::PM_ComboBoxFrameWidth7Frame width of a combo box, defaults to PM_DefaultFrameWidth.
QStyle::PM_MDIFrameWidthPM_MdiSubWindowFrameWidthObsolete. Use PM_MdiSubWindowFrameWidth instead.
QStyle::PM_MdiSubWindowFrameWidth44Frame width of an MDI window.
QStyle::PM_MDIMinimizedWidthPM_MdiSubWindowMinimizedWidthObsolete. Use PM_MdiSubWindowMinimizedWidth instead.
QStyle::PM_MdiSubWindowMinimizedWidth45Width of a minimized MDI window.
QStyle::PM_LayoutLeftMargin78Default left margin for a QLayout.
QStyle::PM_LayoutTopMargin79Default top margin for a QLayout.
QStyle::PM_LayoutRightMargin80Default right margin for a QLayout.
QStyle::PM_LayoutBottomMargin81Default bottom margin for a QLayout.
QStyle::PM_LayoutHorizontalSpacing82Default horizontal spacing for a QLayout.
QStyle::PM_LayoutVerticalSpacing83Default vertical spacing for a QLayout.
QStyle::PM_MaximumDragDistance8The maximum allowed distance between the mouse and a scrollbar when dragging. Exceeding the specified distance will cause the slider to jump back to the original position; a value of -1 disables this behavior.
QStyle::PM_ScrollBarExtent9Width of a vertical scroll bar and the height of a horizontal scroll bar.
QStyle::PM_ScrollBarSliderMin10The minimum height of a vertical scroll bar's slider and the minimum width of a horizontal scroll bar's slider.
QStyle::PM_SliderThickness11Total slider thickness.
QStyle::PM_SliderControlThickness12Thickness of the slider handle.
QStyle::PM_SliderLength13Length of the slider.
QStyle::PM_SliderTickmarkOffset14The offset between the tickmarks and the slider.
QStyle::PM_SliderSpaceAvailable15The available space for the slider to move.
QStyle::PM_DockWidgetSeparatorExtent16Width of a separator in a horizontal dock window and the height of a separator in a vertical dock window.
QStyle::PM_DockWidgetHandleExtent17Width of the handle in a horizontal dock window and the height of the handle in a vertical dock window.
QStyle::PM_DockWidgetFrameWidth18Frame width of a dock window.
QStyle::PM_DockWidgetTitleMargin73Margin of the dock window title.
QStyle::PM_MenuBarPanelWidth33Frame width of a menu bar, defaults to PM_DefaultFrameWidth.
QStyle::PM_MenuBarItemSpacing34Spacing between menu bar items.
QStyle::PM_MenuBarHMargin36Spacing between menu bar items and left/right of bar.
QStyle::PM_MenuBarVMargin35Spacing between menu bar items and top/bottom of bar.
QStyle::PM_ToolBarFrameWidth52Width of the frame around toolbars.
QStyle::PM_ToolBarHandleExtent53Width of a toolbar handle in a horizontal toolbar and the height of the handle in a vertical toolbar.
QStyle::PM_ToolBarItemMargin55Spacing between the toolbar frame and the items.
QStyle::PM_ToolBarItemSpacing54Spacing between toolbar items.
QStyle::PM_ToolBarSeparatorExtent56Width of a toolbar separator in a horizontal toolbar and the height of a separator in a vertical toolbar.
QStyle::PM_ToolBarExtensionExtent57Width of a toolbar extension button in a horizontal toolbar and the height of the button in a vertical toolbar.
QStyle::PM_TabBarTabOverlap19Number of pixels the tabs should overlap. (Currently only used in styles, not inside of QTabBar)
QStyle::PM_TabBarTabHSpace20Extra space added to the tab width.
QStyle::PM_TabBarTabVSpace21Extra space added to the tab height.
QStyle::PM_TabBarBaseHeight22Height of the area between the tab bar and the tab pages.
QStyle::PM_TabBarBaseOverlap23Number of pixels the tab bar overlaps the tab bar base.
QStyle::PM_TabBarScrollButtonWidth51 
QStyle::PM_TabBarTabShiftHorizontal49Horizontal pixel shift when a tab is selected.
QStyle::PM_TabBarTabShiftVertical50Vertical pixel shift when a tab is selected.
QStyle::PM_ProgressBarChunkWidth24Width of a chunk in a progress bar indicator.
QStyle::PM_SplitterWidth25Width of a splitter.
QStyle::PM_TitleBarHeight26Height of the title bar.
QStyle::PM_IndicatorWidth37Width of a check box indicator.
QStyle::PM_IndicatorHeight38Height of a checkbox indicator.
QStyle::PM_ExclusiveIndicatorWidth39Width of a radio button indicator.
QStyle::PM_ExclusiveIndicatorHeight40Height of a radio button indicator.
QStyle::PM_MenuPanelWidth30Border width (applied on all sides) for a QMenu.
QStyle::PM_MenuHMargin28Additional border (used on left and right) for a QMenu.
QStyle::PM_MenuVMargin29Additional border (used for bottom and top) for a QMenu.
QStyle::PM_MenuScrollerHeight27Height of the scroller area in a QMenu.
QStyle::PM_MenuTearoffHeight31Height of a tear off area in a QMenu.
QStyle::PM_MenuDesktopFrameWidth32The frame width for the menu on the desktop.
QStyle::PM_HeaderMarkSize47The size of the sort indicator in a header.
QStyle::PM_HeaderGripMargin48The size of the resize grip in a header.
QStyle::PM_HeaderMargin46The size of the margin between the sort indicator and the text.
QStyle::PM_SpinBoxSliderHeight58The height of the optional spin box slider.
QStyle::PM_ToolBarIconSizePM_SpinBoxSliderHeight + 4Default tool bar icon size
QStyle::PM_SmallIconSize65Default small icon size
QStyle::PM_LargeIconSize66Default large icon size
QStyle::PM_FocusFrameHMargin68Horizontal margin that the focus frame will outset the widget by.
QStyle::PM_FocusFrameVMargin67Vertical margin that the focus frame will outset the widget by.
QStyle::PM_IconViewIconSize64The default size for icons in an icon view.
QStyle::PM_ListViewIconSize63The default size for icons in a list view.
QStyle::PM_ToolTipLabelFrameWidth69The frame width for a tool tip label.
QStyle::PM_CheckBoxLabelSpacing70The spacing between a check box indicator and its label.
QStyle::PM_RadioButtonLabelSpacing77The spacing between a radio button indicator and its label.
QStyle::PM_TabBarIconSize71The default icon size for a tab bar.
QStyle::PM_SizeGripSize72The size of a size grip.
QStyle::PM_MessageBoxIconSize74The size of the standard icons in a message box
QStyle::PM_ButtonIconSize75The default size of button icons
QStyle::PM_TextCursorWidth85The width of the cursor in a line edit or text edit
QStyle::PM_TabBar_ScrollButtonOverlap84The distance between the left and right buttons in a tab bar.
QStyle::PM_TabCloseIndicatorWidth86The default width of a close button on a tab in a tab bar.
QStyle::PM_TabCloseIndicatorHeight87The default height of a close button on a tab in a tab bar.
QStyle::PM_ScrollView_ScrollBarSpacing88Distance between frame and scrollbar with SH_ScrollView_FrameOnlyAroundContents set.
QStyle::PM_ScrollView_ScrollBarOverlap89Overlap between scroll bars and scroll content
QStyle::PM_SubMenuOverlap90The horizontal overlap between a submenu and its parent.
QStyle::PM_TreeViewIndentation91The indentation of items in a tree view. This enum value has been introduced in Qt 5.4.
QStyle::PM_HeaderDefaultSectionSizeHorizontal92The default size of sections in a horizontal header. This enum value has been introduced in Qt 5.5.
QStyle::PM_HeaderDefaultSectionSizeVertical93The default size of sections in a vertical header. This enum value has been introduced in Qt 5.5.
QStyle::PM_TitleBarButtonIconSize94The size of button icons on a title bar. This enum value has been introduced in Qt 5.8.
QStyle::PM_TitleBarButtonSize95The size of buttons on a title bar. This enum value has been introduced in Qt 5.8.
QStyle::PM_CustomBase0xf0000000Base value for custom pixel metrics. Custom values must be greater than this value.

The following values are obsolete:

ConstantValueDescription
QStyle::PM_DefaultTopLevelMargin59Use PM_LayoutLeftMargin, PM_LayoutTopMargin, PM_LayoutRightMargin, and PM_LayoutBottomMargin instead.
QStyle::PM_DefaultChildMargin60Use PM_LayoutLeftMargin, PM_LayoutTopMargin, PM_LayoutRightMargin, and PM_LayoutBottomMargin instead.
QStyle::PM_DefaultLayoutSpacing61Use PM_LayoutHorizontalSpacing and PM_LayoutVerticalSpacing instead.

See also pixelMetric().

enum QStyle::PrimitiveElement

This enum describes the various primitive elements. A primitive element is a common GUI element, such as a checkbox indicator or button bevel.

ConstantValueDescription
QStyle::PE_FrameStatusBarPE_FrameStatusBarItemObsolete. Use PE_FrameStatusBarItem instead.
QStyle::PE_PanelButtonCommand13Button used to initiate an action, for example, a QPushButton.
QStyle::PE_FrameDefaultButton1This frame around a default button, e.g. in a dialog.
QStyle::PE_PanelButtonBevel14Generic panel with a button bevel.
QStyle::PE_PanelButtonTool15Panel for a Tool button, used with QToolButton.
QStyle::PE_PanelLineEdit18Panel for a QLineEdit.
QStyle::PE_IndicatorButtonDropDown24Indicator for a drop down button, for example, a tool button that displays a menu.
QStyle::PE_FrameFocusRect3Generic focus indicator.
QStyle::PE_IndicatorArrowUp22Generic Up arrow.
QStyle::PE_IndicatorArrowDown19Generic Down arrow.
QStyle::PE_IndicatorArrowRight21Generic Right arrow.
QStyle::PE_IndicatorArrowLeft20Generic Left arrow.
QStyle::PE_IndicatorSpinUp35Up symbol for a spin widget, for example a QSpinBox.
QStyle::PE_IndicatorSpinDown32Down symbol for a spin widget.
QStyle::PE_IndicatorSpinPlus34Increase symbol for a spin widget.
QStyle::PE_IndicatorSpinMinus33Decrease symbol for a spin widget.
QStyle::PE_IndicatorItemViewItemCheck25On/off indicator for a view item.
QStyle::PE_IndicatorCheckBox26On/off indicator, for example, a QCheckBox.
QStyle::PE_IndicatorRadioButton31Exclusive on/off indicator, for example, a QRadioButton.
QStyle::PE_IndicatorDockWidgetResizeHandle27Resize handle for dock windows.
QStyle::PE_Frame0Generic frame
QStyle::PE_FrameMenu6Frame for popup windows/menus; see also QMenu.
QStyle::PE_PanelMenuBar16Panel for menu bars.
QStyle::PE_PanelScrollAreaCorner40Panel at the bottom-right (or bottom-left) corner of a scroll area.
QStyle::PE_FrameDockWidget2Panel frame for dock windows and toolbars.
QStyle::PE_FrameTabWidget8Frame for tab widgets.
QStyle::PE_FrameLineEdit5Panel frame for line edits.
QStyle::PE_FrameGroupBox4Panel frame around group boxes.
QStyle::PE_FrameButtonBevel10Panel frame for a button bevel.
QStyle::PE_FrameButtonTool11Panel frame for a tool button.
QStyle::PE_IndicatorHeaderArrow28Arrow used to indicate sorting on a list or table header.
QStyle::PE_FrameStatusBarItem7Frame for an item of a status bar; see also QStatusBar.
QStyle::PE_FrameWindow9Frame around a MDI window or a docking window.
QStyle::PE_IndicatorMenuCheckMark29Check mark used in a menu.
QStyle::PE_IndicatorProgressChunk30Section of a progress bar indicator; see also QProgressBar.
QStyle::PE_IndicatorBranch23Lines used to represent the branch of a tree in a tree view.
QStyle::PE_IndicatorToolBarHandle36The handle of a toolbar.
QStyle::PE_IndicatorToolBarSeparator37The separator in a toolbar.
QStyle::PE_PanelToolBar17The panel for a toolbar.
QStyle::PE_PanelTipLabel38The panel for a tip label.
QStyle::PE_FrameTabBarBase12The frame that is drawn for a tab bar, usually drawn for a tab bar that isn't part of a tab widget.
QStyle::PE_IndicatorTabTear39Deprecated. Use PE_IndicatorTabTearLeft instead.
QStyle::PE_IndicatorTabTearLeftPE_IndicatorTabTearAn indicator that a tab is partially scrolled out on the left side of the visible tab bar when there are many tabs.
QStyle::PE_IndicatorTabTearRight49An indicator that a tab is partially scrolled out on the right side of the visible tab bar when there are many tabs.
QStyle::PE_IndicatorColumnViewArrow42An arrow in a QColumnView.
QStyle::PE_Widget41A plain QWidget.
QStyle::PE_CustomBase0xf000000Base value for custom primitive elements. All values above this are reserved for custom use. Custom values must be greater than this value.
QStyle::PE_IndicatorItemViewItemDrop43An indicator that is drawn to show where an item in an item view is about to be dropped during a drag-and-drop operation in an item view.
QStyle::PE_PanelItemViewItem44The background for an item in an item view.
QStyle::PE_PanelItemViewRow45The background of a row in an item view.
QStyle::PE_PanelStatusBar46The panel for a status bar.
QStyle::PE_IndicatorTabClose47The close button on a tab bar.
QStyle::PE_PanelMenu48The panel for a menu.

See also drawPrimitive().

enum QStyle::RequestSoftwareInputPanel

This enum describes under what circumstances a software input panel will be requested by input capable widgets.

ConstantValueDescription
QStyle::RSIP_OnMouseClickAndAlreadyFocused0Requests an input panel if the user clicks on the widget, but only if it is already focused.
QStyle::RSIP_OnMouseClick1Requests an input panel if the user clicks on the widget.

See also QInputMethod.

enum QStyle::StandardPixmap

This enum describes the available standard pixmaps. A standard pixmap is a pixmap that can follow some existing GUI style or guideline.

ConstantValueDescription
QStyle::SP_TitleBarMinButton1Minimize button on title bars (e.g., in QMdiSubWindow).
QStyle::SP_TitleBarMenuButton0Menu button on a title bar.
QStyle::SP_TitleBarMaxButton2Maximize button on title bars.
QStyle::SP_TitleBarCloseButton3Close button on title bars.
QStyle::SP_TitleBarNormalButton4Normal (restore) button on title bars.
QStyle::SP_TitleBarShadeButton5Shade button on title bars.
QStyle::SP_TitleBarUnshadeButton6Unshade button on title bars.
QStyle::SP_TitleBarContextHelpButton7The Context help button on title bars.
QStyle::SP_MessageBoxInformation9The "information" icon.
QStyle::SP_MessageBoxWarning10The "warning" icon.
QStyle::SP_MessageBoxCritical11The "critical" icon.
QStyle::SP_MessageBoxQuestion12The "question" icon.
QStyle::SP_DesktopIcon13The "desktop" icon.
QStyle::SP_TrashIcon14The "trash" icon.
QStyle::SP_ComputerIcon15The "My computer" icon.
QStyle::SP_DriveFDIcon16The floppy icon.
QStyle::SP_DriveHDIcon17The harddrive icon.
QStyle::SP_DriveCDIcon18The CD icon.
QStyle::SP_DriveDVDIcon19The DVD icon.
QStyle::SP_DriveNetIcon20The network icon.
QStyle::SP_DirHomeIcon56The home directory icon.
QStyle::SP_DirOpenIcon21The open directory icon.
QStyle::SP_DirClosedIcon22The closed directory icon.
QStyle::SP_DirIcon38The directory icon.
QStyle::SP_DirLinkIcon23The link to directory icon.
QStyle::SP_DirLinkOpenIcon24The link to open directory icon.
QStyle::SP_FileIcon25The file icon.
QStyle::SP_FileLinkIcon26The link to file icon.
QStyle::SP_FileDialogStart29The "start" icon in a file dialog.
QStyle::SP_FileDialogEnd30The "end" icon in a file dialog.
QStyle::SP_FileDialogToParent31The "parent directory" icon in a file dialog.
QStyle::SP_FileDialogNewFolder32The "create new folder" icon in a file dialog.
QStyle::SP_FileDialogDetailedView33The detailed view icon in a file dialog.
QStyle::SP_FileDialogInfoView34The file info icon in a file dialog.
QStyle::SP_FileDialogContentsView35The contents view icon in a file dialog.
QStyle::SP_FileDialogListView36The list view icon in a file dialog.
QStyle::SP_FileDialogBack37The back arrow in a file dialog.
QStyle::SP_DockWidgetCloseButton8Close button on dock windows (see also QDockWidget).
QStyle::SP_ToolBarHorizontalExtensionButton27Extension button for horizontal toolbars.
QStyle::SP_ToolBarVerticalExtensionButton28Extension button for vertical toolbars.
QStyle::SP_DialogOkButton39Icon for a standard OK button in a QDialogButtonBox.
QStyle::SP_DialogCancelButton40Icon for a standard Cancel button in a QDialogButtonBox.
QStyle::SP_DialogHelpButton41Icon for a standard Help button in a QDialogButtonBox.
QStyle::SP_DialogOpenButton42Icon for a standard Open button in a QDialogButtonBox.
QStyle::SP_DialogSaveButton43Icon for a standard Save button in a QDialogButtonBox.
QStyle::SP_DialogCloseButton44Icon for a standard Close button in a QDialogButtonBox.
QStyle::SP_DialogApplyButton45Icon for a standard Apply button in a QDialogButtonBox.
QStyle::SP_DialogResetButton46Icon for a standard Reset button in a QDialogButtonBox.
QStyle::SP_DialogDiscardButton47Icon for a standard Discard button in a QDialogButtonBox.
QStyle::SP_DialogYesButton48Icon for a standard Yes button in a QDialogButtonBox.
QStyle::SP_DialogNoButton49Icon for a standard No button in a QDialogButtonBox.
QStyle::SP_ArrowUp50Icon arrow pointing up.
QStyle::SP_ArrowDown51Icon arrow pointing down.
QStyle::SP_ArrowLeft52Icon arrow pointing left.
QStyle::SP_ArrowRight53Icon arrow pointing right.
QStyle::SP_ArrowBack54Equivalent to SP_ArrowLeft when the current layout direction is Qt::LeftToRight, otherwise SP_ArrowRight.
QStyle::SP_ArrowForward55Equivalent to SP_ArrowRight when the current layout direction is Qt::LeftToRight, otherwise SP_ArrowLeft.
QStyle::SP_CommandLink57Icon used to indicate a Vista style command link glyph.
QStyle::SP_VistaShield58Icon used to indicate UAC prompts on Windows Vista. This will return a null pixmap or icon on all other platforms.
QStyle::SP_BrowserReload59Icon indicating that the current page should be reloaded.
QStyle::SP_BrowserStop60Icon indicating that the page loading should stop.
QStyle::SP_MediaPlay61Icon indicating that media should begin playback.
QStyle::SP_MediaStop62Icon indicating that media should stop playback.
QStyle::SP_MediaPause63Icon indicating that media should pause playback.
QStyle::SP_MediaSkipForward64Icon indicating that media should skip forward.
QStyle::SP_MediaSkipBackward65Icon indicating that media should skip backward.
QStyle::SP_MediaSeekForward66Icon indicating that media should seek forward.
QStyle::SP_MediaSeekBackward67Icon indicating that media should seek backward.
QStyle::SP_MediaVolume68Icon indicating a volume control.
QStyle::SP_MediaVolumeMuted69Icon indicating a muted volume control.
QStyle::SP_LineEditClearButton70Icon for a standard clear button in a QLineEdit. This enum value was added in Qt 5.2.
QStyle::SP_DialogYesToAllButton71Icon for a standard YesToAll button in a QDialogButtonBox. This enum value was added in Qt 5.14.
QStyle::SP_DialogNoToAllButton72Icon for a standard NoToAll button in a QDialogButtonBox. This enum value was added in Qt 5.14.
QStyle::SP_DialogSaveAllButton73Icon for a standard SaveAll button in a QDialogButtonBox. This enum value was added in Qt 5.14.
QStyle::SP_DialogAbortButton74Icon for a standard Abort button in a QDialogButtonBox. This enum value was added in Qt 5.14.
QStyle::SP_DialogRetryButton75Icon for a standard Retry button in a QDialogButtonBox. This enum value was added in Qt 5.14.
QStyle::SP_DialogIgnoreButton76Icon for a standard Ignore button in a QDialogButtonBox. This enum value was added in Qt 5.14.
QStyle::SP_RestoreDefaultsButton77Icon for a standard RestoreDefaults button in a QDialogButtonBox. This enum value was added in Qt 5.14.
QStyle::SP_CustomBase0xf0000000Base value for custom standard pixmaps; custom values must be greater than this value.

See also standardIcon().

enum QStyle::StateFlag
flags QStyle::State

This enum describes flags that are used when drawing primitive elements.

Note that not all primitives use all of these flags, and that the flags may mean different things to different items.

ConstantValueDescription
QStyle::State_None0x00000000Indicates that the widget does not have a state.
QStyle::State_Active0x00010000Indicates that the widget is active.
QStyle::State_AutoRaise0x00001000Used to indicate if auto-raise appearance should be used on a tool button.
QStyle::State_Children0x00080000Used to indicate if an item view branch has children.
QStyle::State_DownArrow0x00000040Used to indicate if a down arrow should be visible on the widget.
QStyle::State_Editing0x00400000Used to indicate if an editor is opened on the widget.
QStyle::State_Enabled0x00000001Used to indicate if the widget is enabled.
QStyle::State_HasEditFocus0x01000000Used to indicate if the widget currently has edit focus.
QStyle::State_HasFocus0x00000100Used to indicate if the widget has focus.
QStyle::State_Horizontal0x00000080Used to indicate if the widget is laid out horizontally, for example. a tool bar.
QStyle::State_KeyboardFocusChange0x00800000Used to indicate if the focus was changed with the keyboard, e.g., tab, backtab or shortcut.
QStyle::State_MouseOver0x00002000Used to indicate if the widget is under the mouse.
QStyle::State_NoChange0x00000010Used to indicate a tri-state checkbox.
QStyle::State_Off0x00000008Used to indicate if the widget is not checked.
QStyle::State_On0x00000020Used to indicate if the widget is checked.
QStyle::State_Raised0x00000002Used to indicate if a button is raised.
QStyle::State_ReadOnly0x02000000Used to indicate if a widget is read-only.
QStyle::State_Selected0x00008000Used to indicate if a widget is selected.
QStyle::State_Item0x00100000Used by item views to indicate if a horizontal branch should be drawn.
QStyle::State_Open0x00040000Used by item views to indicate if the tree branch is open.
QStyle::State_Sibling0x00200000Used by item views to indicate if a vertical line needs to be drawn (for siblings).
QStyle::State_Sunken0x00000004Used to indicate if the widget is sunken or pressed.
QStyle::State_UpArrow0x00004000Used to indicate if an up arrow should be visible on the widget.
QStyle::State_Mini0x08000000Used to indicate a mini style Mac widget or button.
QStyle::State_Small0x04000000Used to indicate a small style Mac widget or button.

The State type is a typedef for QFlags<StateFlag>. It stores an OR combination of StateFlag values.

See also drawPrimitive().

enum QStyle::StyleHint

This enum describes the available style hints. A style hint is a general look and/or feel hint.

ConstantValueDescription
QStyle::SH_EtchDisabledText0Disabled text is "etched" as it is on Windows.
QStyle::SH_DitherDisabledText1Disabled text is dithered as it is on Motif.
QStyle::SH_ScrollBar_ContextMenu62Whether or not a scroll bar has a context menu.
QStyle::SH_ScrollBar_MiddleClickAbsolutePosition2A boolean value. If true, middle clicking on a scroll bar causes the slider to jump to that position. If false, middle clicking is ignored.
QStyle::SH_ScrollBar_LeftClickAbsolutePosition39A boolean value. If true, left clicking on a scroll bar causes the slider to jump to that position. If false, left clicking will behave as appropriate for each control.
QStyle::SH_ScrollBar_ScrollWhenPointerLeavesControl3A boolean value. If true, when clicking a scroll bar SubControl, holding the mouse button down and moving the pointer outside the SubControl, the scroll bar continues to scroll. If false, the scollbar stops scrolling when the pointer leaves the SubControl.
QStyle::SH_ScrollBar_RollBetweenButtons63A boolean value. If true, when clicking a scroll bar button (SC_ScrollBarAddLine or SC_ScrollBarSubLine) and dragging over to the opposite button (rolling) will press the new button and release the old one. When it is false, the original button is released and nothing happens (like a push button).
QStyle::SH_TabBar_Alignment5The alignment for tabs in a QTabWidget. Possible values are Qt::AlignLeft, Qt::AlignCenter and Qt::AlignRight.
QStyle::SH_Header_ArrowAlignment6The placement of the sorting indicator may appear in list or table headers. Possible values are Qt::Alignment values (that is, an OR combination of Qt::AlignmentFlag flags).
QStyle::SH_Slider_SnapToValue7Sliders snap to values while moving, as they do on Windows.
QStyle::SH_Slider_SloppyKeyEvents8Key presses handled in a sloppy manner, i.e., left on a vertical slider subtracts a line.
QStyle::SH_ProgressDialog_CenterCancelButton9Center button on progress dialogs, otherwise right aligned.
QStyle::SH_ProgressDialog_TextLabelAlignment10The alignment for text labels in progress dialogs; Qt::AlignCenter on Windows, Qt::AlignVCenter otherwise.
QStyle::SH_PrintDialog_RightAlignButtons11Right align buttons in the print dialog, as done on Windows.
QStyle::SH_MainWindow_SpaceBelowMenuBar12One or two pixel space between the menu bar and the dockarea, as done on Windows.
QStyle::SH_FontDialog_SelectAssociatedText13Select the text in the line edit, or when selecting an item from the listbox, or when the line edit receives focus, as done on Windows.
QStyle::SH_Menu_KeyboardSearch66Typing causes a menu to be search for relevant items, otherwise only mnemnonic is considered.
QStyle::SH_Menu_AllowActiveAndDisabled14Allows disabled menu items to be active.
QStyle::SH_Menu_SpaceActivatesItem15Pressing the space bar activates the item, as done on Motif.
QStyle::SH_Menu_SubMenuPopupDelay16The number of milliseconds to wait before opening a submenu (256 on Windows, 96 on Motif).
QStyle::SH_Menu_Scrollable30Whether popup menus must support scrolling.
QStyle::SH_Menu_SloppySubMenus33Whether popup menus must support the user moving the mouse cursor to a submenu while crossing other items of the menu. This is supported on most modern desktop platforms.
QStyle::SH_Menu_SubMenuUniDirection106Since Qt 5.5. If the cursor has to move towards the submenu (like it is on macOS), or if the cursor can move in any direction as long as it reaches the submenu before the sloppy timeout.
QStyle::SH_Menu_SubMenuUniDirectionFailCount107Since Qt 5.5. When SH_Menu_SubMenuUniDirection is defined this enum defines the number of failed mouse moves before the sloppy submenu is discarded. This can be used to control the "strictness" of the uni direction algorithm.
QStyle::SH_Menu_SubMenuSloppySelectOtherActions108Since Qt 5.5. Should other action items be selected when the mouse moves towards a sloppy submenu.
QStyle::SH_Menu_SubMenuSloppyCloseTimeout109Since Qt 5.5. The timeout used to close sloppy submenus.
QStyle::SH_Menu_SubMenuResetWhenReenteringParent110Since Qt 5.5. When entering parent from child submenu, should the sloppy state be reset, effectively closing the child and making the current submenu active.
QStyle::SH_Menu_SubMenuDontStartSloppyOnLeave111Since Qt 5.5. Do not start sloppy timers when the mouse leaves a sub-menu.
QStyle::SH_ScrollView_FrameOnlyAroundContents17Whether scrollviews draw their frame only around contents (like Motif), or around contents, scroll bars and corner widgets (like Windows).
QStyle::SH_MenuBar_AltKeyNavigation18Menu bars items are navigable by pressing Alt, followed by using the arrow keys to select the desired item.
QStyle::SH_ComboBox_ListMouseTracking19Mouse tracking in combobox drop-down lists.
QStyle::SH_Menu_MouseTracking20Mouse tracking in popup menus.
QStyle::SH_MenuBar_MouseTracking21Mouse tracking in menu bars.
QStyle::SH_Menu_FillScreenWithScroll45Whether scrolling popups should fill the screen as they are scrolled.
QStyle::SH_Menu_SelectionWrap74Whether popups should allow the selections to wrap, that is when selection should the next item be the first item.
QStyle::SH_ItemView_ChangeHighlightOnFocus22Gray out selected items when losing focus.
QStyle::SH_Widget_ShareActivation23Turn on sharing activation with floating modeless dialogs.
QStyle::SH_TabBar_SelectMouseType4Which type of mouse event should cause a tab to be selected.
QStyle::SH_ListViewExpand_SelectMouseType40Which type of mouse event should cause a list view expansion to be selected.
QStyle::SH_TabBar_PreferNoArrows38Whether a tab bar should suggest a size to prevent scroll arrows.
QStyle::SH_ComboBox_Popup25Allows popups as a combobox drop-down menu.
QStyle::SH_Workspace_FillSpaceOnMaximize24The workspace should maximize the client area.
QStyle::SH_TitleBar_NoBorder26The title bar has no border.
QStyle::SH_ScrollBar_StopMouseOverSliderSH_Slider_StopMouseOverSliderObsolete. Use SH_Slider_StopMouseOverSlider instead.
QStyle::SH_Slider_StopMouseOverSlider27Stops auto-repeat when the slider reaches the mouse position.
QStyle::SH_BlinkCursorWhenTextSelected28Whether cursor should blink when text is selected.
QStyle::SH_RichText_FullWidthSelection29Whether richtext selections should extend to the full width of the document.
QStyle::SH_GroupBox_TextLabelVerticalAlignment31How to vertically align a group box's text label.
QStyle::SH_GroupBox_TextLabelColor32How to paint a group box's text label.
QStyle::SH_DialogButtons_DefaultButton36Which button gets the default status in a dialog's button widget.
QStyle::SH_ToolBox_SelectedPageTitleBold37Boldness of the selected page title in a QToolBox.
QStyle::SH_LineEdit_PasswordCharacter35The Unicode character to be used for passwords.
QStyle::SH_LineEdit_PasswordMaskDelay104Determines the delay before visible character is masked with password character, in milliseconds. This enum value was added in Qt 5.4.
QStyle::SH_Table_GridLineColor34The RGBA value of the grid for a table.
QStyle::SH_UnderlineShortcut41Whether shortcuts are underlined.
QStyle::SH_SpellCheckUnderlineStyle72Obsolete. Use SpellCheckUnderlineStyle hint in QPlatformTheme instead.
QStyle::SH_SpinBox_AnimateButton42Animate a click when up or down is pressed in a spin box.
QStyle::SH_SpinBox_KeyPressAutoRepeatRate43Auto-repeat interval for spinbox key presses.
QStyle::SH_SpinBox_ClickAutoRepeatRate44Auto-repeat interval for spinbox mouse clicks.
QStyle::SH_SpinBox_ClickAutoRepeatThreshold84Auto-repeat threshold for spinbox mouse clicks.
QStyle::SH_ToolTipLabel_Opacity46An integer indicating the opacity for the tip label, 0 is completely transparent, 255 is completely opaque.
QStyle::SH_DrawMenuBarSeparator47Indicates whether or not the menu bar draws separators.
QStyle::SH_TitleBar_ModifyNotification48Indicates if the title bar should show a '*' for windows that are modified.
QStyle::SH_Button_FocusPolicy49The default focus policy for buttons.
QStyle::SH_CustomBase0xf0000000Base value for custom style hints. Custom values must be greater than this value.
QStyle::SH_MessageBox_UseBorderForButtonSpacing50A boolean indicating what the to use the border of the buttons (computed as half the button height) for the spacing of the button in a message box.
QStyle::SH_MessageBox_CenterButtons73A boolean indicating whether the buttons in the message box should be centered or not (see QDialogButtonBox::setCentered()).
QStyle::SH_MessageBox_TextInteractionFlags70A boolean indicating if the text in a message box should allow user interfactions (e.g. selection) or not.
QStyle::SH_TitleBar_AutoRaise51A boolean indicating whether controls on a title bar ought to update when the mouse is over them.
QStyle::SH_ToolButton_PopupDelay52An int indicating the popup delay in milliseconds for menus attached to tool buttons.
QStyle::SH_FocusFrame_Mask53The mask of the focus frame.
QStyle::SH_RubberBand_Mask54The mask of the rubber band.
QStyle::SH_WindowFrame_Mask55The mask of the window frame.
QStyle::SH_SpinControls_DisableOnBounds56Determines if the spin controls will shown as disabled when reaching the spin range boundary.
QStyle::SH_Dial_BackgroundRole57Defines the style's preferred background role (as QPalette::ColorRole) for a dial widget.
QStyle::SH_ComboBox_LayoutDirection58The layout direction for the combo box. By default it should be the same as indicated by the QStyleOption::direction variable.
QStyle::SH_ItemView_EllipsisLocation59The location where ellipses should be added for item text that is too long to fit in an view item.
QStyle::SH_ItemView_ShowDecorationSelected60When an item in an item view is selected, also highlight the branch or other decoration.
QStyle::SH_ItemView_ActivateItemOnSingleClick61Emit the activated signal when the user single clicks on an item in an item in an item view. Otherwise the signal is emitted when the user double clicks on an item.
QStyle::SH_Slider_AbsoluteSetButtons64Which mouse buttons cause a slider to set the value to the position clicked on.
QStyle::SH_Slider_PageSetButtons65Which mouse buttons cause a slider to page step the value.
QStyle::SH_TabBar_ElideMode67The default eliding style for a tab bar.
QStyle::SH_DialogButtonLayout68Controls how buttons are laid out in a QDialogButtonBox, returns a QDialogButtonBox::ButtonLayout enum.
QStyle::SH_WizardStyle79Controls the look and feel of a QWizard. Returns a QWizard::WizardStyle enum.
QStyle::SH_FormLayoutWrapPolicy86Provides a default for how rows are wrapped in a QFormLayout. Returns a QFormLayout::RowWrapPolicy enum.
QStyle::SH_FormLayoutFieldGrowthPolicy89Provides a default for how fields can grow in a QFormLayout. Returns a QFormLayout::FieldGrowthPolicy enum.
QStyle::SH_FormLayoutFormAlignment90Provides a default for how a QFormLayout aligns its contents within the available space. Returns a Qt::Alignment enum.
QStyle::SH_FormLayoutLabelAlignment91Provides a default for how a QFormLayout aligns labels within the available space. Returns a Qt::Alignment enum.
QStyle::SH_ItemView_ArrowKeysNavigateIntoChildren80Controls whether the tree view will select the first child when it is exapanded and the right arrow key is pressed.
QStyle::SH_ComboBox_PopupFrameStyle69The frame style used when drawing a combobox popup menu.
QStyle::SH_DialogButtonBox_ButtonsHaveIcons71Indicates whether or not StandardButtons in QDialogButtonBox should have icons or not.
QStyle::SH_ItemView_MovementWithoutUpdatingSelection75The item view is able to indicate a current item without changing the selection.
QStyle::SH_ToolTip_Mask76The mask of a tool tip.
QStyle::SH_FocusFrame_AboveWidget77The FocusFrame is stacked above the widget that it is "focusing on".
QStyle::SH_TextControl_FocusIndicatorTextCharFormat78Specifies the text format used to highlight focused anchors in rich text documents displayed for example in QTextBrowser. The format has to be a QTextCharFormat returned in the variant of the QStyleHintReturnVariant return value. The QTextFormat::OutlinePen property is used for the outline and QTextFormat::BackgroundBrush for the background of the highlighted area.
QStyle::SH_Menu_FlashTriggeredItem82Flash triggered item.
QStyle::SH_Menu_FadeOutOnHide83Fade out the menu instead of hiding it immediately.
QStyle::SH_TabWidget_DefaultTabPosition87Default position of the tab bar in a tab widget.
QStyle::SH_ToolBar_Movable88Determines if the tool bar is movable by default.
QStyle::SH_ItemView_PaintAlternatingRowColorsForEmptyArea85Whether QTreeView paints alternating row colors for the area that does not have any items.
QStyle::SH_Menu_Mask81The mask for a popup menu.
QStyle::SH_ItemView_DrawDelegateFrame92Determines if there should be a frame for a delegate widget.
QStyle::SH_TabBar_CloseButtonPosition93Determines the position of the close button on a tab in a tab bar.
QStyle::SH_DockWidget_ButtonsHaveFrame94Determines if dockwidget buttons should have frames. Default is true.
QStyle::SH_ToolButtonStyle95Determines the default system style for tool buttons that uses Qt::ToolButtonFollowStyle.
QStyle::SH_RequestSoftwareInputPanel96Determines when a software input panel should be requested by input widgets. Returns an enum of type QStyle::RequestSoftwareInputPanel.
QStyle::SH_ScrollBar_Transient97Determines if the style supports transient scroll bars. Transient scroll bars appear when the content is scrolled and disappear when they are no longer needed.
QStyle::SH_Menu_SupportsSections98Determines if the style displays sections in menus or treat them as plain separators. Sections are separators with a text and icon hint.
QStyle::SH_ToolTip_WakeUpDelay99Determines the delay before a tooltip is shown, in milliseconds.
QStyle::SH_ToolTip_FallAsleepDelay100Determines the delay (in milliseconds) before a new wake time is needed when a tooltip is shown (notice: shown, not hidden). When a new wake isn't needed, a user-requested tooltip will be shown nearly instantly.
QStyle::SH_Widget_Animate101Deprecated. Use SH_Widget_Animation_Duration instead.
QStyle::SH_Splitter_OpaqueResize102Determines if widgets are resized dynamically (opaquely) while interactively moving the splitter. This enum value was introduced in Qt 5.2.
QStyle::SH_TabBar_ChangeCurrentDelay105Determines the delay before the current tab is changed while dragging over the tabbar, in milliseconds. This enum value has been introduced in Qt 5.4
QStyle::SH_ItemView_ScrollMode112The default vertical and horizontal scroll mode as specified by the style. Can be overridden with QAbstractItemView::setVerticalScrollMode() and QAbstractItemView::setHorizontalScrollMode(). This enum value has been introduced in Qt 5.7.
QStyle::SH_TitleBar_ShowToolTipsOnButtons113Determines if tool tips are shown on window title bar buttons. The Mac style, for example, sets this to false. This enum value has been introduced in Qt 5.10.
QStyle::SH_Widget_Animation_Duration114Determines how much an animation should last (in ms). A value equal to zero means that the animations will be disabled. This enum value has been introduced in Qt 5.10.
QStyle::SH_ComboBox_AllowWheelScrolling115Determines if the mouse wheel can be used to scroll inside a QComboBox. This is on by default in all styles except the Mac style. This enum value has been introduced in Qt 5.10.
QStyle::SH_SpinBox_ButtonsInsideFrame116Determines if the spin box buttons are inside the line edit frame. This enum value has been introduced in Qt 5.11.
QStyle::SH_SpinBox_StepModifier117Determines which Qt::KeyboardModifier increases the step rate of QAbstractSpinBox. Possible values are Qt::NoModifier, Qt::ControlModifier (default) or Qt::ShiftModifier. Qt::NoModifier disables this feature. This enum value has been introduced in Qt 5.12.

See also styleHint().

enum QStyle::SubControl
flags QStyle::SubControls

This enum describes the available sub controls. A subcontrol is a control element within a complex control (ComplexControl).

ConstantValueDescription
QStyle::SC_None0x00000000Special value that matches no other sub control.
QStyle::SC_ScrollBarAddLine0x00000001Scroll bar add line (i.e., down/right arrow); see also QScrollBar.
QStyle::SC_ScrollBarSubLine0x00000002Scroll bar sub line (i.e., up/left arrow).
QStyle::SC_ScrollBarAddPage0x00000004Scroll bar add page (i.e., page down).
QStyle::SC_ScrollBarSubPage0x00000008Scroll bar sub page (i.e., page up).
QStyle::SC_ScrollBarFirst0x00000010Scroll bar first line (i.e., home).
QStyle::SC_ScrollBarLast0x00000020Scroll bar last line (i.e., end).
QStyle::SC_ScrollBarSlider0x00000040Scroll bar slider handle.
QStyle::SC_ScrollBarGroove0x00000080Special sub-control which contains the area in which the slider handle may move.
QStyle::SC_SpinBoxUp0x00000001Spin widget up/increase; see also QSpinBox.
QStyle::SC_SpinBoxDown0x00000002Spin widget down/decrease.
QStyle::SC_SpinBoxFrame0x00000004Spin widget frame.
QStyle::SC_SpinBoxEditField0x00000008Spin widget edit field.
QStyle::SC_ComboBoxEditField0x00000002Combobox edit field; see also QComboBox.
QStyle::SC_ComboBoxArrow0x00000004Combobox arrow button.
QStyle::SC_ComboBoxFrame0x00000001Combobox frame.
QStyle::SC_ComboBoxListBoxPopup0x00000008The reference rectangle for the combobox popup. Used to calculate the position of the popup.
QStyle::SC_SliderGroove0x00000001Special sub-control which contains the area in which the slider handle may move.
QStyle::SC_SliderHandle0x00000002Slider handle.
QStyle::SC_SliderTickmarks0x00000004Slider tickmarks.
QStyle::SC_ToolButton0x00000001Tool button (see also QToolButton).
QStyle::SC_ToolButtonMenu0x00000002Sub-control for opening a popup menu in a tool button.
QStyle::SC_TitleBarSysMenu0x00000001System menu button (i.e., restore, close, etc.).
QStyle::SC_TitleBarMinButton0x00000002Minimize button.
QStyle::SC_TitleBarMaxButton0x00000004Maximize button.
QStyle::SC_TitleBarCloseButton0x00000008Close button.
QStyle::SC_TitleBarLabel0x00000100Window title label.
QStyle::SC_TitleBarNormalButton0x00000010Normal (restore) button.
QStyle::SC_TitleBarShadeButton0x00000020Shade button.
QStyle::SC_TitleBarUnshadeButton0x00000040Unshade button.
QStyle::SC_TitleBarContextHelpButton0x00000080Context Help button.
QStyle::SC_DialHandle0x00000002The handle of the dial (i.e. what you use to control the dial).
QStyle::SC_DialGroove0x00000001The groove for the dial.
QStyle::SC_DialTickmarks0x00000004The tickmarks for the dial.
QStyle::SC_GroupBoxFrame0x00000008The frame of a group box.
QStyle::SC_GroupBoxLabel0x00000002The title of a group box.
QStyle::SC_GroupBoxCheckBox0x00000001The optional check box of a group box.
QStyle::SC_GroupBoxContents0x00000004The group box contents.
QStyle::SC_MdiNormalButton0x00000002The normal button for a MDI subwindow in the menu bar.
QStyle::SC_MdiMinButton0x00000001The minimize button for a MDI subwindow in the menu bar.
QStyle::SC_MdiCloseButton0x00000004The close button for a MDI subwindow in the menu bar.
QStyle::SC_All0xffffffffSpecial value that matches all sub-controls.

The SubControls type is a typedef for QFlags<SubControl>. It stores an OR combination of SubControl values.

See also ComplexControl.

enum QStyle::SubElement

This enum represents a sub-area of a widget. Style implementations use these areas to draw the different parts of a widget.

ConstantValueDescription
QStyle::SE_PushButtonContents0Area containing the label (icon with text or pixmap).
QStyle::SE_PushButtonFocusRect1Area for the focus rect (usually larger than the contents rect).
QStyle::SE_PushButtonLayoutItem38Area that counts for the parent layout.
QStyle::SE_PushButtonBevel57[since 5.15] Area used for the bevel of the button.
QStyle::SE_CheckBoxIndicator2Area for the state indicator (e.g., check mark).
QStyle::SE_CheckBoxContents3Area for the label (text or pixmap).
QStyle::SE_CheckBoxFocusRect4Area for the focus indicator.
QStyle::SE_CheckBoxClickRect5Clickable area, defaults to SE_CheckBoxFocusRect.
QStyle::SE_CheckBoxLayoutItem32Area that counts for the parent layout.
QStyle::SE_DateTimeEditLayoutItem34Area that counts for the parent layout.
QStyle::SE_RadioButtonIndicator6Area for the state indicator.
QStyle::SE_RadioButtonContents7Area for the label.
QStyle::SE_RadioButtonFocusRect8Area for the focus indicator.
QStyle::SE_RadioButtonClickRect9Clickable area, defaults to SE_RadioButtonFocusRect.
QStyle::SE_RadioButtonLayoutItem39Area that counts for the parent layout.
QStyle::SE_ComboBoxFocusRect10Area for the focus indicator.
QStyle::SE_SliderFocusRect11Area for the focus indicator.
QStyle::SE_SliderLayoutItem40Area that counts for the parent layout.
QStyle::SE_SpinBoxLayoutItem41Area that counts for the parent layout.
QStyle::SE_ProgressBarGroove12Area for the groove.
QStyle::SE_ProgressBarContents13Area for the progress indicator.
QStyle::SE_ProgressBarLabel14Area for the text label.
QStyle::SE_ProgressBarLayoutItem37Area that counts for the parent layout.
QStyle::SE_FrameContents27Area for a frame's contents.
QStyle::SE_ShapedFrameContents52Area for a frame's contents using the shape in QStyleOptionFrame; see QFrame
QStyle::SE_FrameLayoutItem43Area that counts for the parent layout.
QStyle::SE_HeaderArrow17Area for the sort indicator for a header.
QStyle::SE_HeaderLabel16Area for the label in a header.
QStyle::SE_LabelLayoutItemSE_DateTimeEditLayoutItem + 2Area that counts for the parent layout.
QStyle::SE_LineEditContents26Area for a line edit's contents.
QStyle::SE_TabWidgetLeftCorner21Area for the left corner widget in a tab widget.
QStyle::SE_TabWidgetRightCorner22Area for the right corner widget in a tab widget.
QStyle::SE_TabWidgetTabBar18Area for the tab bar widget in a tab widget.
QStyle::SE_TabWidgetTabContents20Area for the contents of the tab widget.
QStyle::SE_TabWidgetTabPane19Area for the pane of a tab widget.
QStyle::SE_TabWidgetLayoutItem45Area that counts for the parent layout.
QStyle::SE_ToolBoxTabContents15Area for a toolbox tab's icon and label.
QStyle::SE_ToolButtonLayoutItem42Area that counts for the parent layout.
QStyle::SE_ItemViewItemCheckIndicator23Area for a view item's check mark.
QStyle::SE_TabBarTearIndicator24Deprecated. Use SE_TabBarTearIndicatorLeft instead.
QStyle::SE_TabBarTearIndicatorLeftSE_TabBarTearIndicatorArea for the tear indicator on the left side of a tab bar with scroll arrows.
QStyle::SE_TabBarTearIndicatorRight56Area for the tear indicator on the right side of a tab bar with scroll arrows.
QStyle::SE_TabBarScrollLeftButton54Area for the scroll left button on a tab bar with scroll buttons.
QStyle::SE_TabBarScrollRightButton55Area for the scroll right button on a tab bar with scroll buttons.
QStyle::SE_TreeViewDisclosureItem25Area for the actual disclosure item in a tree branch.
QStyle::SE_GroupBoxLayoutItem44Area that counts for the parent layout.
QStyle::SE_CustomBase0xf0000000Base value for custom sub-elements. Custom values must be greater than this value.
QStyle::SE_DockWidgetFloatButton29The float button of a dock widget.
QStyle::SE_DockWidgetTitleBarText30The text bounds of the dock widgets title.
QStyle::SE_DockWidgetCloseButton28The close button of a dock widget.
QStyle::SE_DockWidgetIcon31The icon of a dock widget.
QStyle::SE_ComboBoxLayoutItem33Area that counts for the parent layout.
QStyle::SE_ItemViewItemDecoration46Area for a view item's decoration (icon).
QStyle::SE_ItemViewItemText47Area for a view item's text.
QStyle::SE_ItemViewItemFocusRect48Area for a view item's focus rect.
QStyle::SE_TabBarTabLeftButton49Area for a widget on the left side of a tab in a tab bar.
QStyle::SE_TabBarTabRightButton50Area for a widget on the right side of a tab in a tab bar.
QStyle::SE_TabBarTabText51Area for the text on a tab in a tab bar.
QStyle::SE_ToolBarHandle53Area for the handle of a tool bar.

See also subElementRect().

Member Function Documentation

QStyle::QStyle()

Constructs a style object.

[virtual] QStyle::~QStyle()

Destroys the style object.

[static] QRect QStyle::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.

int QStyle::combinedLayoutSpacing(QSizePolicy::ControlTypes controls1, QSizePolicy::ControlTypes controls2, Qt::Orientation orientation, QStyleOption *option = nullptr, QWidget *widget = nullptr) const

Returns the spacing that should be used between controls1 and controls2 in a layout. orientation specifies whether the controls are laid out side by side or stacked vertically. The option parameter can be used to pass extra information about the parent widget. The widget parameter is optional and can also be used if option is nullptr.

controls1 and controls2 are OR-combination of zero or more control types.

This function is called by the layout system. It is used only if PM_LayoutHorizontalSpacing or PM_LayoutVerticalSpacing returns a negative value.

This function was introduced in Qt 4.3.

See also layoutSpacing().

[pure virtual] void QStyle::drawComplexControl(QStyle::ComplexControl control, const QStyleOptionComplex *option, QPainter *painter, const QWidget *widget = nullptr) const

Draws the given control using the provided painter with the style options specified by option.

The widget argument is optional and can be used as aid in drawing the control.

The option parameter is a pointer to a QStyleOptionComplex object that can be cast to the correct subclass using the qstyleoption_cast() function. Note that the rect member of the specified option must be in logical coordinates. Reimplementations of this function should use visualRect() to change the logical coordinates into screen coordinates before calling the drawPrimitive() or drawControl() function.

The table below is listing the complex control elements and their associated style option subclass. The style options contain all the parameters required to draw the controls, including QStyleOption::state which holds the style flags that are used when drawing. The table also describes which flags that are set when casting the given option to the appropriate subclass.

Complex ControlQStyleOptionComplex SubclassStyle FlagRemark
CC_SpinBoxQStyleOptionSpinBoxState_EnabledSet if the spin box is enabled.
State_HasFocusSet if the spin box has input focus.
CC_ComboBoxQStyleOptionComboBoxState_EnabledSet if the combobox is enabled.
State_HasFocusSet if the combobox has input focus.
CC_ScrollBarQStyleOptionSliderState_EnabledSet if the scroll bar is enabled.
State_HasFocusSet if the scroll bar has input focus.
CC_SliderQStyleOptionSliderState_EnabledSet if the slider is enabled.
State_HasFocusSet if the slider has input focus.
CC_DialQStyleOptionSliderState_EnabledSet if the dial is enabled.
State_HasFocusSet if the dial has input focus.
CC_ToolButtonQStyleOptionToolButtonState_EnabledSet if the tool button is enabled.
State_HasFocusSet if the tool button has input focus.
State_DownArrowSet if the tool button is down (i.e., a mouse button or the space bar is pressed).
State_OnSet if the tool button is a toggle button and is toggled on.
State_AutoRaiseSet if the tool button has auto-raise enabled.
State_RaisedSet if the button is not down, not on, and doesn't contain the mouse when auto-raise is enabled.
CC_TitleBarQStyleOptionTitleBarState_EnabledSet if the title bar is enabled.

See also drawPrimitive() and drawControl().

[pure virtual] void QStyle::drawControl(QStyle::ControlElement element, const QStyleOption *option, QPainter *painter, const QWidget *widget = nullptr) const

Draws the given element with the provided painter with the style options specified by option.

The widget argument is optional and can be used as aid in drawing the control. The option parameter is a pointer to a QStyleOption object that can be cast to the correct subclass using the qstyleoption_cast() function.

The table below is listing the control elements and their associated style option subclass. The style options contain all the parameters required to draw the controls, including QStyleOption::state which holds the style flags that are used when drawing. The table also describes which flags that are set when casting the given option to the appropriate subclass.

Note that if a control element is not listed here, it is because it uses a plain QStyleOption object.

Control ElementQStyleOption SubclassStyle FlagRemark
CE_MenuItem, CE_MenuBarItemQStyleOptionMenuItemState_SelectedThe menu item is currently selected item.
State_EnabledThe item is enabled.
State_DownArrowIndicates that a scroll down arrow should be drawn.
State_UpArrowIndicates that a scroll up arrow should be drawn
State_HasFocusSet if the menu bar has input focus.
CE_PushButton, CE_PushButtonBevel, CE_PushButtonLabelQStyleOptionButtonState_EnabledSet if the button is enabled.
State_HasFocusSet if the button has input focus.
State_RaisedSet if the button is not down, not on and not flat.
State_OnSet if the button is a toggle button and is toggled on.
State_SunkenSet if the button is down (i.e., the mouse button or the space bar is pressed on the button).
CE_RadioButton, CE_RadioButtonLabel, CE_CheckBox, CE_CheckBoxLabelQStyleOptionButtonState_EnabledSet if the button is enabled.
State_HasFocusSet if the button has input focus.
State_OnSet if the button is checked.
State_OffSet if the button is not checked.
State_NoChangeSet if the button is in the NoChange state.
State_SunkenSet if the button is down (i.e., the mouse button or the space bar is pressed on the button).
CE_ProgressBarContents, CE_ProgressBarLabel, CE_ProgressBarGrooveQStyleOptionProgressBarState_EnabledSet if the progress bar is enabled.
State_HasFocusSet if the progress bar has input focus.
CE_Header, CE_HeaderSection, CE_HeaderLabelQStyleOptionHeader
CE_TabBarTab, CE_TabBarTabShape, CE_TabBarTabLabelQStyleOptionTabState_EnabledSet if the tab bar is enabled.
State_SelectedThe tab bar is the currently selected tab bar.
State_HasFocusSet if the tab bar tab has input focus.
CE_ToolButtonLabelQStyleOptionToolButtonState_EnabledSet if the tool button is enabled.
State_HasFocusSet if the tool button has input focus.
State_SunkenSet if the tool button is down (i.e., a mouse button or the space bar is pressed).
State_OnSet if the tool button is a toggle button and is toggled on.
State_AutoRaiseSet if the tool button has auto-raise enabled.
State_MouseOverSet if the mouse pointer is over the tool button.
State_RaisedSet if the button is not down and is not on.
CE_ToolBoxTabQStyleOptionToolBoxState_SelectedThe tab is the currently selected tab.
CE_HeaderSectionQStyleOptionHeaderState_SunkenIndicates that the section is pressed.
State_UpArrowIndicates that the sort indicator should be pointing up.
State_DownArrowIndicates that the sort indicator should be pointing down.

See also drawPrimitive() and drawComplexControl().

[virtual] void QStyle::drawItemPixmap(QPainter *painter, const QRect &rectangle, int alignment, const QPixmap &pixmap) const

Draws the given pixmap in the specified rectangle, according to the specified alignment, using the provided painter.

See also drawItemText().

[virtual] void QStyle::drawItemText(QPainter *painter, const QRect &rectangle, int alignment, const QPalette &palette, 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.

The text is drawn using the painter's pen, and aligned and wrapped according to the specified alignment. If an explicit textRole is specified, the text is drawn using the palette's color for the given role. The enabled parameter indicates whether or not the item is enabled; when reimplementing this function, the enabled parameter should influence how the item is drawn.

See also Qt::Alignment and drawItemPixmap().

[pure virtual] void QStyle::drawPrimitive(QStyle::PrimitiveElement element, const QStyleOption *option, QPainter *painter, const QWidget *widget = nullptr) const

Draws the given primitive element with the provided painter using the style options specified by option.

The widget argument is optional and may contain a widget that may aid in drawing the primitive element.

The table below is listing the primitive elements and their associated style option subclasses. The style options contain all the parameters required to draw the elements, including QStyleOption::state which holds the style flags that are used when drawing. The table also describes which flags that are set when casting the given option to the appropriate subclass.

Note that if a primitive element is not listed here, it is because it uses a plain QStyleOption object.

Primitive ElementQStyleOption SubclassStyle FlagRemark
PE_FrameFocusRectQStyleOptionFocusRectState_FocusAtBorderWhether the focus is is at the border or inside the widget.
PE_IndicatorCheckBoxQStyleOptionButtonState_NoChangeIndicates a "tri-state" checkbox.
State_OnIndicates the indicator is checked.
PE_IndicatorRadioButtonQStyleOptionButtonState_OnIndicates that a radio button is selected.
State_NoChangeIndicates a "tri-state" controller.
State_EnabledIndicates the controller is enabled.
PE_IndicatorBranchQStyleOptionState_ChildrenIndicates that the control for expanding the tree to show child items, should be drawn.
State_ItemIndicates that a horizontal branch (to show a child item), should be drawn.
State_OpenIndicates that the tree branch is expanded.
State_SiblingIndicates that a vertical line (to show a sibling item), should be drawn.
PE_IndicatorHeaderArrowQStyleOptionHeaderState_UpArrowIndicates that the arrow should be drawn up; otherwise it should be down.
PE_FrameGroupBox, PE_Frame, PE_FrameLineEdit, PE_FrameMenu, PE_FrameDockWidget, PE_FrameWindowQStyleOptionFrameState_SunkenIndicates that the Frame should be sunken.
PE_IndicatorToolBarHandleQStyleOptionState_HorizontalIndicates that the window handle is horizontal instead of vertical.
PE_IndicatorSpinPlus, PE_IndicatorSpinMinus, PE_IndicatorSpinUp, PE_IndicatorSpinDown,QStyleOptionSpinBoxState_SunkenIndicates that the button is pressed.
PE_PanelButtonCommandQStyleOptionButtonState_EnabledSet if the button is enabled.
State_HasFocusSet if the button has input focus.
State_RaisedSet if the button is not down, not on and not flat.
State_OnSet if the button is a toggle button and is toggled on.
State_SunkenSet if the button is down (i.e., the mouse button or the space bar is pressed on the button).

See also drawComplexControl() and drawControl().

[pure virtual] QPixmap QStyle::generatedIconPixmap(QIcon::Mode iconMode, const QPixmap &pixmap, const QStyleOption *option) const

Returns a copy of the given pixmap, styled to conform to the specified iconMode and taking into account the palette specified by option.

The option parameter can pass extra information, but it must contain a palette.

Note that not all pixmaps will conform, in which case the returned pixmap is a plain copy.

See also QIcon.

[pure virtual] QStyle::SubControl QStyle::hitTestComplexControl(QStyle::ComplexControl control, const QStyleOptionComplex *option, const QPoint &position, const QWidget *widget = nullptr) const

Returns the sub control at the given position in the given complex control (with the style options specified by option).

Note that the position is expressed in screen coordinates.

The option argument is a pointer to a QStyleOptionComplex object (or one of its subclasses). The object can be cast to the appropriate type using the qstyleoption_cast() function. See drawComplexControl() for details. The widget argument is optional and can contain additional information for the function.

See also drawComplexControl() and subControlRect().

[virtual] QRect QStyle::itemPixmapRect(const QRect &rectangle, int alignment, const QPixmap &pixmap) const

Returns the area within the given rectangle in which to draw the specified pixmap according to the defined alignment.

[virtual] QRect QStyle::itemTextRect(const QFontMetrics &metrics, const QRect &rectangle, int alignment, 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. The enabled parameter indicates whether or not the associated item is enabled.

If the given rectangle is larger than the area needed to render the text, the rectangle that is returned will be offset within rectangle according to the specified alignment. For example, if alignment is Qt::AlignCenter, the returned rectangle will be centered within rectangle. If the given rectangle is smaller than the area needed, the returned rectangle will be the smallest rectangle large enough to render the text.

See also Qt::Alignment.

[pure virtual] int QStyle::layoutSpacing(QSizePolicy::ControlType control1, QSizePolicy::ControlType control2, Qt::Orientation orientation, const QStyleOption *option = nullptr, const QWidget *widget = nullptr) const

Returns the spacing that should be used between control1 and control2 in a layout. orientation specifies whether the controls are laid out side by side or stacked vertically. The option parameter can be used to pass extra information about the parent widget. The widget parameter is optional and can also be used if option is nullptr.

This function is called by the layout system. It is used only if PM_LayoutHorizontalSpacing or PM_LayoutVerticalSpacing returns a negative value.

This function was introduced in Qt 4.3.

See also combinedLayoutSpacing().

[pure virtual] int QStyle::pixelMetric(QStyle::PixelMetric metric, const QStyleOption *option = nullptr, const QWidget *widget = nullptr) const

Returns the value of the given pixel metric.

The specified option and widget can be used for calculating the metric. In general, the widget argument is not used. The option can be cast to the appropriate type using the qstyleoption_cast() function. Note that the option may be zero even for PixelMetrics that can make use of it. See the table below for the appropriate option casts:

Some pixel metrics are called from widgets and some are only called internally by the style. If the metric is not called by a widget, it is the discretion of the style author to make use of it. For some styles, this may not be appropriate.

[virtual] void QStyle::polish(QWidget *widget)

Initializes the appearance of the given widget.

This function is called for every widget at some point after it has been fully created but just before it is shown for the very first time.

Note that the default implementation does nothing. Reasonable actions in this function might be to call the QWidget::setBackgroundMode() function for the widget. Do not use the function to set, for example, the geometry. Reimplementing this function provides a back-door through which the appearance of a widget can be changed, but with Qt's style engine it is rarely necessary to implement this function; reimplement drawItemPixmap(), drawItemText(), drawPrimitive(), etc. instead.

The QWidget::inherits() function may provide enough information to allow class-specific customizations. But because new QStyle subclasses are expected to work reasonably with all current and future widgets, limited use of hard-coded customization is recommended.

See also unpolish().

[virtual] void QStyle::polish(QApplication *application)

This is an overloaded function.

Late initialization of the given application object.

[virtual] void QStyle::polish(QPalette &palette)

This is an overloaded function.

Changes the palette according to style specific requirements for color palettes (if any).

See also QPalette and QApplication::setPalette().

const QStyle *QStyle::proxy() const

This function returns the current proxy for this style. By default most styles will return themselves. However when a proxy style is in use, it will allow the style to call back into its proxy.

This function was introduced in Qt 4.6.

[pure virtual] QSize QStyle::sizeFromContents(QStyle::ContentsType type, const QStyleOption *option, const QSize &contentsSize, const QWidget *widget = nullptr) const

Returns the size of the element described by the specified option and type, based on the provided contentsSize.

The option argument is a pointer to a QStyleOption or one of its subclasses. The option can be cast to the appropriate type using the qstyleoption_cast() function. The widget is an optional argument and can contain extra information used for calculating the size.

See the table below for the appropriate option casts:

See also ContentsType and QStyleOption.

[static] int QStyle::sliderPositionFromValue(int min, int max, int logicalValue, int span, bool upsideDown = false)

Converts the given logicalValue to a pixel position. The min parameter maps to 0, max maps to span and other values are distributed evenly in-between.

This function can handle the entire integer range without overflow, providing that span is less than 4096.

By default, this function assumes that the maximum value is on the right for horizontal items and on the bottom for vertical items. Set the upsideDown parameter to true to reverse this behavior.

See also sliderValueFromPosition().

[static] int QStyle::sliderValueFromPosition(int min, int max, int position, int span, bool upsideDown = false)

Converts the given pixel position to a logical value. 0 maps to the min parameter, span maps to max and other values are distributed evenly in-between.

This function can handle the entire integer range without overflow.

By default, this function assumes that the maximum value is on the right for horizontal items and on the bottom for vertical items. Set the upsideDown parameter to true to reverse this behavior.

See also sliderPositionFromValue().

[pure virtual] QIcon QStyle::standardIcon(QStyle::StandardPixmap standardIcon, const QStyleOption *option = 0, const QWidget *widget = 0) const

Returns an icon for the given standardIcon.

The standardIcon is a standard pixmap which can follow some existing GUI style or guideline. The option argument can be used to pass extra information required when defining the appropriate icon. The widget argument is optional and can also be used to aid the determination of the icon.

This function was introduced in Qt 4.1.

[virtual] QPalette QStyle::standardPalette() const

Returns the style's standard palette.

Note that on systems that support system colors, the style's standard palette is not used. In particular, the Windows Vista and Mac styles do not use the standard palette, but make use of native theme engines. With these styles, you should not set the palette with QApplication::setPalette().

See also QApplication::setPalette().

[pure virtual] int QStyle::styleHint(QStyle::StyleHint hint, const QStyleOption *option = nullptr, const QWidget *widget = nullptr, QStyleHintReturn *returnData = nullptr) const

Returns an integer representing the specified style hint for the given widget described by the provided style option.

returnData is used when the querying widget needs more detailed data than the integer that styleHint() returns. See the QStyleHintReturn class description for details.

[pure virtual] QRect QStyle::subControlRect(QStyle::ComplexControl control, const QStyleOptionComplex *option, QStyle::SubControl subControl, const QWidget *widget = nullptr) const

Returns the rectangle containing the specified subControl of the given complex control (with the style specified by option). The rectangle is defined in screen coordinates.

The option argument is a pointer to QStyleOptionComplex or one of its subclasses, and can be cast to the appropriate type using the qstyleoption_cast() function. See drawComplexControl() for details. The widget is optional and can contain additional information for the function.

See also drawComplexControl().

[pure virtual] QRect QStyle::subElementRect(QStyle::SubElement element, const QStyleOption *option, const QWidget *widget = nullptr) const

Returns the sub-area for the given element as described in the provided style option. The returned rectangle is defined in screen coordinates.

The widget argument is optional and can be used to aid determining the area. The QStyleOption object can be cast to the appropriate type using the qstyleoption_cast() function. See the table below for the appropriate option casts:

[virtual] void QStyle::unpolish(QWidget *widget)

Uninitialize the given widget's appearance.

This function is the counterpart to polish(). It is called for every polished widget whenever the style is dynamically changed; the former style has to unpolish its settings before the new style can polish them again.

Note that unpolish() will only be called if the widget is destroyed. This can cause problems in some cases, e.g, if you remove a widget from the UI, cache it, and then reinsert it after the style has changed; some of Qt's classes cache their widgets.

See also polish().

[virtual] void QStyle::unpolish(QApplication *application)

This is an overloaded function.

Uninitialize the given application.

[static] Qt::Alignment QStyle::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. The other alignment flags are left untouched.

If no horizontal alignment was specified, the function returns the default alignment for the given layout direction.

QWidget::layoutDirection

[static] QPoint QStyle::visualPos(Qt::LayoutDirection direction, const QRect &boundingRectangle, const QPoint &logicalPosition)

Returns the given logicalPosition converted to screen coordinates based on the specified direction. The boundingRectangle is used when performing the translation.

See also QWidget::layoutDirection.

[static] QRect QStyle::visualRect(Qt::LayoutDirection direction, const QRect &boundingRectangle, const QRect &logicalRectangle)

Returns the given logicalRectangle converted to screen coordinates based on the specified direction. The boundingRectangle is used when performing the translation.

This function is provided to support right-to-left desktops, and is typically used in implementations of the subControlRect() function.

See also QWidget::layoutDirection.

© 2023 The Qt Company Ltd. Documentation contributions included herein are the copyrights of their respective owners. The documentation provided herein is licensed under the terms of the GNU Free Documentation License version 1.3 as published by the Free Software Foundation. Qt and respective logos are trademarks of The Qt Company Ltd. in Finland and/or other countries worldwide. All other trademarks are property of their respective owners.