CopperSpice API  1.7.4
QStyle Class Referenceabstract

Abstract base class that encapsulates the look and feel of a GUI. More...

Inheritance diagram for QStyle:
QObject QCommonStyle QFusionStyle QGtkStyle QMacStyle QProxyStyle QWindowsStyle QWindowsXPStyle QWindowsVistaStyle

Public Typedefs

using State = QFlags< StateFlag >
 
using SubControls = QFlags< SubControl >
 

Public Types

enum  ComplexControl
 
enum  ContentsType
 
enum  ControlElement
 
enum  PixelMetric
 
enum  PrimitiveElement
 
enum  RequestSoftwareInputPanel
 
enum  StandardPixmap
 
enum  StateFlag
 
enum  StyleHint
 
enum  SubControl
 
enum  SubElement
 

Public Methods

 QStyle ()
 
virtual ~QStyle ()
 
int combinedLayoutSpacing (QSizePolicy::ControlTypes controls1, QSizePolicy::ControlTypes controls2, Qt::Orientation orientation, QStyleOption *option=nullptr, QWidget *widget=nullptr) const
 
virtual void drawComplexControl (ComplexControl control, const QStyleOptionComplex *option, QPainter *painter, const QWidget *widget=nullptr) const = 0
 
virtual void drawControl (ControlElement element, const QStyleOption *option, QPainter *painter, const QWidget *widget=nullptr) const = 0
 
virtual void drawItemPixmap (QPainter *painter, const QRect &rect, int alignment, const QPixmap &pixmap) const
 
virtual void drawItemText (QPainter *painter, const QRect &rect, int alignment, const QPalette &palette, bool enabled, const QString &text, QPalette::ColorRole textRole=QPalette::NoRole) const
 
