CopperSpice API  1.7.2
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 Types

enum  ComplexControl
 
enum  ContentsType
 
enum  ControlElement
 
enum  PixelMetric
 
enum  PrimitiveElement
 
enum  RequestSoftwareInputPanel
 
enum  StandardPixmap
 
enum  StyleHint
 
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 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)
 
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. For example:

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 Programming.

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

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

switch (element) {
case (PE_PanelItemViewItem): {
painter->save();
QPoint topLeft = option->rect.topLeft();
QPoint bottomRight = option->rect.topRight();
QLinearGradient backgroundGradient(topLeft, bottomRight);
backgroundGradient.setColorAt(0.0, QColor(Qt::yellow).lighter(190));
backgroundGradient.setColorAt(1.0, Qt::white);
painter->fillRect(option->rect, QBrush(backgroundGradient));
painter->restore();
break;
}
default:
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 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_SpinBox0A spinbox, like QSpinBox.
QStyle::CC_ComboBox1A combobox, like QComboBox.
QStyle::CC_ScrollBar2A scroll bar, like QScrollBar.
QStyle::CC_Slider3A slider, like QSlider.
QStyle::CC_ToolButton4A tool button, like QToolButton.
QStyle::CC_TitleBar5A Title bar, like those used in QMdiSubWindow.
QStyle::CC_GroupBox8A group box, like QGroupBox.
QStyle::CC_Dial7A dial, like QDial.
QStyle::CC_MdiControls9The minimize, close, and normal button in the menu bar for a maximized MDI subwindow.
QStyle::CC_CustomBase0xf0000000Base value for custom complex controls. Custom values must be greater than this value.
See also
SubControl, drawComplexControl()

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

ConstantValueDescription
QStyle::CT_CheckBox1A check box, like QCheckBox.
QStyle::CT_ComboBox4A combo box, like QComboBox.
QStyle::CT_HeaderSection21A header section, like QHeader.
QStyle::CT_LineEdit16A line edit, like QLineEdit.
QStyle::CT_Menu11A menu, like QMenu.
QStyle::CT_MenuBar10A menu bar, like QMenuBar.
QStyle::CT_MenuBarItem9A menu bar item, like the buttons in a QMenuBar.
QStyle::CT_MenuItem8A menu item, like QMenuItem.
QStyle::CT_ProgressBar7A progress bar, like QProgressBar.
QStyle::CT_PushButton0A push button, like QPushButton.
QStyle::CT_RadioButton2A radio button, like QRadioButton.
QStyle::CT_SizeGrip18A size grip, like QSizeGrip.
QStyle::CT_Slider13A slider, like QSlider.
QStyle::CT_ScrollBar14A scroll bar, like QScrollBar.
QStyle::CT_SpinBox17A spin box, like QSpinBox.
QStyle::CT_Splitter5A splitter, like QSplitter.
QStyle::CT_TabBarTab12A tab on a tab bar, like QTabBar.
QStyle::CT_TabWidget19A tab widget, like QTabWidget.
QStyle::CT_ToolButton3A tool button, like QToolButton.
QStyle::CT_GroupBox22A group box, like QGroupBox.
QStyle::CT_ItemViewItem24An item inside an item view.
QStyle::CT_CustomBase0xf0000000Base value for custom contents types. Custom values must be greater than this value.
QStyle::CT_MdiControls23The minimize, normal, and close button in the menu bar for a maximized MDI subwindow.
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_PushButton0A QPushButton, draws CE_PushButtonBevel, CE_PushButtonLabel and PE_FrameFocusRect.
QStyle::CE_PushButtonBevel1The bevel and default indicator of a QPushButton.
QStyle::CE_PushButtonLabel2The label (an icon with text or pixmap) of a QPushButton.
QStyle::CE_DockWidgetTitle31Dock window title.
QStyle::CE_Splitter29Splitter handle, refer to QSplitter.
QStyle::CE_CheckBox3A QCheckBox, draws a PE_IndicatorCheckBox, a CE_CheckBoxLabel and a PE_FrameFocusRect.
QStyle::CE_CheckBoxLabel4The label (text or pixmap) of a QCheckBox.
QStyle::CE_RadioButton5A QRadioButton, draws a PE_IndicatorRadioButton, a CE_RadioButtonLabel and a PE_FrameFocusRect.
QStyle::CE_RadioButtonLabel6The label (text or pixmap) of a QRadioButton.
QStyle::CE_TabBarTab7The tab and label within a QTabBar.
QStyle::CE_TabBarTabShape8The tab shape within a tab bar.
QStyle::CE_TabBarTabLabel9The label within a tab.
QStyle::CE_ProgressBar10A QProgressBar, draws CE_ProgressBarGroove, CE_ProgressBarContents and CE_ProgressBarLabel.
QStyle::CE_ProgressBarGroove11The groove where the progress indicator is drawn in a QProgressBar.
QStyle::CE_ProgressBarContents12The progress indicator of a QProgressBar.
QStyle::CE_ProgressBarLabel13The text label of a QProgressBar.
QStyle::CE_ToolButtonLabel22A tool button's label.
QStyle::CE_MenuBarItem20A menu item in a QMenuBar.
QStyle::CE_MenuBarEmptyArea21The empty area of a QMenuBar.
QStyle::CE_MenuItem14A menu item in a QMenu.
QStyle::CE_MenuScroller15Scrolling areas in a QMenu when the style supports scrolling.
QStyle::CE_MenuTearoff18A menu item representing the tear off section of a QMenu.
QStyle::CE_MenuEmptyArea19The area in a menu without menu items.
QStyle::CE_MenuHMargin17The horizontal extra space on the left/right of a menu.
QStyle::CE_MenuVMargin16The vertical extra space on the top/bottom of a menu.
QStyle::CE_ToolBoxTab27The toolbox's tab and label within a QToolBox.
QStyle::CE_SizeGrip28Window resize handle, refer to QSizeGrip.
QStyle::CE_Header23A header.
QStyle::CE_HeaderSection24A header section.
QStyle::CE_HeaderLabel25The header's label.
QStyle::CE_ScrollBarAddLine32Scroll bar line increase indicator. (i.e., scroll down), refer to QScrollBar.
QStyle::CE_ScrollBarSubLine33Scroll bar line decrease indicator (i.e., scroll up).
QStyle::CE_ScrollBarAddPage34Scroll bar page increase indicator (i.e., page down).
QStyle::CE_ScrollBarSubPage35Scroll bar page decrease indicator (i.e., page up).
QStyle::CE_ScrollBarSlider36Scroll bar slider.
QStyle::CE_ScrollBarFirst37Scroll bar first line indicator (i.e., home).
QStyle::CE_ScrollBarLast38Scroll bar last line indicator (i.e., end).
QStyle::CE_RubberBand30Rubber band used in for example an icon view.
QStyle::CE_FocusFrame39Focus frame that is style controlled.
QStyle::CE_ItemViewItem46An item inside an item view.
QStyle::CE_CustomBase0xf0000000Base value for custom control elements; custom values must be greater than this value.
QStyle::CE_ComboBoxLabel40The label of a non-editable QComboBox.
QStyle::CE_ToolBar41A toolbar like QToolBar.
QStyle::CE_ToolBoxTabShape42The toolbox's tab shape.
QStyle::CE_ToolBoxTabLabel43The toolbox's tab label.
QStyle::CE_HeaderEmptyArea44The area of a header view where there are no header sections.
QStyle::CE_ShapedFrame47The frame with the shape specified in the QStyleOptionFrameV3, refer to QFrame.
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_ButtonMargin0Amount of whitespace between push button labels and the frame.
QStyle::PM_DockWidgetTitleBarButtonMargin?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_MenuButtonIndicator2Width of the menu button indicator proportional to the widget height.
QStyle::PM_ButtonShiftHorizontal3Horizontal contents shift of a button when the button is down.
QStyle::PM_ButtonShiftVertical4Vertical contents shift of a button when the button is down.
QStyle::PM_DefaultFrameWidth5Default frame width (usually 2).
QStyle::PM_SpinBoxFrameWidth6Frame width of a spin box, defaults to PM_DefaultFrameWidth.
QStyle::PM_ComboBoxFrameWidth7Frame width of a combo box, defaults to PM_DefaultFrameWidth.
QStyle::PM_MDIFrameWidthPM_MdiSubWindowFrameWidthObsolete. Use PM_MdiSubWindowFrameWidth instead.
QStyle::PM_MdiSubWindowFrameWidth46Frame width of an MDI window.
QStyle::PM_MDIMinimizedWidthPM_MdiSubWindowMinimizedWidthObsolete. Use PM_MdiSubWindowMinimizedWidth instead.
QStyle::PM_MdiSubWindowMinimizedWidth?Width of a minimized MDI window.
QStyle::PM_LayoutLeftMargin?Default left margin for a QLayout.
QStyle::PM_LayoutTopMargin?Default top margin for a QLayout.
QStyle::PM_LayoutRightMargin?Default right margin for a QLayout.
QStyle::PM_LayoutBottomMargin?Default bottom margin for a QLayout.
QStyle::PM_LayoutHorizontalSpacing?Default horizontal spacing for a QLayout.
QStyle::PM_LayoutVerticalSpacing?Default vertical spacing for a QLayout.
QStyle::PM_MaximumDragDistance8The maximum allowed distance between the mouse and a scrollbar when dragging. Exceeding the specified distance will cause the slider to jump back to the original position; a value of -1 disables this behavior.
QStyle::PM_ScrollBarExtent9Width of a vertical scroll bar and the height of a horizontal scroll bar.
QStyle::PM_ScrollBarSliderMin10The minimum height of a vertical scroll bar's slider and the minimum width of a horizontal scroll bar's slider.
QStyle::PM_SliderThickness11Total slider thickness.
QStyle::PM_SliderControlThickness12Thickness of the slider handle.
QStyle::PM_SliderLength13Length of the slider.
QStyle::PM_SliderTickmarkOffset14The offset between the tickmarks and the slider.
QStyle::PM_SliderSpaceAvailable15The available space for the slider to move.
QStyle::PM_DockWidgetSeparatorExtent16Width of a separator in a horizontal dock window and the height of a separator in a vertical dock window.
QStyle::PM_DockWidgetHandleExtent17Width of the handle in a horizontal dock window and the height of the handle in a vertical dock window.
QStyle::PM_DockWidgetFrameWidth18Frame width of a dock window.
QStyle::PM_DockWidgetTitleMargin?Margin of the dock window title.
QStyle::PM_MenuBarPanelWidth33Frame width of a menu bar, defaults to PM_DefaultFrameWidth.
QStyle::PM_MenuBarItemSpacing34Spacing between menu bar items.
QStyle::PM_MenuBarHMargin36Spacing between menu bar items and left/right of bar.
QStyle::PM_MenuBarVMargin35Spacing between menu bar items and top/bottom of bar.
QStyle::PM_ToolBarFrameWidth?Width of the frame around toolbars.
QStyle::PM_ToolBarHandleExtent?Width of a toolbar handle in a horizontal toolbar and the height of the handle in a vertical toolbar.
QStyle::PM_ToolBarItemMargin?Spacing between the toolbar frame and the items.
QStyle::PM_ToolBarItemSpacing?Spacing between toolbar items.
QStyle::PM_ToolBarSeparatorExtent?Width of a toolbar separator in a horizontal toolbar and the height of a separator in a vertical toolbar.
QStyle::PM_ToolBarExtensionExtent?Width of a toolbar extension button in a horizontal toolbar and the height of the button in a vertical toolbar.
QStyle::PM_TabBarTabOverlap19Number of pixels the tabs should overlap. (Currently only used in styles, not inside of QTabBar)
QStyle::PM_TabBarTabHSpace20Extra space added to the tab width.
QStyle::PM_TabBarTabVSpace21Extra space added to the tab height.
QStyle::PM_TabBarBaseHeight22Height of the area between the tab bar and the tab pages.
QStyle::PM_TabBarBaseOverlap23Number of pixels the tab bar overlaps the tab bar base.
QStyle::PM_TabBarScrollButtonWidth? 
QStyle::PM_TabBarTabShiftHorizontal?Horizontal pixel shift when a tab is selected.
QStyle::PM_TabBarTabShiftVertical?Vertical pixel shift when a tab is selected.
QStyle::PM_ProgressBarChunkWidth24Width of a chunk in a progress bar indicator.
QStyle::PM_SplitterWidth25Width of a splitter.
QStyle::PM_TitleBarHeight26Height of the title bar.
QStyle::PM_IndicatorWidth37Width of a check box indicator.
QStyle::PM_IndicatorHeight38Height of a checkbox indicator.
QStyle::PM_ExclusiveIndicatorWidth39Width of a radio button indicator.
QStyle::PM_ExclusiveIndicatorHeight40Height of a radio button indicator.
QStyle::PM_MenuPanelWidth30Border width (applied on all sides) for a QMenu.
QStyle::PM_MenuHMargin28Additional border (used on left and right) for a QMenu.
QStyle::PM_MenuVMargin29Additional border (used for bottom and top) for a QMenu.
QStyle::PM_MenuScrollerHeight27Height of the scroller area in a QMenu.
QStyle::PM_MenuTearoffHeight31Height of a tear off area in a QMenu.
QStyle::PM_MenuDesktopFrameWidth32The frame width for the menu on the desktop.
QStyle::PM_HeaderMarkSize?The size of the sort indicator in a header.
QStyle::PM_HeaderGripMargin?The size of the resize grip in a header.
QStyle::PM_HeaderMargin?The size of the margin between the sort indicator and the text.
QStyle::PM_SpinBoxSliderHeight?The height of the optional spin box slider.
QStyle::PM_ToolBarIconSize?Default tool bar icon size
QStyle::PM_SmallIconSize?Default small icon size
QStyle::PM_LargeIconSize?Default large icon size
QStyle::PM_FocusFrameHMargin?Horizontal margin that the focus frame will outset the widget by.
QStyle::PM_FocusFrameVMargin?Vertical margin that the focus frame will outset the widget by.
QStyle::PM_IconViewIconSize?The default size for icons in an icon view.
QStyle::PM_ListViewIconSize?The default size for icons in a list view.
QStyle::PM_ToolTipLabelFrameWidth?The frame width for a tool tip label.
QStyle::PM_CheckBoxLabelSpacing?The spacing between a check box indicator and its label.
QStyle::PM_RadioButtonLabelSpacing?The spacing between a radio button indicator and its label.
QStyle::PM_TabBarIconSize?The default icon size for a tab bar.
QStyle::PM_SizeGripSize?The size of a size grip.
QStyle::PM_MessageBoxIconSize?The size of the standard icons in a message box
QStyle::PM_ButtonIconSize?The default size of button icons
QStyle::PM_TextCursorWidth?The width of the cursor in a line edit or text edit
QStyle::PM_TabBar_ScrollButtonOverlap?The distance between the left and right buttons in a tab bar.
QStyle::PM_TabCloseIndicatorWidth?The default width of a close button on a tab in a tab bar.
QStyle::PM_TabCloseIndicatorHeight?The default height of a close button on a tab in a tab bar.
QStyle::PM_CustomBase0xf0000000Base value for custom pixel metrics. Custom values must be greater than this value.

The following values are obsolete:

ConstantValueDescription
QStyle::PM_DefaultTopLevelMargin?Use PM_LayoutLeftMargin, PM_LayoutTopMargin, PM_LayoutRightMargin, and PM_LayoutBottomMargin instead.
QStyle::PM_DefaultChildMargin?Use PM_LayoutLeftMargin, PM_LayoutTopMargin, PM_LayoutRightMargin, and PM_LayoutBottomMargin instead.
QStyle::PM_DefaultLayoutSpacing?Use PM_LayoutHorizontalSpacing and PM_LayoutVerticalSpacing instead.
QStyle::PM_ScrollView_ScrollBarSpacing?Distance between frame and scrollbar with SH_ScrollView_FrameOnlyAroundContents set.
QStyle::PM_SubMenuOverlap?The horizontal overlap between a submenu and its parent.
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_FrameStatusBar12Frame
QStyle::PE_PanelButtonCommand?Button used to initiate an action, for example, a QPushButton.
QStyle::PE_FrameDefaultButton6This frame around a default button, e.g. in a dialog.
QStyle::PE_PanelButtonBevel?Generic panel with a button bevel.
QStyle::PE_PanelButtonTool?Panel for a Tool button, used with QToolButton.
QStyle::PE_PanelLineEdit?Panel for a QLineEdit.
QStyle::PE_IndicatorButtonDropDown?Indicator for a drop down button, for example, a tool button that displays a menu.
QStyle::PE_FrameFocusRect8Generic focus indicator.
QStyle::PE_IndicatorArrowUp?Generic Up arrow.
QStyle::PE_IndicatorArrowDown?Generic Down arrow.
QStyle::PE_IndicatorArrowRight?Generic Right arrow.
QStyle::PE_IndicatorArrowLeft?Generic Left arrow.
QStyle::PE_IndicatorSpinUp?Up symbol for a spin widget, for example a QSpinBox.
QStyle::PE_IndicatorSpinDown?Down symbol for a spin widget.
QStyle::PE_IndicatorSpinPlus?Increase symbol for a spin widget.
QStyle::PE_IndicatorSpinMinus?Decrease symbol for a spin widget.
QStyle::PE_IndicatorItemViewItemCheckPE_IndicatorViewItemCheckOn/off indicator for a view item.
QStyle::PE_IndicatorCheckBox?On/off indicator, for example, a QCheckBox.
QStyle::PE_IndicatorRadioButton?Exclusive on/off indicator, for example, a QRadioButton.
QStyle::PE_IndicatorDockWidgetResizeHandle?Resize handle for dock windows.
QStyle::PE_Frame5Generic frame
QStyle::PE_FrameMenu11Frame for popup windows/menus, refer to QMenu.
QStyle::PE_PanelMenuBar?Panel for menu bars.
QStyle::PE_PanelScrollAreaCorner?Panel at the bottom-right (or bottom-left) corner of a scroll area.
QStyle::PE_FrameDockWidget7Panel frame for dock windows and toolbars.
QStyle::PE_FrameTabWidget?Frame for tab widgets.
QStyle::PE_FrameLineEdit10Panel frame for line edits.
QStyle::PE_FrameGroupBox9Panel frame around group boxes.
QStyle::PE_FrameButtonBevel?Panel frame for a button bevel.
QStyle::PE_FrameButtonTool?Panel frame for a tool button.
QStyle::PE_IndicatorHeaderArrow?Arrow used to indicate sorting on a list or table header.
QStyle::PE_FrameStatusBarItemPE_FrameStatusBarFrame for an item of a status bar, refer to QStatusBar.
QStyle::PE_FrameWindow?Frame around a MDI window or a docking window.
QStyle::PE_IndicatorMenuCheckMark?Check mark used in a menu.
QStyle::PE_IndicatorProgressChunk?Section of a progress bar indicator, refer to QProgressBar.
QStyle::PE_IndicatorBranch?Lines used to represent the branch of a tree in a tree view.
QStyle::PE_IndicatorToolBarHandle?The handle of a toolbar.
QStyle::PE_IndicatorToolBarSeparator?The separator in a toolbar.
QStyle::PE_PanelToolBar?The panel for a toolbar.
QStyle::PE_PanelTipLabel?The panel for a tip label.
QStyle::PE_FrameTabBarBase?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_IndicatorTabTear?An indicator that a tab is partially scrolled out of the visible tab bar when there are many tabs.
QStyle::PE_IndicatorColumnViewArrow?An arrow in a QColumnView.
QStyle::PE_Widget?A plain QWidget.
QStyle::PE_CustomBase0xf000000Base value for custom primitive elements. All values above this are reserved for custom use. Custom values must be greater than this value.
QStyle::PE_IndicatorItemViewItemDrop?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_PanelItemViewItem?The background for an item in an item view.
QStyle::PE_PanelItemViewRow?The background of a row in an item view.
QStyle::PE_PanelStatusBar?The panel for a status bar.
QStyle::PE_IndicatorTabClose?The close button on a tab bar.
QStyle::PE_PanelMenu?The panel for a menu.
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
QEvent::RequestSoftwareInputPanel

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

ConstantValueDescription
QStyle::SP_TitleBarMinButton1Minimize button on title bars (e.g., in QMdiSubWindow).
QStyle::SP_TitleBarMenuButton0Menu button on a title bar.
QStyle::SP_TitleBarMaxButton2Maximize button on title bars.
QStyle::SP_TitleBarCloseButton3Close button on title bars.
QStyle::SP_TitleBarNormalButton4Normal (restore) button on title bars.
QStyle::SP_TitleBarShadeButton5Shade button on title bars.
QStyle::SP_TitleBarUnshadeButton6Unshade button on title bars.
QStyle::SP_TitleBarContextHelpButton7The Context help button on title bars.
QStyle::SP_MessageBoxInformation9The "information" icon.
QStyle::SP_MessageBoxWarning10The "warning" icon.
QStyle::SP_MessageBoxCritical11The "critical" icon.
QStyle::SP_MessageBoxQuestion12The "question" icon.
QStyle::SP_DesktopIcon13The "desktop" icon.
QStyle::SP_TrashIcon14The "trash" icon.
QStyle::SP_ComputerIcon15The "My computer" icon.
QStyle::SP_DriveFDIcon16The floppy icon.
QStyle::SP_DriveHDIcon17The harddrive icon.
QStyle::SP_DriveCDIcon18The CD icon.
QStyle::SP_DriveDVDIcon19The DVD icon.
QStyle::SP_DriveNetIcon20The network icon.
QStyle::SP_DirHomeIcon55The home directory icon.
QStyle::SP_DirOpenIcon21The open directory icon.
QStyle::SP_DirClosedIcon22The closed directory icon.
QStyle::SP_DirIcon37The directory icon.
QStyle::SP_DirLinkIcon23The link to directory icon.
QStyle::SP_FileIcon24The file icon.
QStyle::SP_FileLinkIcon25The link to file icon.
QStyle::SP_FileDialogStart28The "start" icon in a file dialog.
QStyle::SP_FileDialogEnd29The "end" icon in a file dialog.
QStyle::SP_FileDialogToParent30The "parent directory" icon in a file dialog.
QStyle::SP_FileDialogNewFolder31The "create new folder" icon in a file dialog.
QStyle::SP_FileDialogDetailedView32The detailed view icon in a file dialog.
QStyle::SP_FileDialogInfoView33The file info icon in a file dialog.
QStyle::SP_FileDialogContentsView34The contents view icon in a file dialog.
QStyle::SP_FileDialogListView35The list view icon in a file dialog.
QStyle::SP_FileDialogBack36The back arrow in a file dialog.
QStyle::SP_DockWidgetCloseButton8Close button on dock windows (refer to also QDockWidget).
QStyle::SP_ToolBarHorizontalExtensionButton26Extension button for horizontal toolbars.
QStyle::SP_ToolBarVerticalExtensionButton27Extension button for vertical toolbars.
QStyle::SP_DialogOkButton38Icon for a standard OK button in a QDialogButtonBox.
QStyle::SP_DialogCancelButton39Icon for a standard Cancel button in a QDialogButtonBox.
QStyle::SP_DialogHelpButton40Icon for a standard Help button in a QDialogButtonBox.
QStyle::SP_DialogOpenButton41Icon for a standard Open button in a QDialogButtonBox.
QStyle::SP_DialogSaveButton42Icon for a standard Save button in a QDialogButtonBox.
QStyle::SP_DialogCloseButton43Icon for a standard Close button in a QDialogButtonBox.
QStyle::SP_DialogApplyButton44Icon for a standard Apply button in a QDialogButtonBox.
QStyle::SP_DialogResetButton45Icon for a standard Reset button in a QDialogButtonBox.
QStyle::SP_DialogDiscardButton46Icon for a standard Discard button in a QDialogButtonBox.
QStyle::SP_DialogYesButton47Icon for a standard Yes button in a QDialogButtonBox.
QStyle::SP_DialogNoButton48Icon for a standard No button in a QDialogButtonBox.
QStyle::SP_ArrowUp49Icon arrow pointing up.
QStyle::SP_ArrowDown50Icon arrow pointing down.
QStyle::SP_ArrowLeft51Icon arrow pointing left.
QStyle::SP_ArrowRight52Icon arrow pointing right.
QStyle::SP_ArrowBack53Equivalent to SP_ArrowLeft when the current layout direction is Qt::LeftToRight, otherwise SP_ArrowRight.
QStyle::SP_ArrowForward54Equivalent to SP_ArrowRight when the current layout direction is Qt::LeftToRight, otherwise SP_ArrowLeft.
QStyle::SP_CommandLink56Icon used to indicate a Vista style command link glyph.
QStyle::SP_VistaShield57Icon used to indicate UAC prompts on Windows Vista. This will return a null pixmap or icon on all other platforms.
QStyle::SP_BrowserReload58Icon indicating that the current page should be reloaded.
QStyle::SP_BrowserStop59Icon indicating that the page loading should stop.
QStyle::SP_MediaPlay60Icon indicating that media should begin playback.
QStyle::SP_MediaStop61Icon indicating that media should stop playback.
QStyle::SP_MediaPause62Icon indicating that media should pause playback.
QStyle::SP_MediaSkipForward63Icon indicating that media should skip forward.
QStyle::SP_MediaSkipBackward64Icon indicating that media should skip backward.
QStyle::SP_MediaSeekForward65Icon indicating that media should seek forward.
QStyle::SP_MediaSeekBackward66Icon indicating that media should seek backward.
QStyle::SP_MediaVolume67Icon indicating a volume control.
QStyle::SP_MediaVolumeMuted68Icon indicating a muted volume control.
QStyle::SP_CustomBase0xf0000000Base value for custom standard pixmaps; custom values must be greater than this value.
See also
standardIcon()

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

ConstantValueDescription
QStyle::SH_EtchDisabledText0Disabled text is "etched" as it is on Windows.
QStyle::SH_DitherDisabledText1Disabled text is dithered.
QStyle::SH_GUIStyle?GUI style to use.
QStyle::SH_ScrollBar_ContextMenu?Whether or not a scroll bar has a context menu.
QStyle::SH_ScrollBar_MiddleClickAbsolutePosition2A boolean value. If true, middle clicking on a scroll bar causes the slider to jump to that position. If false, middle clicking is ignored.
QStyle::SH_ScrollBar_LeftClickAbsolutePosition?A boolean value. If true, left clicking on a scroll bar causes the slider to jump to that position. If false, left clicking will behave as appropriate for each control.
QStyle::SH_ScrollBar_ScrollWhenPointerLeavesControl3A boolean value. If true, when clicking a scroll bar SubControl, holding the mouse button down and moving the pointer outside the SubControl, the scroll bar continues to scroll. If false, the scrollbar stops scrolling when the pointer leaves the SubControl.
QStyle::SH_ScrollBar_RollBetweenButtons?A boolean value. If true, when clicking a scroll bar button (SC_ScrollBarAddLine or SC_ScrollBarSubLine) and dragging over to the opposite button (rolling) will press the new button and release the old one. When it is false, the original button is released and nothing happens (like a push button).
QStyle::SH_TabBar_Alignment5The alignment for tabs in a QTabWidget. Possible values are Qt::AlignLeft, Qt::AlignCenter and Qt::AlignRight.
QStyle::SH_Header_ArrowAlignment6The placement of the sorting indicator may appear in list or table headers. Possible values are Qt::Left or Qt::Right.
QStyle::SH_Slider_SnapToValue7Sliders snap to values while moving, as they do on Windows.
QStyle::SH_Slider_SloppyKeyEvents8Key presses handled in a sloppy manner, i.e., left on a vertical slider subtracts a line.
QStyle::SH_ProgressDialog_CenterCancelButton9Center button on progress dialogs, otherwise right aligned.
QStyle::SH_ProgressDialog_TextLabelAlignment10The alignment for text labels in progress dialogs; Qt::AlignCenter on Windows, Qt::AlignVCenter otherwise.
QStyle::SH_PrintDialog_RightAlignButtons11Right align buttons in the print dialog, as done on Windows.
QStyle::SH_MainWindow_SpaceBelowMenuBar12One or two pixel space between the menu bar and the dockarea, as done on Windows.
QStyle::SH_FontDialog_SelectAssociatedText13Select the text in the line edit, or when selecting an item from the listbox, or when the line edit receives focus, as done on Windows.
QStyle::SH_Menu_KeyboardSearch?Typing causes a menu to be search for relevant items, otherwise only mnemonic is considered.
QStyle::SH_Menu_AllowActiveAndDisabled14Allows disabled menu items to be active.
QStyle::SH_Menu_SpaceActivatesItem15Pressing the space bar activates the item
QStyle::SH_Menu_SubMenuPopupDelay16Number of milliseconds to wait before opening a submenu (256 on Windows)
QStyle::SH_Menu_Scrollable?Whether popup menus must support scrolling.
QStyle::SH_Menu_SloppySubMenus?Whether popup menus must support the user moving the mouse cursor to a submenu while crossing other items of the menu. This is supported on most modern desktop platforms.
QStyle::SH_ScrollView_FrameOnlyAroundContents17Whether scrollviews draw their frame only around contents or around contents, scroll bars and corner widgets (like Windows).
QStyle::SH_MenuBar_AltKeyNavigation18Menu bars items are navigable by pressing Alt, followed by using the arrow keys to select the desired item.
QStyle::SH_ComboBox_ListMouseTracking19Mouse tracking in combobox drop-down lists.
QStyle::SH_Menu_MouseTracking20Mouse tracking in popup menus.
QStyle::SH_MenuBar_MouseTracking21Mouse tracking in menu bars.
QStyle::SH_Menu_FillScreenWithScroll?Whether scrolling popups should fill the screen as they are scrolled.
QStyle::SH_Menu_SelectionWrap?Whether popups should allow the selections to wrap, that is when selection should the next item be the first item.
QStyle::SH_ItemView_ChangeHighlightOnFocus22Gray out selected items when losing focus.
QStyle::SH_Widget_ShareActivation23Turn on sharing activation with floating modeless dialogs.
QStyle::SH_TabBar_SelectMouseType4Which type of mouse event should cause a tab to be selected.
QStyle::SH_TabBar_PreferNoArrows?Whether a tab bar should suggest a size to prevent scroll arrows.
QStyle::SH_ComboBox_Popup25Allows popups as a combobox drop-down menu.
QStyle::SH_Workspace_FillSpaceOnMaximize24The workspace should maximize the client area.
QStyle::SH_TitleBar_NoBorder26The title bar has no border.
QStyle::SH_ScrollBar_StopMouseOverSliderSH_Slider_StopMouseOverSliderObsolete. Use SH_Slider_StopMouseOverSlider instead.
QStyle::SH_Slider_StopMouseOverSlider27Stops auto-repeat when the slider reaches the mouse position.
QStyle::SH_BlinkCursorWhenTextSelected?Whether cursor should blink when text is selected.
QStyle::SH_RichText_FullWidthSelection?Whether richtext selections should extend to the full width of the document.
QStyle::SH_GroupBox_TextLabelVerticalAlignment?How to vertically align a group box's text label.
QStyle::SH_GroupBox_TextLabelColor?How to paint a group box's text label.
QStyle::SH_DialogButtons_DefaultButton?Which button gets the default status in a dialog's button widget.
QStyle::SH_ToolBox_SelectedPageTitleBold?Boldness of the selected page title in a QToolBox.
QStyle::SH_LineEdit_PasswordCharacter?The Unicode character to be used for passwords.
QStyle::SH_Table_GridLineColor?The RGB value of the grid for a table.
QStyle::SH_UnderlineShortcut?Whether shortcuts are underlined.
QStyle::SH_SpellCheckUnderlineStyle?A QTextCharFormat::UnderlineStyle value that specifies the way misspelled words should be underlined.
QStyle::SH_SpinBox_AnimateButton?Animate a click when up or down is pressed in a spin box.
QStyle::SH_SpinBox_KeyPressAutoRepeatRate?Auto-repeat interval for spinbox key presses.
QStyle::SH_SpinBox_ClickAutoRepeatRate?Auto-repeat interval for spinbox mouse clicks.
QStyle::SH_SpinBox_ClickAutoRepeatThreshold?Auto-repeat threshold for spinbox mouse clicks.
QStyle::SH_ToolTipLabel_Opacity?An integer indicating the opacity for the tip label, 0 is completely transparent, 255 is completely opaque.
QStyle::SH_DrawMenuBarSeparator?Indicates whether or not the menu bar draws separators.
QStyle::SH_TitleBar_ModifyNotification?Indicates if the title bar should show a '*' for windows that are modified.
QStyle::SH_Button_FocusPolicy?The default focus policy for buttons.
QStyle::SH_CustomBase0xf0000000Base value for custom style hints. Custom values must be greater than this value.
QStyle::SH_MenuBar_DismissOnSecondClick?A boolean indicating if a menu in the menu bar should be dismissed when it is clicked on a second time. (Example: Clicking and releasing on the File Menu in a menu bar and then immediately clicking on the File Menu again.)
QStyle::SH_MessageBox_UseBorderForButtonSpacing?A boolean indicating what the to use the border of the buttons (computed as half the button height) for the spacing of the button in a message box.
QStyle::SH_MessageBox_CenterButtons?A boolean indicating whether the buttons in the message box should be centered or not (see QDialogButtonBox::setCentered()).
QStyle::SH_MessageBox_TextInteractionFlags?A boolean indicating if the text in a message box should allow user interactions (e.g. selection) or not.
QStyle::SH_TitleBar_AutoRaise?A boolean indicating whether controls on a title bar ought to update when the mouse is over them.
QStyle::SH_ToolButton_PopupDelay?An int indicating the popup delay in milliseconds for menus attached to tool buttons.
QStyle::SH_FocusFrame_Mask?The mask of the focus frame.
QStyle::SH_RubberBand_Mask?The mask of the rubber band.
QStyle::SH_WindowFrame_Mask?The mask of the window frame.
QStyle::SH_SpinControls_DisableOnBounds?Determines if the spin controls will shown as disabled when reaching the spin range boundary.
QStyle::SH_Dial_BackgroundRole?Defines the style's preferred background role (as QPalette::ColorRole) for a dial widget.
QStyle::SH_ScrollBar_BackgroundMode?The background mode for a scroll bar.
QStyle::SH_ComboBox_LayoutDirection?The layout direction for the combo box. By default it should be the same as indicated by the QStyleOption::direction variable.
QStyle::SH_ItemView_EllipsisLocation?The location where ellipses should be added for item text that is too long to fit in an view item.
QStyle::SH_ItemView_ShowDecorationSelected?When an item in an item view is selected, also highlight the branch or other decoration.
QStyle::SH_ItemView_ActivateItemOnSingleClick?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_AbsoluteSetButtons?Which mouse buttons cause a slider to set the value to the position clicked on.
QStyle::SH_Slider_PageSetButtons?Which mouse buttons cause a slider to page step the value.
QStyle::SH_TabBar_ElideMode?The default eliding style for a tab bar.
QStyle::SH_DialogButtonLayout?Controls how buttons are laid out in a QDialogButtonBox, returns a QDialogButtonBox::ButtonLayout enum.
QStyle::SH_WizardStyle?Controls the look and feel of a QWizard. Returns a QWizard::WizardStyle enum.
QStyle::SH_FormLayoutWrapPolicy?Provides a default for how rows are wrapped in a QFormLayout. Returns a QFormLayout::RowWrapPolicy enum.
QStyle::SH_FormLayoutFieldGrowthPolicy?Provides a default for how fields can grow in a QFormLayout. Returns a QFormLayout::FieldGrowthPolicy enum.
QStyle::SH_FormLayoutFormAlignment?Provides a default for how a QFormLayout aligns its contents within the available space. Returns a Qt::Alignment enum.
QStyle::SH_FormLayoutLabelAlignment?Provides a default for how a QFormLayout aligns labels within the available space. Returns a Qt::Alignment> enum.
QStyle::SH_ItemView_ArrowKeysNavigateIntoChildren?Controls whether the tree view will select the first child when it is expanded and the right arrow key is pressed.
QStyle::SH_ComboBox_PopupFrameStyle?The frame style used when drawing a combobox popup menu.
QStyle::SH_DialogButtonBox_ButtonsHaveIcons?Indicates whether or not StandardButtons in QDialogButtonBox should have icons or not.
QStyle::SH_ItemView_MovementWithoutUpdatingSelection?The item view is able to indicate a current item without changing the selection.
QStyle::SH_ToolTip_Mask?The mask of a tool tip.
QStyle::SH_FocusFrame_AboveWidget?The FocusFrame is stacked above the widget that it is "focusing on".
QStyle::SH_TextControl_FocusIndicatorTextCharFormat?Specifies the text format used to highlight focused anchors in rich text documents displayed for example in QTextBrowser. The format has to be a QTextCharFormat returned in the variant of the QStyleHintReturnVariant return value. The QTextFormat::OutlinePen property is used for the outline and QTextFormat::BackgroundBrush for the background of the highlighted area.
QStyle::SH_Menu_FlashTriggeredItem?Flash triggered item.
QStyle::SH_Menu_FadeOutOnHide?Fade out the menu instead of hiding it immediately.
QStyle::SH_TabWidget_DefaultTabPosition?Default position of the tab bar in a tab widget.
QStyle::SH_ToolBar_Movable?Determines if the tool bar is movable by default.
QStyle::SH_ItemView_PaintAlternatingRowColorsForEmptyArea?Whether QTreeView paints alternating row colors for the area that does not have any items.
QStyle::SH_Menu_Mask?The mask for a popup menu.
QStyle::SH_ItemView_DrawDelegateFrame?Determines if there should be a frame for a delegate widget.
QStyle::SH_TabBar_CloseButtonPosition?Determines the position of the close button on a tab in a tab bar.
QStyle::SH_DockWidget_ButtonsHaveFrame?Determines if dockwidget buttons should have frames. Default is true.
QStyle::SH_ToolButtonStyle?Determines the default system style for tool buttons that uses Qt::ToolButtonFollowStyle.
QStyle::SH_RequestSoftwareInputPanel?Determines when a software input panel should be requested by input widgets. Returns an enum of type QStyle::RequestSoftwareInputPanel.
See also
styleHint()

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

ConstantValueDescription
QStyle::SE_PushButtonContents0Area containing the label (icon with text or pixmap).
QStyle::SE_PushButtonFocusRect1Area for the focus rect (usually larger than the contents rect).
QStyle::SE_PushButtonLayoutItem?Area that counts for the parent layout.
QStyle::SE_CheckBoxIndicator2Area for the state indicator (e.g., check mark).
QStyle::SE_CheckBoxContents3Area for the label (text or pixmap).
QStyle::SE_CheckBoxFocusRect4Area for the focus indicator.
QStyle::SE_CheckBoxClickRect5Clickable area, defaults to SE_CheckBoxFocusRect.
QStyle::SE_CheckBoxLayoutItem?Area that counts for the parent layout.
QStyle::SE_DateTimeEditLayoutItem?Area 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_RadioButtonLayoutItem?Area that counts for the parent layout.
QStyle::SE_ComboBoxFocusRect10Area for the focus indicator.
QStyle::SE_SliderFocusRect11Area for the focus indicator.
QStyle::SE_SliderLayoutItem?Area that counts for the parent layout.
QStyle::SE_SpinBoxLayoutItem?Area that counts for the parent layout.
QStyle::SE_ProgressBarGroove13Area for the groove.
QStyle::SE_ProgressBarContents14Area for the progress indicator.
QStyle::SE_ProgressBarLabel15Area for the text label.
QStyle::SE_ProgressBarLayoutItem?Area that counts for the parent layout.
QStyle::SE_FrameContents?Area for a frame's contents.
QStyle::SE_ShapedFrameContents?Area for a frame's contents using the shape in QStyleOptionFrameV3; see QFrame
QStyle::SE_FrameLayoutItem?Area that counts for the parent layout.
QStyle::SE_HeaderArrow27Area for the sort indicator for a header.
QStyle::SE_HeaderLabel26Area for the label in a header.
QStyle::SE_LabelLayoutItem?Area that counts for the parent layout.
QStyle::SE_LineEditContents?Area for a line edit's contents.
QStyle::SE_TabWidgetLeftCorner31Area for the left corner widget in a tab widget.
QStyle::SE_TabWidgetRightCorner32Area for the right corner widget in a tab widget.
QStyle::SE_TabWidgetTabBar28Area for the tab bar widget in a tab widget.
QStyle::SE_TabWidgetTabContents30Area for the contents of the tab widget.
QStyle::SE_TabWidgetTabPane29Area for the pane of a tab widget.
QStyle::SE_TabWidgetLayoutItem?Area that counts for the parent layout.
QStyle::SE_ToolBoxTabContents25Area for a toolbox tab's icon and label.
QStyle::SE_ToolButtonLayoutItem?Area that counts for the parent layout.
QStyle::SE_ItemViewItemCheckIndicatorSE_ViewItemCheckIndicatorArea for a view item's check mark.
QStyle::SE_TabBarTearIndicator?Area for the tear indicator on a tab bar with scroll arrows.
QStyle::SE_TreeViewDisclosureItem?Area for the actual disclosure item in a tree branch.
QStyle::SE_DialogButtonBoxLayoutItem?Area that counts for the parent layout.
QStyle::SE_GroupBoxLayoutItem?Area that counts for the parent layout.
QStyle::SE_CustomBase0xf0000000Base value for custom sub-elements. Custom values must be greater than this value.
QStyle::SE_DockWidgetFloatButton?The float button of a dock widget.
QStyle::SE_DockWidgetTitleBarText?The text bounds of the dock widgets title.
QStyle::SE_DockWidgetCloseButton?The close button of a dock widget.
QStyle::SE_DockWidgetIcon?The icon of a dock widget.
QStyle::SE_ComboBoxLayoutItem?Area that counts for the parent layout.
QStyle::SE_ItemViewItemDecoration?Area for a view item's decoration (icon).
QStyle::SE_ItemViewItemText?Area for a view item's text.
QStyle::SE_ItemViewItemFocusRect?Area for a view item's focus rect.
QStyle::SE_TabBarTabLeftButton?Area for a widget on the left side of a tab in a tab bar.
QStyle::SE_TabBarTabRightButton?Area for a widget on the right side of a tab in a tab bar.
QStyle::SE_TabBarTabText?Area for the text on a tab in a tab bar.
QStyle::SE_ToolBarHandle?Area for the handle of a tool bar.
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 (i.e., a mouse button or the space bar is pressed).
State_OnSet if the tool button is a toggle button and is toggled on.
State_AutoRaiseSet if the tool button has auto-raise enabled.
State_RaisedSet if the button is not down, not on, and 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_MenuBarItemQStyleOptionMenuItemState_SelectedThe menu item is currently selected item.
State_EnabledThe item is enabled.
State_DownArrowIndicates that a scroll down arrow should be drawn.
State_UpArrowIndicates that a scroll up arrow should be drawn
State_HasFocusSet if the menu bar has input focus.
CE_PushButton, CE_PushButtonBevel, CE_PushButtonLabelQStyleOptionButtonState_EnabledSet if the button is enabled.
State_HasFocusSet if the button has input focus.
State_RaisedSet if the button is not down, not on and not flat.
State_OnSet if the button is a toggle button and is toggled on.
State_SunkenSet if the button is down (i.e., the mouse button or the space bar is pressed on the button).
CE_RadioButton, CE_RadioButtonLabel, CE_CheckBox, CE_CheckBoxLabelQStyleOptionButtonState_EnabledSet if the button is enabled.
State_HasFocusSet if the button has input focus.
State_OnSet if the button is checked.
State_OffSet if the button is not checked.
State_NoChangeSet if the button is in the NoChange state.
State_SunkenSet if the button is down (i.e., the mouse button or the space bar is pressed on the button).
CE_ProgressBarContents, CE_ProgressBarLabel, CE_ProgressBarGrooveQStyleOptionProgressBarState_EnabledSet if the progress bar is enabled.
State_HasFocusSet if the progress bar has input focus.
CE_Header, CE_HeaderSection, CE_HeaderLabelQStyleOptionHeader
CE_TabBarTab, CE_TabBarTabShape, CE_TabBarTabLabelQStyleOptionTabState_EnabledSet if the tab bar is enabled.
State_SelectedThe tab bar is the currently selected tab bar.
State_HasFocusSet if the tab bar tab has input focus.
CE_ToolButtonLabelQStyleOptionToolButtonState_EnabledSet if the tool button is enabled.
State_HasFocusSet if the tool button has input focus.
State_SunkenSet if the tool button is down (i.e., a mouse button or the space bar is pressed).
State_OnSet if the tool button is a toggle button and is toggled on.
State_AutoRaiseSet if the tool button has auto-raise enabled.
State_MouseOverSet if the mouse pointer is over the tool button.
State_RaisedSet if the button is not down and is not on.
CE_ToolBoxTabQStyleOptionToolBoxState_SelectedThe tab is the currently selected tab.
CE_HeaderSectionQStyleOptionHeaderState_SunkenIndicates that the section is pressed.
State_UpArrowIndicates that the sort indicator should be pointing up.
State_DownArrowIndicates that the sort indicator should be pointing down.
See also
drawPrimitive(), 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_PanelButtonCommandQStyleOptionButtonState_EnabledSet if the button is enabled.
State_HasFocusSet if the button has input focus.
State_RaisedSet if the button is not down, not on and not flat.
State_OnSet if the button is a toggle button and is toggled on.
State_SunkenSet if the button is down (i.e., the mouse button or the space bar is pressed on the button).
See also
drawComplexControl(), 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.

Note that 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.

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