virtual void drawPrimitive (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 SubControl hitTestComplexControl (ComplexControl control, const QStyleOptionComplex *option, const QPoint &position, const QWidget *widget=nullptr) const = 0
 
virtual QRect itemPixmapRect (const QRect &rect, int alignment, const QPixmap &pixmap) const
 
virtual QRect itemTextRect (const QFontMetrics &metrics, const QRect &rect, 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 (PixelMetric metric, const QStyleOption *option=nullptr, const QWidget *widget=nullptr) const = 0
 
virtual void polish (QApplication *application)
 
virtual void polish (QPalette &palette)
 
virtual void polish (QWidget *widget)
 
const QStyle * proxy () const
 
virtual QSize sizeFromContents (ContentsType type, const QStyleOption *option, const QSize &contentsSize, const QWidget *widget=nullptr) const = 0
 
virtual QIcon standardIcon (StandardPixmap standardIcon, const QStyleOption *option=nullptr, const QWidget *widget=nullptr) const = 0
 
virtual QPalette standardPalette () const
 
virtual QPixmap standardPixmap (StandardPixmap standardPixmap, const QStyleOption *option=nullptr, const QWidget *widget=nullptr) const = 0
 
virtual int styleHint (StyleHint styleHint, const QStyleOption *option=nullptr, const QWidget *widget=nullptr, QStyleHintReturn *styleHintReturn=nullptr) const = 0
 
virtual QRect subControlRect (ComplexControl control, const QStyleOptionComplex *option, SubControl subControl, const QWidget *widget=nullptr) const = 0
 
virtual QRect subElementRect (SubElement subElement, const QStyleOption *option, const QWidget *widget=nullptr) const = 0
 
virtual void unpolish (QApplication *application)
 
virtual void unpolish (QWidget *widget)
 
- Public Methods inherited from QObject
 QObject (QObject *parent=nullptr)
 
 ~QObject ()
 
bool blockSignals (bool block)
 
const QList< QObject * > & children () const
 
bool connect (const QObject *sender, const QString &signalMethod, const QString &location, const QString &slotMethod, Qt::ConnectionType type=Qt::AutoConnection)
 
bool connect (const QObject *sender, const QString &signalMethod, const QString &slotMethod, Qt::ConnectionType type=Qt::AutoConnection)
 
bool disconnect (const QObject *receiver, const QString &slotMethod=QString ()) const
 
bool disconnect (const QString &signalMethod, const QString &location, const QObject *receiver=nullptr, const QString &slotMethod=QString ()) const
 
bool disconnect (const QString &signalMethod=QString (), const QObject *receiver=nullptr, const QString &slotMethod=QString ()) const
 
void dumpObjectInfo ()
 
void dumpObjectTree ()
 
QList< QStringdynamicPropertyNames () const
 
virtual bool event (QEvent *event)
 
virtual bool eventFilter (QObject *watched, QEvent *event)
 
template<typename T >
findChild (const QString &childName=QString ()) const
 
template<class T >
QList< T > findChildren (const QRegularExpression &regExp, Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
 
template<class T >
QList< T > findChildren (const QString &objName=QString (), Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
 
bool inherits (const QString &className) const
 
void installEventFilter (QObject *filterObj)
 
bool isWidgetType () const
 
bool isWindowType () const
 
void killTimer (int id)
 
const QMetaObjectmetaObject () const
 
void moveToThread (QThread *targetThread)
 
QString objectName () const
 
QObject * parent () const
 
template<class T = QVariant>
property (const QString &name) const
 
void removeEventFilter (QObject *obj)
 
void setObjectName (const QString &name)
 
void setParent (QObject *parent)
 
bool setProperty (const QString &name, const QVariant &value)
 
bool signalsBlocked () const
 
int startTimer (int interval, Qt::TimerType timerType=Qt::CoarseTimer)
 
QThreadthread () const
 

Static Public Methods

static QRect alignedRect (Qt::LayoutDirection direction, Qt::Alignment alignment, const QSize &size, const QRect &rect)
 
static int sliderPositionFromValue (int min, int max, int logicalValue, int span, bool upsideDown=false)
 
static int sliderValueFromPosition (int min, int max, int position, int span, bool upsideDown=false)
 
static Qt::Alignment visualAlignment (Qt::LayoutDirection direction, Qt::Alignment alignment)
 
static QPoint visualPos (Qt::LayoutDirection direction, const QRect &boundingRect, const QPoint &logicalPosition)
 
static QRect visualRect (Qt::LayoutDirection direction, const QRect &boundingRect, const QRect &logicalRect)
 
- Static Public Methods inherited from QObject
static bool connect (const QObject *sender, const QMetaMethod &signalMethod, const QObject *receiver, const QMetaMethod &slotMethod, Qt::ConnectionType type=Qt::AutoConnection)
 
static bool connect (const QObject *sender, const QString &signalMethod, const QObject *receiver, const QString &slotMethod, Qt::ConnectionType type=Qt::AutoConnection, const QString &location=QString ())
 
static bool connect (const QObject *sender, const QString &signalMethod, const QString &location, const QObject *receiver, const QString &slotMethod, Qt::ConnectionType type=Qt::AutoConnection)
 
template<class Sender , class SignalClass , class... SignalArgs, class Receiver , class SlotClass , class... SlotArgs, class SlotReturn >
static bool connect (const Sender *sender, void (SignalClass::*signalMethod)(SignalArgs...), const Receiver *receiver, SlotReturn (SlotClass::*slotMethod)(SlotArgs...), Qt::ConnectionType type=Qt::AutoConnection)
 
template<class Sender , class SignalClass , class... SignalArgs, class Receiver , class T >
static bool connect (const Sender *sender, void (SignalClass::*signalMethod)(SignalArgs...), const Receiver *receiver, T slotLambda, Qt::ConnectionType type=Qt::AutoConnection)
 
static bool disconnect (const QObject *sender, const QMetaMethod &signalMethod, const QObject *receiver, const QMetaMethod &slotMethod)
 
static bool disconnect (const QObject *sender, const QString &signalMethod, const QObject *receiver, const QString &slotMethod)
 
static bool disconnect (const QObject *sender, const QString &signalMethod, const QString &location, const QObject *receiver, const QString &slotMethod)
 
static bool disconnect (const QObject *sender, std::nullptr_t, const QObject *receiver, std::nullptr_t)
 
template<class Sender , class SignalClass , class... SignalArgs, class Receiver , class SlotClass , class... SlotArgs, class SlotReturn >
static bool disconnect (const Sender *sender, void (SignalClass::*signalMethod)(SignalArgs...), const Receiver *receiver, SlotReturn (SlotClass::*slotMethod)(SlotArgs...))
 
template<class Sender , class SignalClass , class... SignalArgs, class Receiver >
static bool disconnect (const Sender *sender, void (SignalClass::*signalMethod)(SignalArgs...), const Receiver *receiver, std::nullptr_t slotMethod=nullptr)
 
template<class Sender , class SignalClass , class... SignalArgs, class Receiver , class T >
static bool disconnect (const Sender *sender, void (SignalClass::*signalMethod)(SignalArgs...), const Receiver *receiver, T slotMethod)
 
static QMetaObjectstaticMetaObject ()
 
static QString tr (const char *text, const char *comment=nullptr, std::optional< int > numArg=std::optional< int >())
 

Friends

class QApplication
 
class QProxyStyle
 
class QWidget
 

Additional Inherited Members

- Public Signals inherited from QObject
void destroyed (QObject *obj=nullptr)
 
void objectNameChanged (const QString &objectName)
 
- Public Slots inherited from QObject
void deleteLater ()
 
- Protected Methods inherited from QObject
virtual void childEvent (QChildEvent *event)
 
virtual void connectNotify (const QMetaMethod &signalMethod) const
 
virtual void customEvent (QEvent *event)
 
virtual void disconnectNotify (const QMetaMethod &signalMethod) const
 
bool isSignalConnected (const QMetaMethod &signalMethod) const
 
int receivers (const QString &signal) const
 
QObject * sender () const
 
int senderSignalIndex () const
 
virtual void timerEvent (QTimerEvent *event)
 
- Properties inherited from QObject
 objectName
 

Detailed Description

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

CopperSpice contains a set of QStyle subclasses which emulate the styles of the different platforms such as QWindowsStyle, QFusionStyle, QMacStyle, etc. By default these styles are built into CsGui. Styles can also be made available as plugins.

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

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, CopperSpice 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() method.

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);
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 Mac OS X), but it is not 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 CopperSpice provides the QStylePainter class, which combines a QStyle, a QPainter, and a QWidget. This makes it possible to write the following.

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 CopperSpice 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 CopperSpice 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 QWindowsStyle
{
CS_OBJECT(CustomStyle)
public:
CustomStyle()
~CustomStyle() {}
void drawPrimitive(PrimitiveElement element, const QStyleOption *option, QPainter *painter, const QWidget *widget) const;
};

To draw its up and down arrows, QSpinBox uses the PE_IndicatorSpinUp and PE_IndicatorSpinDown primitive elements. Here is 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 {
QWindowsStyle::drawPrimitive(element, option, painter, widget);
}
}

Notice that we do not 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 is not 0 and that it is of the correct type before using it.

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

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

Warning
CopperSpice 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. The simplest way is to pass the custom style to the QApplication::setStyle() static function before creating the QApplication object.

#include <QtGui>
#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, however by calling it before the constructor, you ensure the user's preference, set using the -style command-line option, is respected.

A style may be implemented as a plugin. Styles created as plugins are loaded as shared objects at runtime. Refer to Creating Plugins for more information on creating a plugin.

Style plugins should be located in the plugins/styles directory. To use your new style with an existing application, start the application with the following argument:

./myapplication -style custom

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:

  • subControlRect() and subElementRect() return rectangles in screen coordinates
  • QStyleOption::direction indicates in which direction the item should be drawn in
  • If a style is not right-to-left aware it will display items as if it were left-to-right
  • visualRect(), visualPos(), and visualAlignment() are helpful functions that will translate from logical to screen representations.
  • alignedRect() will return a logical rect aligned for the current direction

Styles in Item Views

The painting of items in views is performed by a delegate. the CopperSpice 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-architecture-c "Model/View Architecture".

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:
QWindowsStyle::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, QStyledItemDelegate

Member Typedef Documentation

Typedef for QFlags<StateFlag>. Refer to QStyle::StateFlag for documentation.

Typedef for QFlags<SubControl>. Refer to QStyle::SubControl for documentation.

Member Enumeration Documentation

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_SpinBox0Spinbox, like QSpinBox.
QStyle::CC_ComboBox1Combobox, like QComboBox.
QStyle::CC_ScrollBar2Scroll bar, like QScrollBar.
QStyle::CC_Slider3Slider, like QSlider.
QStyle::CC_ToolButton4Tool button, like QToolButton.
QStyle::CC_TitleBar5Title bar, like those used in QMdiSubWindow.
QStyle::CC_Dial6Dial, like QDial.
QStyle::CC_GroupBox7Group box, like QGroupBox.
QStyle::CC_MdiControls8 The minimize, close, and normal button in the menubar for a maximized MDI subwindow.
QStyle::CC_CustomBase0xf0000000 Base value for custom complex controls. Custom values must be greater than this value.
See also
QStyle::SubControl, drawComplexControl()

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

ConstantValueDescription
QStyle::CT_CheckBox0 Check box, like QCheckBox
QStyle::CT_ComboBox1 Combobox, like QComboBox
QStyle::CT_GroupBox2 Group box, like QGroupBox
QStyle::CT_HeaderSection 3 Header section, like QHeaderView
QStyle::CT_ItemViewItem4An item inside an item view
QStyle::CT_LineEdit5Line edit, like QLineEdit
QStyle::CT_MdiControls6 The minimize, normal, and close button in the menu bar for a maximized MDI subwindow
QStyle::CT_Menu7Menu, like QMenu
QStyle::CT_MenuBar8Menu bar, like QMenuBar
QStyle::CT_MenuBarItem9Menu bar item, like the buttons in a QMenuBar
QStyle::CT_MenuItem10Menu item, like QMenuItem
QStyle::CT_ProgressBar11Progress bar, like QProgressBar
QStyle::CT_PushButton12Push button, like QPushButton
QStyle::CT_RadioButton13Radio button, like QRadioButton
QStyle::CT_ScrollBar14Scroll bar, like QScrollBar.
QStyle::CT_SizeGrip15Size grip, like QSizeGrip.
QStyle::CT_Slider16Slider, like QSlider.
QStyle::CT_SpinBox17Spin box, like QSpinBox.
QStyle::CT_Splitter18Splitter, like QSplitter.
QStyle::CT_TabBarTab19Tab on a tab bar, like QTabBar.
QStyle::CT_TabWidget20Tab widget, like QTabWidget.
QStyle::CT_ToolButton21Tool button, like QToolButton.
QStyle::CT_CustomBase0xf0000000 Base value for custom contents types. Custom values must be greater than this value.
See also
sizeFromContents()

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_CheckBox 0 QCheckBox, draws a PE_IndicatorCheckBox, CE_CheckBoxLabel, and PE_FrameFocusRect.
QStyle::CE_CheckBoxLabel 1 Label (text or pixmap) of a QCheckBox.
QStyle::CE_ColumnViewGrip 2
QStyle::CE_ComboBoxLabel 3Label of a non-editable QComboBox.
QStyle::CE_DockWidgetTitle 4 Dock window title.
QStyle::CE_FocusFrame5Focus frame that is style controlled.
QStyle::CE_Header6Header
QStyle::CE_HeaderEmptyArea7 Area of a header view where there are no header sections.
QStyle::CE_HeaderLabel 8Header label.
QStyle::CE_HeaderSection 9Header section.
QStyle::CE_ItemViewItem 10Item inside an item view.
QStyle::CE_MenuBarItem11Menu item in a QMenuBar.
QStyle::CE_MenuBarEmptyArea12Empty area of a QMenuBar.
QStyle::CE_MenuEmptyArea13Area in a menu without menu items.
QStyle::CE_MenuHMargin14 Horizontal extra space on the left/right of a menu.
QStyle::CE_MenuItem15Menu item in a QMenu.
QStyle::CE_MenuTearoff16 Menu item representing the tear off section of a QMenu.
QStyle::CE_MenuScroller17 Scrolling areas in a QMenu when the style supports scrolling.
QStyle::CE_MenuVMargin18The vertical extra space on the top/bottom of a menu.
QStyle::CE_ProgressBar19 QProgressBar, draws CE_ProgressBarGroove,CE_ProgressBarContents and CE_ProgressBarLabel.
QStyle::CE_ProgressBarGroove20 Groove for the progress indicator in a QProgressBar.
QStyle::CE_ProgressBarContents21Progress indicator of a QProgressBar.
QStyle::CE_ProgressBarLabel22Text label of a QProgressBar.
QStyle::CE_PushButton 23 QPushButton, draws CE_PushButtonBevel,CE_PushButtonLabel and PE_FrameFocusRect.
QStyle::CE_PushButtonBevel24The bevel and default indicator of a QPushButton.
QStyle::CE_PushButtonLabel25 Label (icon with text or pixmap) of a QPushButton.
QStyle::CE_RadioButton26 QRadioButton, draws a PE_IndicatorRadioButton, a CE_RadioButtonLabel, and a PE_FrameFocusRect
QStyle::CE_RadioButtonLabel27Label (text or pixmap) of a QRadioButton.
QStyle::CE_RubberBand28Rubber band used in for example an icon view.
QStyle::CE_ScrollBarAddLine 29 Scroll bar line increase indicator (scroll down), refer to QScrollBar.
QStyle::CE_ScrollBarAddPage 30Scroll bar page increase indicator (page down).
QStyle::CE_ScrollBarFirst31Scroll bar first line indicator (home).
QStyle::CE_ScrollBarLast32Scroll bar last line indicator (end).
QStyle::CE_ScrollBarSlider33Scroll bar slider.
QStyle::CE_ScrollBarSubLine34Scroll bar line decrease indicator (scroll up).
QStyle::CE_ScrollBarSubPage35Scroll bar page decrease indicator (page up).
QStyle::CE_ShapedFrame36 Frame with the shape specified in the QStyleOptionFrame, refer to QFrame.
QStyle::CE_SizeGrip37Window resize handle, refer to QSizeGrip.
QStyle::CE_Splitter38Splitter handle, refer to QSplitter.
QStyle::CE_TabBarTab39Tab and label within a QTabBar.
QStyle::CE_TabBarTabShape40Tab shape within a tab bar.
QStyle::CE_TabBarTabLabel41Label within a tab.
QStyle::CE_ToolBar42Toolbar like QToolBar.
QStyle::CE_ToolBoxTab43Toolbox tab and label within a QToolBox.
QStyle::CE_ToolBoxTabShape44Toolbox tab shape.
QStyle::CE_ToolBoxTabLabel45Toolbox tab label.
QStyle::CE_ToolButtonLabel46Tool button's label.
QStyle::CE_CustomBase 0xf0000000 Base value for custom control elements, custom values must be greater than this value.
See also
drawControl()

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_ButtonMargin0 Amount of whitespace between push button labels and the frame.
QStyle::PM_DockWidgetTitleBarButtonMargin76 Amount of whitespace between dock widget's title bar button labels and the frame.
QStyle::PM_ButtonDefaultIndicator1Width of the default-button indicator frame.
QStyle::PM_MenuButtonIndicator2 Width of the menu button indicator proportional to the widget height.
QStyle::PM_ButtonShiftHorizontal3 Horizontal contents shift of a button when the button is down.
QStyle::PM_ButtonShiftVertical4 Vertical contents shift of a button when the button is down.
QStyle::PM_DefaultFrameWidth5 Default frame width (usually 2).
QStyle::PM_SpinBoxFrameWidth6 Frame width of a spin box, defaults to PM_DefaultFrameWidth.
QStyle::PM_ComboBoxFrameWidth7 Frame width of a combo box, defaults to PM_DefaultFrameWidth.
QStyle::PM_MdiSubWindowFrameWidth44Frame width of an MDI window.
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_MaximumDragDistance8 Maximum distance between the mouse and a scrollbar when dragging
QStyle::PM_ScrollBarExtent9 Width of a vertical scroll bar and the height of a horizontal scroll bar.
QStyle::PM_ScrollBarSliderMin10 Minimum height or width of a vertical or horizontal scroll bar slider.
QStyle::PM_SliderThickness11Total slider thickness.
QStyle::PM_SliderControlThickness12Thickness of the slider handle.
QStyle::PM_SliderLength13Length of the slider.
QStyle::PM_SliderTickmarkOffset14 Offset between the tickmarks and the slider.
QStyle::PM_SliderSpaceAvailable15Available space for the slider to move.
QStyle::PM_DockWidgetSeparatorExtent16 Width or height of a separator in a horizontal or vertical dock window
QStyle::PM_DockWidgetHandleExtent17 Width or height of the handle in a horizontal or vertical dock window
QStyle::PM_DockWidgetFrameWidth18Frame width of a dock window.
QStyle::PM_DockWidgetTitleMargin73Margin of the dock window title.
QStyle::PM_MenuBarPanelWidth33 Frame 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_MenuBarVMargin35 Spacing between menu bar items and top/bottom of bar.
QStyle::PM_ToolBarFrameWidth52 Width of the frame around toolbars.
QStyle::PM_ToolBarHandleExtent53 Width or height of a toolbar handle in a horizontal or vertical toolbar
QStyle::PM_ToolBarItemSpacing54 Spacing between toolbar items.
QStyle::PM_ToolBarItemMargin55 Spacing between the toolbar frame and the items.
QStyle::PM_ToolBarSeparatorExtent56 Width or height of a toolbar separator in a horizontal or vertical toolbar
QStyle::PM_ToolBarExtensionExtent57 Width or height of a toolbar extension button in a horizontal or vertical toolbar
QStyle::PM_TabBarTabOverlap19 Number of pixels the tabs should overlap. 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_TabBarBaseHeight22 Height of the area between the tab bar and the tab pages.
QStyle::PM_TabBarBaseOverlap23 Number of pixels the tab bar overlaps the tab bar base.
QStyle::PM_TabBarScrollButtonWidth51  
QStyle::PM_TabBarTabShiftHorizontal49 Horizontal pixel shift when a tab is selected.
QStyle::PM_TabBarTabShiftVertical50 Vertical pixel shift when a tab is selected.
QStyle::PM_ProgressBarChunkWidth24 Width 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_ExclusiveIndicatorWidth39 Width of a radio button indicator.
QStyle::PM_ExclusiveIndicatorHeight40 Height of a radio button indicator
QStyle::PM_DialogButtonsSeparator41 Distance between buttons in a dialog buttons widget
QStyle::PM_DialogButtonsButtonWidth42 Minimum width of a button in a dialog buttons widget
QStyle::PM_DialogButtonsButtonHeight43 Minimum height of a button in a dialog buttons widget
QStyle::PM_MenuPanelWidth30 Border width (applied on all sides) for a QMenu.
QStyle::PM_MenuHMargin28 Additional border (used on left and right) for a QMenu.
QStyle::PM_MenuVMargin29 Additional border (used for bottom and top) for a QMenu.
QStyle::PM_MenuScrollerHeight27 Height of the scroller area in a QMenu.
QStyle::PM_MenuTearoffHeight31 Height of a tear off area in a QMenu.
QStyle::PM_MenuDesktopFrameWidth32 Frame width for the menu on the desktop.
QStyle::PM_HeaderMarkSize47Size of the sort indicator in a header.
QStyle::PM_HeaderGripMargin48Size of the resize grip in a header.
QStyle::PM_HeaderMargin46 The size of the margin between the sort indicator and the text.
QStyle::PM_SpinBoxSliderHeight58Height of the optional spin box slider.
QStyle::PM_ToolBarIconSize62Default tool bar icon size
QStyle::PM_SmallIconSize65Default small icon size
QStyle::PM_LargeIconSize66Default large icon size
QStyle::PM_FocusFrameHMargin68 Horizontal margin that the focus frame will outset the widget by.
QStyle::PM_FocusFrameVMargin67 Vertical margin that the focus frame will outset the widget by.
QStyle::PM_IconViewIconSize64Default size for icons in an icon view.
QStyle::PM_ListViewIconSize63Default size for icons in a list view.
QStyle::PM_ToolTipLabelFrameWidth69Frame width for a tool tip label.
QStyle::PM_CheckBoxLabelSpacing70 Spacing between a check box indicator and its label.
QStyle::PM_RadioButtonLabelSpacing77 Spacing between a radio button indicator and its label.
QStyle::PM_TabBarIconSize71Default icon size for a tab bar.
QStyle::PM_SizeGripSize72Size of a size grip.
QStyle::PM_MessageBoxIconSize74Size of the standard icons in a message box
QStyle::PM_ButtonIconSize75Default size of button icons
QStyle::PM_TextCursorWidth85 Width of the cursor in a line edit or text edit
QStyle::PM_TabBar_ScrollButtonOverlap84 The distance between the left and right buttons in a tab bar.
QStyle::PM_TabCloseIndicatorWidth 86 The default width of a close button on a tab in a tab bar
QStyle::PM_TabCloseIndicatorHeight 87 The default height of a close button on a tab in a tab bar
QStyle::PM_ScrollView_ScrollBarSpacing 88 Distance between frame and scrollbar with SH_ScrollView_FrameOnlyAroundContents set
QStyle::PM_ScrollView_ScrollBarOverlap 89 Overlap between scroll bars and scroll content
QStyle::PM_SubMenuOverlap 90 Horizontal overlap between a submenu and its parent
QStyle::PM_TreeViewIndentation 91 Indentation of items in a tree view
QStyle::PM_HeaderDefaultSectionSizeHorizontal 92 Default size of sections in a horizontal header
QStyle::PM_HeaderDefaultSectionSizeVertical 93 Default size of sections in a vertical header
QStyle::PM_CustomBase0xf0000000 Base value for custom pixel metrics. Custom values must be greater than this value.

The following values are obsolete:

ConstantValueDescription
QStyle::PM_MDIFrameWidth 44 Replace with PM_MdiSubWindowFrameWidth
QStyle::PM_MDIMinimizedWidth 45 Replace with PM_MdiSubWindowMinimizedWidth
QStyle::PM_DefaultTopLevelMargin 59 Use PM_LayoutLeftMargin, PM_LayoutTopMargin, PM_LayoutRightMargin, and PM_LayoutBottomMargin
QStyle::PM_DefaultChildMargin 60 Use PM_LayoutLeftMargin, PM_LayoutTopMargin, PM_LayoutRightMargin, and PM_LayoutBottomMargin
QStyle::PM_DefaultLayoutSpacing 61 Use PM_LayoutHorizontalSpacing and PM_LayoutVerticalSpacing
See also
pixelMetric()

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_Frame0Generic frame
QStyle::PE_FrameDefaultButton1 Frame around a default button, for example in a dialog.
QStyle::PE_FrameDockWidget2Panel frame for dock windows and toolbars.
QStyle::PE_FrameFocusRect3Generic focus indicator.
QStyle::PE_FrameGroupBox4Panel frame around group boxes.
QStyle::PE_FrameLineEdit5Panel frame for line edits.
QStyle::PE_FrameMenu6Frame for popup windows/menus, refer to QMenu.
QStyle::PE_FrameStatusBarItem 7 Frame for an item of a status bar, refer to QStatusBar.
QStyle::PE_FrameTabWidget8Frame for tab widgets.
QStyle::PE_FrameWindow9Frame around a MDI window or a docking window.
QStyle::PE_FrameButtonBevel10Panel frame for a button bevel.
QStyle::PE_FrameButtonTool11Panel frame for a tool button.
QStyle::PE_PanelButtonCommand13 Button used to initiate an action, for example, a QPushButton.
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_IndicatorButtonDropDown24 Indicator for a drop down button, for example, a tool button that displays a menu.
QStyle::PE_IndicatorArrowDown19Generic Down arrow.
QStyle::PE_IndicatorArrowLeft20Generic Left arrow.
QStyle::PE_IndicatorArrowRight21Generic Right arrow.
QStyle::PE_IndicatorArrowUp22Generic Up 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_IndicatorViewItemCheck Obsolete Use QStyle::PE_IndicatorItemViewItemCheck
QStyle::PE_IndicatorItemViewItemCheck 25 On/off indicator for a view item.
QStyle::PE_IndicatorCheckBox 26 On/off indicator, for example, a QCheckBox.
QStyle::PE_IndicatorRadioButton31 Exclusive on/off indicator, for example, a QRadioButton.
QStyle::PE_IndicatorDockWidgetResizeHandle27Resize handle for dock windows.
QStyle::PE_PanelMenuBar16Panel for menu bars.
QStyle::PE_PanelScrollAreaCorner40 Panel at the bottom-right (or bottom-left) corner of a scroll area.
QStyle::PE_IndicatorHeaderArrow28 Arrow used to indicate sorting on a list or table header.
QStyle::PE_IndicatorMenuCheckMark29Check mark used in a menu.
QStyle::PE_IndicatorProgressChunk30 Section of a progress bar indicator, refer to QProgressBar.
QStyle::PE_IndicatorBranch23 Lines 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_FrameTabBarBase12 The frame that is drawn for a tab bar, usually drawn for a tab bar that is not part of a tab widget.
QStyle::PE_IndicatorTabTear39 Indicates a tab is partially out of the visible tab bar
QStyle::PE_IndicatorColumnViewArrow42 An arrow in a QColumnView.
QStyle::PE_Widget41 A plain QWidget.
QStyle::PE_IndicatorItemViewItemDrop43 An 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.
QStyle::PE_CustomBase 0xf000000Base value for custom primitive elements. All values above this are reserved for custom use. Custom values must be greater than this value.
See also
drawPrimitive()

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

ConstantValueDescription
QStyle::RSIP_OnMouseClickAndAlreadyFocused 0 Requests an input panel if the user clicks on the widget, but only if it is already focused.
QStyle::RSIP_OnMouseClick 1 Requests an input panel if the user clicks on the widget.
See also
QInputMethod

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_TitleBarMinButton0 Minimize button on title bars (refer to QMdiSubWindow).
QStyle::SP_TitleBarMenuButton1Menu button on a title bar.
QStyle::SP_TitleBarMaxButton2Maximize button on title bars.
QStyle::SP_TitleBarCloseButton3Close button on title bars.
QStyle::SP_TitleBarNormalButton4 Normal (restore) button on title bars.
QStyle::SP_TitleBarShadeButton5Shade button on title bars.
QStyle::SP_TitleBarUnshadeButton6Unshade button on title bars.
QStyle::SP_TitleBarContextHelpButton7 Context help button on title bars
QStyle::SP_MessageBoxInformation9Information icon
QStyle::SP_MessageBoxWarning10Warning icon
QStyle::SP_MessageBoxCritical11Critical icon
QStyle::SP_MessageBoxQuestion12Question icon
QStyle::SP_DesktopIcon13Desktop icon
QStyle::SP_TrashIcon14Trash icon
QStyle::SP_ComputerIcon15My Computer icon
QStyle::SP_DriveFDIcon16Floppy icon
QStyle::SP_DriveHDIcon17Hard drive icon
QStyle::SP_DriveCDIcon18CD icon
QStyle::SP_DriveDVDIcon19DVD icon
QStyle::SP_DriveNetIcon 20 Network icon
QStyle::SP_DirHomeIcon 56 Home director icon
QStyle::SP_DirHomeIcon56Home directory icon
QStyle::SP_DirOpenIcon21Open directory icon
QStyle::SP_DirClosedIcon22 Closed directory icon
QStyle::SP_DirIcon38 Directory icon
QStyle::SP_DirLinkIcon 23 Link to directory icon
QStyle::SP_DirLinkOpenIcon 24 Link to open directory icon
QStyle::SP_FileIcon25 File icon
QStyle::SP_FileLinkIcon26 Link to file icon
QStyle::SP_FileDialogStart29 Start icon in a file dialog.
QStyle::SP_FileDialogEnd30 End icon in a file dialog.
QStyle::SP_FileDialogToParent31 Parent directory icon in a file dialog.
QStyle::SP_FileDialogNewFolder32 Create new folder icon in a file dialog.
QStyle::SP_FileDialogDetailedView33 Detailed view icon in a file dialog.
QStyle::SP_FileDialogInfoView34 File info icon in a file dialog.
QStyle::SP_FileDialogContentsView35 Contents view icon in a file dialog.
QStyle::SP_FileDialogListView36 List view icon in a file dialog.
QStyle::SP_FileDialogBack37 Back arrow in a file dialog.
QStyle::SP_DockWidgetCloseButton8 Close button on dock windows (refer to QDockWidget)
QStyle::SP_ToolBarHorizontalExtensionButton27 Extension button for horizontal toolbars.
QStyle::SP_ToolBarVerticalExtensionButton28 Extension button for vertical toolbars.
QStyle::SP_DialogOkButton39 Icon for a standard OK button in a QDialogButtonBox.
QStyle::SP_DialogCancelButton40 Icon for a standard Cancel button in a QDialogButtonBox.
QStyle::SP_DialogHelpButton41 Icon for a standard Help button in a QDialogButtonBox.
QStyle::SP_DialogOpenButton42 Icon for a standard Open button in a QDialogButtonBox.
QStyle::SP_DialogSaveButton43 Icon for a standard Save button in a QDialogButtonBox.
QStyle::SP_DialogCloseButton44 Icon for a standard Close button in a QDialogButtonBox.
QStyle::SP_DialogApplyButton45 Icon for a standard Apply button in a QDialogButtonBox.
QStyle::SP_DialogResetButton46 Icon for a standard Reset button in a QDialogButtonBox.
QStyle::SP_DialogDiscardButton47 Icon for a standard Discard button in a QDialogButtonBox.
QStyle::SP_DialogYesButton48 Icon for a standard Yes button in a QDialogButtonBox.
QStyle::SP_DialogNoButton49 Icon for a standard No button in a QDialogButtonBox.
QStyle::SP_ArrowUp50 Icon arrow pointing up.
QStyle::SP_ArrowDown51 Icon arrow pointing down.
QStyle::SP_ArrowLeft52 Icon arrow pointing left.
QStyle::SP_ArrowRight53 Icon arrow pointing right.
QStyle::SP_ArrowBack54 Equivalent to SP_ArrowLeft when the current layout direction is Qt::LeftToRight, otherwise SP_ArrowRight.
QStyle::SP_ArrowForward55 Equivalent to SP_ArrowRight when the current layout direction is Qt::LeftToRight, otherwise SP_ArrowLeft.
QStyle::SP_CommandLink57 Icon used to indicate a Vista style command link glyph
QStyle::SP_VistaShield58 Icon used to indicate UAC prompts on Windows Vista. Returns null pixmap or icon on all other platforms
QStyle::SP_BrowserReload59 Icon indicating that the current page should be reloaded.
QStyle::SP_BrowserStop60 Icon indicating that the page loading should stop.
QStyle::SP_MediaPlay61 Icon indicating that media should begin playback.
QStyle::SP_MediaStop62 Icon indicating that media should stop playback.
QStyle::SP_MediaPause63 Icon indicating that media should pause playback.
QStyle::SP_MediaSkipForward64 Icon indicating that media should skip forward.
QStyle::SP_MediaSkipBackward65 Icon indicating that media should skip backward.
QStyle::SP_MediaSeekForward66 Icon indicating that media should seek forward.
QStyle::SP_MediaSeekBackward67 Icon indicating that media should seek backward.
QStyle::SP_MediaVolume68 Icon indicating a volume control.
QStyle::SP_MediaVolumeMuted69 Icon indicating a muted volume control.
QStyle::SP_LineEditClearButton70 Icon for a standard clear button in a QLineEdit
QStyle::SP_CustomBase 0xf0000000 Base value for custom standard pixmaps; custom values must be greater than this value.
See also
standardIcon()

This enum describes flags that are used when drawing primitive elements. Not all primitives use all of these flags and the flags may mean different things to different items.

ConstantValueDescription
QStyle::State_None 0x00000000 Indicates widget does not have a state.
QStyle::State_Active 0x00010000 Indicates the widget is active.
QStyle::State_AutoRaise 0x00001000 Indicates if auto-raise appearance should be used on a tool button.
QStyle::State_Children 0x00080000 Indicates if an item view branch has children.
QStyle::State_DownArrow 0x00000040 Indicates if a down arrow should be visible on the widget.
QStyle::State_Editing 0x00400000 Indicates if an editor is opened on the widget.
QStyle::State_Enabled 0x00000001 Indicates if the widget is enabled.
QStyle::State_HasEditFocus 0x01000000 Indicates if the widget currently has edit focus.
QStyle::State_HasFocus 0x00000100 Indicates if the widget has focus.
QStyle::State_Horizontal 0x00000080 Indicates if the widget is laid out horizontally, for example. a tool bar.
QStyle::State_Item 0x00100000 Used by item views to indicate if a horizontal branch should be drawn.
QStyle::State_KeyboardFocusChange 0x00800000 Indicates if the focus was changed with the keyboard, for example in a tab, backtab or shortcut.
QStyle::State_Mini 0x08000000 Indicates a mini style Mac widget or button.
QStyle::State_MouseOver 0x00002000 Used to indicate if the widget is under the mouse.
QStyle::State_NoChange 0x00000010 Used to indicate a tri-state checkbox.
QStyle::State_Off 0x00000008 Used to indicate if the widget is not checked.
QStyle::State_On 0x00000020 Used to indicate if the widget is checked.
QStyle::State_Raised 0x00000002 Used to indicate if a button is raised.
QStyle::State_ReadOnly 0x02000000 Used to indicate if a widget is read-only.
QStyle::State_Selected 0x00008000 Used to indicate if a widget is selected.
QStyle::State_Small 0x04000000 Used to indicate a small style Mac widget or button.
QStyle::State_Open 0x00040000 Used by item views to indicate if the tree branch is open.
QStyle::State_Sibling 0x00200000 Used by item views to indicate if a vertical line needs to be drawn (for siblings).
QStyle::State_Sunken 0x00000004 Used to indicate if the widget is sunken or pressed.
QStyle::State_UpArrow 0x00004000 Used to indicate if an up arrow should be visible on the widget.
See also
drawPrimitive()

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

ConstantValueDescription
QStyle::SH_EtchDisabledText 0 Disabled text is "etched" as it is on Windows.
QStyle::SH_DitherDisabledText1 Disabled text is dithered.
QStyle::SH_ScrollBar_ContextMenu62 Whether or not a scroll bar has a context menu.
QStyle::SH_ScrollBar_MiddleClickAbsolutePosition2 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_LeftClickAbsolutePosition39 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_ScrollWhenPointerLeavesControl3 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 scrollbar stops scrolling when the pointer leaves the SubControl.
QStyle::SH_ScrollBar_RollBetweenButtons63 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_Alignment5 Alignment for tabs in a QTabWidget. Possible values are Qt::AlignLeft, Qt::AlignCenter and Qt::AlignRight.
QStyle::SH_Header_ArrowAlignment6 Placement of the sorting indicator may appear in list or table headers. Possible values are Qt::Left or Qt::Right.
QStyle::SH_Slider_SnapToValue7 Sliders snap to values while moving, as they do on Windows.
QStyle::SH_Slider_SloppyKeyEvents8 Key presses handled in what is called a sloppy manner
QStyle::SH_ProgressDialog_CenterCancelButton9 Center button on progress dialogs, otherwise right aligned.
QStyle::SH_ProgressDialog_TextLabelAlignment10 Alignment for text labels in progress dialogs; Qt::AlignCenter on Windows, Qt::AlignVCenter otherwise.
QStyle::SH_PrintDialog_RightAlignButtons11 Right align buttons in the print dialog, as done on Windows.
QStyle::SH_MainWindow_SpaceBelowMenuBar12 One or two pixel space between the menu bar and the dockarea
QStyle::SH_FontDialog_SelectAssociatedText13 Select 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_KeyboardSearch66 Typing will search a menu for relevant items, otherwise only shortcut is considered
QStyle::SH_Menu_AllowActiveAndDisabled14 Allows disabled menu items to be active.
QStyle::SH_Menu_SpaceActivatesItem15 Pressing the space bar activates the item
QStyle::SH_Menu_SubMenuPopupDelay16 Number of milliseconds to wait before opening a submenu (256 on Windows)
QStyle::SH_Menu_Scrollable30 Should popup menus must support scrolling.
QStyle::SH_Menu_SloppySubMenus33 Should popup menus support the user moving the mouse cursor to a submenu while crossing other items of the menu
QStyle::SH_Menu_SubMenuUniDirection 106 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_SubMenuUniDirectionFailCount 107 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_SubMenuSloppySelectOtherActions 108 Should other action items be selected when the mouse moves towards a sloppy submenu.
QStyle::SH_Menu_SubMenuSloppyCloseTimeout 109 The timeout used to close sloppy submenus.
QStyle::SH_Menu_SubMenuResetWhenReenteringParent 110 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_SubMenuDontStartSloppyOnLeave 111 Do not start sloppy timers when the mouse leaves a sub-menu.
QStyle::SH_ScrollView_FrameOnlyAroundContents17 Should scrollviews draw their frame only around the contents or around everything
QStyle::SH_MenuBar_AltKeyNavigation18 Navigate menu bars by pressing Alt followed by using the arrow keys
QStyle::SH_ComboBox_ListMouseTracking19 Mouse tracking in combobox drop-down lists.
QStyle::SH_Menu_MouseTracking20 Mouse tracking in popup menus.
QStyle::SH_MenuBar_MouseTracking21 Mouse tracking in menu bars.
QStyle::SH_Menu_FillScreenWithScroll45 Should scrolling popups fill the screen as they are scrolled.
QStyle::SH_Menu_SelectionWrap74 Should popups should allow selections to wrap from the last item back to the first item
QStyle::SH_ItemView_ChangeHighlightOnFocus22 Gray out selected items when losing focus.
QStyle::SH_Widget_ShareActivation23 Turn on sharing activation with floating modeless dialogs.
QStyle::SH_TabBar_SelectMouseType4 Which type of mouse event should cause a tab to be selected.
QStyle::SH_ListViewExpand_SelectMouseType 40 Which type of mouse event should cause a list view expansion to be selected.
QStyle::SH_TabBar_PreferNoArrows38 Whether a tab bar should suggest a size to prevent scroll arrows.
QStyle::SH_ComboBox_Popup25 Allows popups as a combobox drop-down menu.
QStyle::SH_Workspace_FillSpaceOnMaximize24 Workspace should maximize the client area.
QStyle::SH_TitleBar_NoBorder26 Title bar has no border.
QStyle::SH_ScrollBar_StopMouseOverSliderObsolete Use SH_Slider_StopMouseOverSlider instead.
QStyle::SH_Slider_StopMouseOverSlider27 Stops auto-repeat when the slider reaches the mouse position.
QStyle::SH_BlinkCursorWhenTextSelected28 Whether cursor should blink when text is selected.
QStyle::SH_RichText_FullWidthSelection29 Whether richtext selections should extend to the full width of the document.
QStyle::SH_GroupBox_TextLabelVerticalAlignment31 How to vertically align a group box's text label.
QStyle::SH_GroupBox_TextLabelColor32 How to paint a group box's text label.
QStyle::SH_DialogButtons_DefaultButton36 Which button gets the default status in a dialog's button widget.
QStyle::SH_ToolBox_SelectedPageTitleBold37 Boldness of the selected page title in a QToolBox.
QStyle::SH_LineEdit_PasswordCharacter35 Unicode character to be used for passwords
QStyle::SH_LineEdit_PasswordMaskDelay 104 Determines the delay (in milliseconds) before visible characters are masked in a password edit
QStyle::SH_Table_GridLineColor34 RGB value of the grid for a table.
QStyle::SH_UnderlineShortcut41 Whether shortcuts are underlined.
QStyle::SH_SpellCheckUnderlineStyle72 A QTextCharFormat::UnderlineStyle value that specifies the way misspelled words should be underlined.
QStyle::SH_SpinBox_AnimateButton42 Animate a click when up or down is pressed in a spin box.
QStyle::SH_SpinBox_KeyPressAutoRepeatRate43 Auto-repeat interval for spinbox key presses.
QStyle::SH_SpinBox_ClickAutoRepeatRate44 Auto-repeat interval for spinbox mouse clicks.
QStyle::SH_SpinBox_ClickAutoRepeatThreshold84 Auto-repeat threshold for spinbox mouse clicks.
QStyle::SH_ToolTipLabel_Opacity46 Integer indicating the opacity for the tip label, 0 is transparent and 255 is opaque
QStyle::SH_DrawMenuBarSeparator47 Indicates whether or not the menu bar draws separators.
QStyle::SH_TitleBar_ModifyNotification48 Indicates if the title bar should show a '*' for windows that are modified.
QStyle::SH_Button_FocusPolicy49 Default focus policy for buttons.
QStyle::SH_MessageBox_UseBorderForButtonSpacing50 Boolean indicating whether to use the border of the buttons for the spacing of the button in a message box
QStyle::SH_MessageBox_CenterButtons73 Boolean indicating whether the buttons in the message box should be centered or not
QStyle::SH_MessageBox_TextInteractionFlags70 Boolean indicating if the text in a message box should allow user interactions
QStyle::SH_TitleBar_AutoRaise51 Boolean indicating whether controls on a title bar should update on a mouse over
QStyle::SH_ToolButton_PopupDelay52 Integer indicating the popup delay in milliseconds for menus attached to tool buttons.
QStyle::SH_FocusFrame_Mask53 Mask of the focus frame.
QStyle::SH_RubberBand_Mask54 Mask of the rubber band.
QStyle::SH_WindowFrame_Mask55 Mask of the window frame.
QStyle::SH_SpinControls_DisableOnBounds56 Determines if the spin controls will shown as disabled when reaching the spin range boundary.
QStyle::SH_Dial_BackgroundRole57 Defines the style's preferred background role (as QPalette::ColorRole) for a dial widget.
QStyle::SH_ComboBox_LayoutDirection58 Layout direction for the combo box. By default it should be the same as indicated by the QStyleOption::direction variable.
QStyle::SH_ItemView_EllipsisLocation59 Location where ellipses should be added for item text that is too long to fit in an view item.
QStyle::SH_ItemView_ShowDecorationSelected60 When an item in an item view is selected, also highlight the branch or other decoration.
QStyle::SH_ItemView_ActivateItemOnSingleClick61 Emit 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_AbsoluteSetButtons64 Which mouse buttons cause a slider to set the value to the position clicked on.
QStyle::SH_Slider_PageSetButtons65 Which mouse buttons cause a slider to page step the value.
QStyle::SH_TabBar_ElideMode67 Default eliding style for a tab bar.
QStyle::SH_DialogButtonLayout68 Controls how buttons are laid out in a QDialogButtonBox, returns a QDialogButtonBox::ButtonLayout enum.
QStyle::SH_WizardStyle79 Controls the look and feel of a QWizard. Returns a QWizard::WizardStyle enum.
QStyle::SH_FormLayoutWrapPolicy86 Provides a default for how rows are wrapped in a QFormLayout. Returns a QFormLayout::RowWrapPolicy enum.
QStyle::SH_FormLayoutFieldGrowthPolicy89 Provides a default for how fields can grow in a QFormLayout. Returns a QFormLayout::FieldGrowthPolicy enum.
QStyle::SH_FormLayoutFormAlignment90 Provides a default for how a QFormLayout aligns its contents within the available space. Returns a Qt::Alignment enum.
QStyle::SH_FormLayoutLabelAlignment91 Provides a default for how a QFormLayout aligns labels within the available space. Returns a Qt::Alignment> enum.
QStyle::SH_ItemView_ArrowKeysNavigateIntoChildren80 Controls whether the tree view will select the first child when it is expanded and the right arrow key is pressed.
QStyle::SH_ComboBox_PopupFrameStyle69 Frame style used when drawing a combobox popup menu.
QStyle::SH_DialogButtonBox_ButtonsHaveIcons71 Indicates whether or not StandardButtons in QDialogButtonBox should have icons or not.
QStyle::SH_ItemView_MovementWithoutUpdatingSelection75 Item view is able to indicate a current item without changing the selection.
QStyle::SH_ToolTip_Mask76 Mask of a tool tip.
QStyle::SH_FocusFrame_AboveWidget77 FocusFrame is stacked above the widget that it is "focusing on"
QStyle::SH_TextControl_FocusIndicatorTextCharFormat 78 Specifies the text format used to highlight focused anchors in rich text documents. Format must be 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_FlashTriggeredItem82 Flash triggered item.
QStyle::SH_Menu_FadeOutOnHide83 Fade out the menu instead of hiding it immediately.
QStyle::SH_TabWidget_DefaultTabPosition87 Default position of the tab bar in a tab widget.
QStyle::SH_ToolBar_Movable88 Determines if the tool bar is movable by default.
QStyle::SH_ItemView_PaintAlternatingRowColorsForEmptyArea85 Whether 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_DrawDelegateFrame92 Determines if there should be a frame for a delegate widget.
QStyle::SH_TabBar_CloseButtonPosition93 Determines the position of the close button on a tab in a tab bar.
QStyle::SH_DockWidget_ButtonsHaveFrame94 Determines if dockwidget buttons should have frames, default is true.
QStyle::SH_ToolButtonStyle95 Determines the default system style for tool buttons that uses Qt::ToolButtonFollowStyle.
QStyle::SH_RequestSoftwareInputPanel 96 Determines when a software input panel should be requested by input widgets. Returns an enum of type QStyle::RequestSoftwareInputPanel.
QStyle::SH_ScrollBar_Transient 97 Determines 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_SupportsSections 98 Determines 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_WakeUpDelay 99 Determines the delay before a tooltip is shown, in milliseconds
QStyle::SH_ToolTip_FallAsleepDelay 100 Determines the delay (in milliseconds) before a new wake time is needed when a tooltip is shown
QStyle::SH_Widget_Animate 101 Deprecated, use SH_Widget_Animation_Duration
QStyle::SH_Splitter_OpaqueResize 102 Determines if widgets are resized dynamically (opaquely) while interactively moving the splitter
QStyle::SH_ComboBox_UseNativePopup 103 Tries to show a native popup for a combobox
QStyle::SH_TabBar_ChangeCurrentDelay 105 Determines the delay before the current tab is changed while dragging over the tabbar, in milliseconds
QStyle::SH_CustomBase0xf0000000 Base value for custom style hints. Custom values must be greater than this value
See also
styleHint()

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

ConstantValueDescription
QStyle::SC_None 0x00000000 Special value that matches no other sub control.
QStyle::SC_ScrollBarAddLine 0x00000001 Scroll bar add line (down/right arrow), refer to QScrollBar.
QStyle::SC_ScrollBarSubLine 0x00000002 Scroll bar sub line (up/left arrow).
QStyle::SC_ScrollBarAddPage 0x00000004 Scroll bar add page (page down).
QStyle::SC_ScrollBarSubPage 0x00000008 Scroll bar sub page (page up).
QStyle::SC_ScrollBarFirst 0x00000010 Scroll bar first line (home).
QStyle::SC_ScrollBarLast 0x00000020 Scroll bar last line (end).
QStyle::SC_ScrollBarSlider 0x00000040 Scroll bar slider handle.
QStyle::SC_ScrollBarGroove 0x00000080 Special sub-control which contains the area in which the slider handle may move.
QStyle::SC_SpinBoxUp 0x00000001 Spin widget up/increase, refer to QSpinBox.
QStyle::SC_SpinBoxDown 0x00000002 Spin widget down/decrease.
QStyle::SC_SpinBoxFrame 0x00000004 Spin widget frame.
QStyle::SC_SpinBoxEditField 0x00000008 Spin widget edit field.
QStyle::SC_ComboBoxEditField 0x00000002 Combobox edit field, refer to QComboBox.
QStyle::SC_ComboBoxArrow 0x00000004 Combobox arrow button.
QStyle::SC_ComboBoxFrame 0x00000001 Combobox frame.
QStyle::SC_ComboBoxListBoxPopup 0x00000008 The reference rectangle for the combobox popup. Used to calculate the position of the popup.
QStyle::SC_SliderGroove 0x00000001 Special sub-control which contains the area in which the slider handle may move.
QStyle::SC_SliderHandle 0x00000002 Slider handle.
QStyle::SC_SliderTickmarks 0x00000004 Slider tickmarks.
QStyle::SC_ToolButton 0x00000001 Tool button (see also QToolButton).
QStyle::SC_ToolButtonMenu 0x00000002 Sub-control for opening a popup menu in a tool button.
QStyle::SC_TitleBarSysMenu 0x00000001 System menu button (restore, close, etc.).
QStyle::SC_TitleBarMinButton 0x00000002 Minimize button.
QStyle::SC_TitleBarMaxButton 0x00000004 Maximize button.
QStyle::SC_TitleBarCloseButton 0x00000008 Close button.
QStyle::SC_TitleBarLabel 0x00000100 Window title label.
QStyle::SC_TitleBarNormalButton 0x00000010 Normal (restore) button.
QStyle::SC_TitleBarShadeButton 0x00000020 Shade button.
QStyle::SC_TitleBarUnshadeButton 0x00000040 Unshade button.
QStyle::SC_TitleBarContextHelpButton 0x00000080 Context Help button.
QStyle::SC_DialHandle 0x00000002 The handle of the dial (what you use to control the dial).
QStyle::SC_DialGroove 0x00000001 The groove for the dial.
QStyle::SC_DialTickmarks 0x00000004 The tickmarks for the dial.
QStyle::SC_GroupBoxFrame 0x00000008 The frame of a group box.
QStyle::SC_GroupBoxLabel 0x00000002 The title of a group box.
QStyle::SC_GroupBoxCheckBox 0x00000001 The optional check box of a group box.
QStyle::SC_GroupBoxContents 0x00000004 Group box contents.
QStyle::SC_MdiNormalButton 0x00000002 Normal button for a MDI subwindow in the menu bar.
QStyle::SC_MdiMinButton 0x00000001 Minimize button for a MDI subwindow in the menu bar.
QStyle::SC_MdiCloseButton 0x00000004 Close button for a MDI subwindow in the menu bar.
QStyle::SC_All 0xffffffff Special value that matches all sub-controls.
See also
QStyle::ComplexControl

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_PushButtonContents0 Area containing the label (icon with text or pixmap).
QStyle::SE_PushButtonFocusRect1 Area for the focus rect (usually larger than the contents rect).
QStyle::SE_PushButtonLayoutItem37Area that counts for the parent layout.
QStyle::SE_CheckBoxIndicator2Area for the state indicator (, 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_RadioButtonLayoutItem38Area that counts for the parent layout.
QStyle::SE_ComboBoxFocusRect10Area for the focus indicator.
QStyle::SE_SliderFocusRect11Area for the focus indicator.
QStyle::SE_SliderLayoutItem39Area that counts for the parent layout.
QStyle::SE_SpinBoxLayoutItem40Area that counts for the parent layout.
QStyle::SE_ProgressBarGroove12Area for the groove.
QStyle::SE_ProgressBarContents13Area for the progress indicator.
QStyle::SE_ProgressBarLabel13Area for the text label.
QStyle::SE_ProgressBarLayoutItem36Area that counts for the parent layout.
QStyle::SE_FrameContents27Area for a frame's contents.
QStyle::SE_ShapedFrameContents51 Area for a frame's contents using the shape in QStyleOptionFrame, refer to QFrame
QStyle::SE_FrameLayoutItem42Area 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_LabelLayoutItem35Area 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_TabWidgetLayoutItem44Area that counts for the parent layout.
QStyle::SE_ToolBoxTabContents15Area for a toolbox tab's icon and label.
QStyle::SE_ToolButtonLayoutItem41Area that counts for the parent layout.
QStyle::SE_ItemViewItemCheckIndicator 23 Area for a view item's check mark.
QStyle::SE_TabBarTearIndicator24Area for the tear indicator on a tab bar with scroll arrows.
QStyle::SE_TreeViewDisclosureItem25Area for the actual disclosure item in a tree branch.
QStyle::SE_GroupBoxLayoutItem43Area that counts for the parent layout.
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_ItemViewItemDecoration45Area for a view item's decoration (icon).
QStyle::SE_ItemViewItemText46Area for a view item's text.
QStyle::SE_ItemViewItemFocusRect47Area for a view item's focus rect.
QStyle::SE_TabBarTabLeftButton48Area for a widget on the left side of a tab in a tab bar.
QStyle::SE_TabBarTabRightButton49Area for a widget on the right side of a tab in a tab bar.
QStyle::SE_TabBarTabText50Area for the text on a tab in a tab bar.
QStyle::SE_ToolBarHandle52Area for the handle of a tool bar.
QStyle::SE_CustomBase0xf0000000 Base value for custom sub-elements. Custom values must be greater than this value.
See also
subElementRect()

Constructor & Destructor Documentation

QStyle::QStyle ( )

Constructs a style object.

QStyle::~QStyle ( )
virtual

Destroys the style object.

Method Documentation

QRect QStyle::alignedRect ( Qt::LayoutDirection  direction,
Qt::Alignment  alignment,
const QSize size,
const QRect rect 
)
static

Returns a new rectangle of the specified size that is aligned to the given rect 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. These two controls are a bitwise OR of zero or more control types. The 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 a nullptr.

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

See also
layoutSpacing()
void QStyle::drawComplexControl ( ComplexControl  control,
const QStyleOptionComplex option,
QPainter painter,
const QWidget widget = nullptr 
) const
pure virtual

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 (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 does not contain the mouse when auto-raise is enabled.
CC_TitleBarQStyleOptionTitleBarState_EnabledSet if the title bar is enabled.
See also
drawPrimitive(), drawControl()

Implemented in QMacStyle, QWindowsStyle, QProxyStyle, QCommonStyle, QWindowsVistaStyle, QGtkStyle, QFusionStyle, and QWindowsXPStyle.

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

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.

If a control element is not listed here, it is because it uses a plain QStyleOption object.

Control ElementQStyleOption SubclassStyle FlagRemark
CE_MenuItem, CE_MenuBarItemQStyleOptionMenuItem State_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 (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 (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_ToolButtonLabelQStyleOptionToolButton State_EnabledSet if the tool button is enabled.
State_HasFocusSet if the tool button has input focus.
State_SunkenSet if the tool button is down (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_HeaderSectionQStyleOptionHeader State_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(), drawComplexControl()

Implemented in QWindowsXPStyle, QMacStyle, QWindowsStyle, QProxyStyle, QCommonStyle, QWindowsVistaStyle, QGtkStyle, and QFusionStyle.

void QStyle::drawItemPixmap ( QPainter painter,
const QRect rect,
int  alignment,
const QPixmap pixmap 
) const
virtual

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

See also
drawItemText()

Reimplemented in QFusionStyle, QGtkStyle, and QProxyStyle.

void QStyle::drawItemText ( QPainter painter,
const QRect rect,
int  alignment,
const QPalette palette,
bool  enabled,
const QString text,
QPalette::ColorRole  textRole = QPalette::NoRole 
) const
virtual

Draws the given text in the specified rect 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, drawItemPixmap()

Reimplemented in QMacStyle, QProxyStyle, QFusionStyle, and QGtkStyle.

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

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_PanelButtonCommand QStyleOptionButtonState_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 (mouse button or the space bar is pressed on the button).
See also
drawComplexControl(), drawControl()

Implemented in QWindowsXPStyle, QMacStyle, QWindowsStyle, QWindowsVistaStyle, QProxyStyle, QCommonStyle, QFusionStyle, and QGtkStyle.

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

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.

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

See also
QIcon

Implemented in QGtkStyle, QMacStyle, QProxyStyle, QCommonStyle, and QFusionStyle.

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

Returns the sub control at the given position in the given complex control (with the style options specified by option). 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(), subControlRect()

Implemented in QWindowsVistaStyle, QProxyStyle, QMacStyle, QFusionStyle, QCommonStyle, and QGtkStyle.

QRect QStyle::itemPixmapRect ( const QRect rect,
int  alignment,
const QPixmap pixmap 
) const
virtual

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

Reimplemented in QGtkStyle, QFusionStyle, and QProxyStyle.

QRect QStyle::itemTextRect ( const QFontMetrics metrics,
const QRect rect,
int  alignment,
bool  enabled,
const QString text 
) const
virtual

Returns the area within the given rect 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

Reimplemented in QProxyStyle.

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

Returns the spacing that should be used between control1 and control2 in a layout. The 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 0.

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

See also
combinedLayoutSpacing()

Implemented in QMacStyle, QCommonStyle, and QProxyStyle.

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

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.

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.

The option can be cast to the appropriate type using the qstyleoption_cast() method. It may also be zero even for PixelMetrics that can make use of it. Refer to the table below for the appropriate option casts.

Pixel MetricQStyleOption Subclass
PM_SliderControlThicknessQStyleOptionSlider
PM_SliderLengthQStyleOptionSlider
PM_SliderTickmarkOffsetQStyleOptionSlider
PM_SliderSpaceAvailableQStyleOptionSlider
PM_ScrollBarExtentQStyleOptionSlider
PM_TabBarTabOverlapQStyleOptionTab
PM_TabBarTabHSpaceQStyleOptionTab
PM_TabBarTabVSpaceQStyleOptionTab
PM_TabBarBaseHeightQStyleOptionTab
PM_TabBarBaseOverlapQStyleOptionTab

Implemented in QWindowsXPStyle, QWindowsStyle, QWindowsVistaStyle, QGtkStyle, QMacStyle, QProxyStyle, QCommonStyle, and QFusionStyle.

void QStyle::polish ( QApplication application)
virtual

Late initialization of the given application object.

Reimplemented in QCommonStyle, QWindowsVistaStyle, QGtkStyle, QWindowsXPStyle, QProxyStyle, QFusionStyle, QWindowsStyle, and QMacStyle.

void QStyle::polish ( QPalette palette)
virtual

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

See also
QPalette, QApplication::setPalette()

Reimplemented in QGtkStyle, QWindowsXPStyle, QFusionStyle, QCommonStyle, QWindowsStyle, QMacStyle, QWindowsVistaStyle, and QProxyStyle.

void QStyle::polish ( QWidget widget)
virtual

Initializes the appearance of the given widget. This method 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.

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 the CopperSpice style engine it is rarely necessary to implement this function; reimplement drawItemPixmap(), drawItemText(), drawPrimitive(), etc. instead.

The QWidget::inherits() method 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()

Reimplemented in QWindowsVistaStyle, QGtkStyle, QWindowsXPStyle, QProxyStyle, QCommonStyle, QFusionStyle, QWindowsStyle, and QMacStyle.

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.

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

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:

Contents TypeQStyleOption Subclass
CT_PushButtonQStyleOptionButton
CT_CheckBoxQStyleOptionButton
CT_RadioButtonQStyleOptionButton
CT_ToolButtonQStyleOptionToolButton
CT_ComboBoxQStyleOptionComboBox
CT_SplitterQStyleOption
CT_ProgressBarQStyleOptionProgressBar
CT_MenuItemQStyleOptionMenuItem
See also
ContentsType, QStyleOption

Implemented in QCommonStyle, QWindowsVistaStyle, QGtkStyle, QProxyStyle, QFusionStyle, QWindowsXPStyle, QMacStyle, and QWindowsStyle.

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

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 method 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()
int QStyle::sliderValueFromPosition ( int  min,
int  max,
int  position,
int  span,
bool  upsideDown = false 
)
static

Converts the given pixel position to a logical value. The value of 0 maps to the min parameter, span maps to max and other values are distributed evenly in between. This method 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()
QIcon QStyle::standardIcon ( StandardPixmap  standardIcon,
const QStyleOption option = nullptr,
const QWidget widget = nullptr 
) const
pure virtual

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.

Implemented in QWindowsXPStyle, QMacStyle, QGtkStyle, QProxyStyle, QFusionStyle, QWindowsStyle, QCommonStyle, and QWindowsVistaStyle.

QPalette QStyle::standardPalette ( ) const
virtual

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 XP, 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::setStandardPalette().

Reimplemented in QWindowsVistaStyle, QWindowsXPStyle, QProxyStyle, QMacStyle, QGtkStyle, and QFusionStyle.

QPixmap QStyle::standardPixmap ( StandardPixmap  standardPixmap,
const QStyleOption option = nullptr,
const QWidget widget = nullptr 
) const
deprecatedpure virtual
Deprecated:
Returns a pixmap for the given standardPixmap.

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

Developers calling standardPixmap() should instead call standardIcon() Developers who re-implemented standardPixmap() should instead re-implement the slot standardIconImplementation().

See also
standardIcon()

Implemented in QWindowsVistaStyle, QMacStyle, QWindowsXPStyle, QProxyStyle, QFusionStyle, QWindowsStyle, QGtkStyle, and QCommonStyle.

int QStyle::styleHint ( StyleHint  styleHint,
const QStyleOption option = nullptr,
const QWidget widget = nullptr,
QStyleHintReturn styleHintReturn = nullptr 
) const
pure virtual

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

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

Implemented in QMacStyle, QCommonStyle, QWindowsXPStyle, QProxyStyle, QFusionStyle, QWindowsStyle, QGtkStyle, and QWindowsVistaStyle.

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

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()

Implemented in QMacStyle, QCommonStyle, QGtkStyle, QFusionStyle, QWindowsVistaStyle, QProxyStyle, and QWindowsXPStyle.

QRect QStyle::subElementRect ( SubElement  subElement,
const QStyleOption option,
const QWidget widget = nullptr 
) const
pure virtual

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:

Sub ElementQStyleOption Subclass
SE_PushButtonContentsQStyleOptionButton
SE_PushButtonFocusRectQStyleOptionButton
SE_CheckBoxIndicatorQStyleOptionButton
SE_CheckBoxContentsQStyleOptionButton
SE_CheckBoxFocusRectQStyleOptionButton
SE_RadioButtonIndicatorQStyleOptionButton
SE_RadioButtonContentsQStyleOptionButton
SE_RadioButtonFocusRectQStyleOptionButton
SE_ComboBoxFocusRectQStyleOptionComboBox
SE_ProgressBarGrooveQStyleOptionProgressBar
SE_ProgressBarContentsQStyleOptionProgressBar
SE_ProgressBarLabelQStyleOptionProgressBar

Implemented in QWindowsXPStyle, QMacStyle, QWindowsStyle, QFusionStyle, QCommonStyle, QWindowsVistaStyle, QGtkStyle, and QProxyStyle.

void QStyle::unpolish ( QApplication application)
virtual

Uninitialize the given application.

Reimplemented in QCommonStyle, QWindowsVistaStyle, QGtkStyle, QWindowsXPStyle, QProxyStyle, QFusionStyle, QWindowsStyle, and QMacStyle.

void QStyle::unpolish ( QWidget widget)
virtual

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 the CopperSpice classes cache their widgets.

See also
polish()

Reimplemented in QWindowsVistaStyle, QGtkStyle, QWindowsXPStyle, QProxyStyle, QFusionStyle, QCommonStyle, QWindowsStyle, and QMacStyle.

Qt::Alignment QStyle::visualAlignment ( Qt::LayoutDirection  direction,
Qt::Alignment  alignment 
)
static

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

QPoint QStyle::visualPos ( Qt::LayoutDirection  direction,
const QRect boundingRect,
const QPoint logicalPosition 
)
static

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

See also
QWidget::layoutDirection
QRect QStyle::visualRect ( Qt::LayoutDirection  direction,
const QRect boundingRect,
const QRect logicalRect 
)
static

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

This method is provided to support right-to-left languages and is typically used in implementations of the subControlRect() method.

See also
QWidget::layoutDirection