Home · All Classes · Main Classes · Grouped Classes · Modules · Functions

QStyle Class Reference
[QtGui module]

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

#include <QStyle>

Inherits QObject.

Inherited by QCommonStyle.

Public Types

Public Functions

Static Public Members

Protected Slots

Additional Inherited Members


Detailed Description

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

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

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

Eight combo boxes

Topics:

Setting a Style

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

    ./myapplication -style motif

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

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

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 drawItem(), drawPrimitive(), drawControl(), and drawComplexControl().

Most QStyle draw functions take four arguments:

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

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

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

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

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

QStyleOption has various subclasses for the various types of graphical elements that can be drawn. For example, PE_FrameFocusRect expects a QStyleOptionFocusRect argument. This is documented for each enum value.

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

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

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

instead of

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

Creating a Custom Style

If you want to design a custom look and feel for your application, the first step is to pick one of the base styles provided with Qt to build your custom style from. The choice will depend on which existing style resembles your style the most.

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
    {
        Q_OBJECT

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

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

The PE_IndicatorSpinUp and PE_IndicatorSpinDown primitive elements are used by QSpinBox to draw its up and down arrows. Here's how to reimplement drawPrimitive() 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) {
            QPointArray 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 & Style_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 don't use the widget argument, except to pass it on to QWindowStyle::drawPrimitive(). As mentioned earlier, the information about what is to be drawn and how it should be drawn is specified by a QStyleOption object, so there is no need to ask the widget.

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

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

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

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

Using a Custom Style

There are several ways of using a custom style in a Qt application. The simplest way is call 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, but by calling it before the constructor, you ensure that the user's preference, set using the -style command-line option, is respected.

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

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

    ./myapplication -style custom

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

Right-to-Left Desktops

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

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

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

See also QStyleOption and QStylePainter.


Member Type Documentation

enum QStyle::ComplexControl

This enum represents a ComplexControl. ComplexControls 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 what is used in Q3Workspace
QStyle::CC_Q3ListView6Used for drawing the Q3ListView class
QStyle::CC_GroupBox8A group box, like QGroupBox
QStyle::CC_Dial7A dial, like QDial
QStyle::CC_CustomBase0xf0000000Base value for custom ControlElements. Custom values must be greater than this value.

See also SubControl and drawComplexControl().

enum QStyle::ContentsType

This enum represents a ContentsType. It is 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_DialogButtons20 
QStyle::CT_Q3DockWindow6 
QStyle::CT_HeaderSection21A header section, like QHeader
QStyle::CT_LineEdit16A line edit, like QLineEdit
QStyle::CT_Menu11A menu, like QMenu
QStyle::CT_Q3Header15A Qt 3 header section, like Q3Header
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_CustomBase0xf0000000Base value for custom ControlElements. Custom values must be greater than this value.

See also sizeFromContents().

enum QStyle::ControlElement

This enum represents a ControlElement. A ControlElement is 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 (icon with text or pixmap) of a QPushButton
QStyle::CE_DockWidgetTitle31Dock window title.
QStyle::CE_Splitter29Splitter handle; see also QSplitter.
QStyle::CE_CheckBox3A QCheckBox, draws a PE_IndicatorCheckBox, a CE_CheckBoxLabel and a PE_FrameFocusRect
QStyle::CE_CheckBoxLabel4The label (text or pixmap) of a QCheckBox
QStyle::CE_RadioButton5A QRadioButton, draws a PE_ExclusiveRadioButton, 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_Q3DockWindowEmptyArea26The empty area of a QDockWidget
QStyle::CE_ToolBoxTab27The toolbox's tab area
QStyle::CE_SizeGrip28Window resize handle; see also 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); see also QScrollBar.
QStyle::CE_ScrollBarSubLine33Scroll bar line decrease indicator (i.e., scroll up).
QStyle::CE_ScrollBarAddPage34Scolllbar 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 such things as iconview.
QStyle::CE_FocusFrame39Focus Frame that can is style controled.
QStyle::CE_CustomBase0xf0000000Base value for custom ControlElements; custom values must be greater than this value
QStyle::CE_ComboBoxLabel40The label of a non-editable QComboBox
QStyle::CE_ToolBar41A toolbar like QToolBar

See also drawControl().

enum QStyle::PixelMetric

This enum represents a PixelMetric. A PixelMetric is a style dependent size represented as a single pixel value.

ConstantValueDescription
QStyle::PM_ButtonMargin0Amount of whitespace between push 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_MDIFrameWidth46Frame width of an MDI window
QStyle::PM_MDIMinimizedWidth47Width of a minimized MDI window
QStyle::PM_MaximumDragDistance8Some feels require the scroll bar or other sliders to jump back to the original position when the mouse pointer is too far away while dragging; 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_DockWidgetTitleMargin75Margin of the dock window title
QStyle::PM_MenuBarPanelWidth33Frame width of a menubar, defaults to PM_DefaultFrameWidth
QStyle::PM_MenuBarItemSpacing34Spacing between menubar items
QStyle::PM_MenuBarHMargin36Spacing between menubar items and left/right of bar
QStyle::PM_MenuBarVMargin35Spacing between menubar items and top/bottom of bar
QStyle::PM_ToolBarFrameWidth54Width of the frame around toolbars
QStyle::PM_ToolBarHandleExtent55Width of a toolbar handle in a horizontal toolbar and the height of the handle in a vertical toolbar
QStyle::PM_ToolBarItemMargin57Spacing between the toolbar frame and the items
QStyle::PM_ToolBarItemSpacing56Spacing between toolbar items
QStyle::PM_ToolBarSeparatorExtent58Width of a toolbar separator in a horizontal toolbar and the height of a separator in a vertical toolbar
QStyle::PM_ToolBarExtensionExtent59Width 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
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_TabBarScrollButtonWidth53 
QStyle::PM_TabBarTabShiftHorizontal51Horizontal pixel shift when a tab is selected
QStyle::PM_TabBarTabShiftVertical52Vertical 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_MenuScrollerHeight27Height of the scroller area in a QMenu
QStyle::PM_MenuTearoffHeight31Height of a tear off area in a QMenu
QStyle::PM_MenuDesktopFrameWidth32 
QStyle::PM_CheckListButtonSize41Area (width/height) of the checkbox/radio button in a Q3CheckListItem
QStyle::PM_CheckListControllerSize42Area (width/height) of the controller in a Q3CheckListItem
QStyle::PM_DialogButtonsSeparator43Distance between buttons in a dialog buttons widget
QStyle::PM_DialogButtonsButtonWidth44Minimum width of a button in a dialog buttons widget
QStyle::PM_DialogButtonsButtonHeight45Minimum height of a button in a dialog buttons widget
QStyle::PM_HeaderMarkSize49 
QStyle::PM_HeaderGripMargin50 
QStyle::PM_HeaderMargin48 
QStyle::PM_SpinBoxSliderHeight60The height of the optional spin box slider
QStyle::PM_DefaultTopLevelMargin61 
QStyle::PM_DefaultChildMargin62 
QStyle::PM_DefaultLayoutSpacing63 
QStyle::PM_ToolBarIconSize64Default tool bar icon size
QStyle::PM_SmallIconSize67Default small icon size
QStyle::PM_LargeIconSize68Default large icon size
QStyle::PM_FocusFrameHMargin70Horizontal margin that the focus frame will outset the widget by.
QStyle::PM_FocusFrameVMargin69Vertical margin that the focus frame will outset the widget by.
QStyle::PM_IconViewIconSize66 
QStyle::PM_ListViewIconSize65 
QStyle::PM_ToolTipLabelFrameWidth71 
QStyle::PM_CheckBoxLabelSpacing72The spacing between a check box and its label
QStyle::PM_TabBarIconSize73The default icon size for a tab bar.
QStyle::PM_SizeGripSize74The size of a size grip
QStyle::PM_CustomBase0xf0000000Base value for custom ControlElements Custom values must be greater than this value

See also pixelMetric().

enum QStyle::PrimitiveElement

This enum represents a style's PrimitiveElements. A PrimitiveElement is a common GUI element, such as a checkbox indicator or button bevel.

ConstantValueDescription
QStyle::PE_PanelButtonCommand18Button used to initiate an action, for example, a QPushButton.
QStyle::PE_FrameDefaultButton6This frame around a default button, e.g. in a dialog.
QStyle::PE_PanelButtonBevel19Generic panel with a button bevel.
QStyle::PE_PanelButtonTool20Panel for a Tool button, used with QToolButton.
QStyle::PE_PanelLineEdit23Panel for a QLineEdit.
QStyle::PE_IndicatorButtonDropDown29indicator for a drop down button, for example, a tool button that displays a menu.
QStyle::PE_FrameFocusRect8Generic focus indicator.
QStyle::PE_IndicatorArrowUp27Generic Up arrow.
QStyle::PE_IndicatorArrowDown24Generic Down arrow.
QStyle::PE_IndicatorArrowRight26Generic Right arrow.
QStyle::PE_IndicatorArrowLeft25Generic Left arrow.
QStyle::PE_IndicatorSpinUp40Up symbol for a spin widget, for example a QSpinBox.
QStyle::PE_IndicatorSpinDown37Down symbol for a spin widget.
QStyle::PE_IndicatorSpinPlus39Increase symbol for a spin widget.
QStyle::PE_IndicatorSpinMinus38Decrease symbol for a spin widget.
QStyle::PE_IndicatorViewItemCheck30On/off indicator for a view item
QStyle::PE_IndicatorCheckBox31On/off indicator, for example, a QCheckBox.
QStyle::PE_IndicatorRadioButton36Exclusive on/off indicator, for example, a QRadioButton.
QStyle::PE_Q3DockWindowSeparator3Item separator for Qt 3 compatible dock window and toolbar contents.
QStyle::PE_IndicatorDockWidgetResizeHandle32Resize handle for dock windows.
QStyle::PE_Frame5Generic frame; see also QFrame.
QStyle::PE_FrameMenu11Frame for popup windows/menus; see also QMenu.
QStyle::PE_PanelMenuBar21Panel for menu bars.
QStyle::PE_FrameDockWidget7Panel frame for dock windows and toolbars.
QStyle::PE_FrameTabWidget13Frame for tab widgets.
QStyle::PE_FrameLineEdit10Panel frame for line edits.
QStyle::PE_FrameGroupBox9Panel frame around group boxes.
QStyle::PE_FrameButtonBevel15Panel frame for a button bevel
QStyle::PE_FrameButtonTool16Panel frame for a tool button
QStyle::PE_IndicatorHeaderArrow33Arrow used to indicate sorting on a list or table header
QStyle::PE_FrameStatusBar12Frame for a section of a status bar; see also QStatusBar.
QStyle::PE_FrameWindow14Frame around a MDI window or a docking window.
QStyle::PE_Q3Separator4Qt 3 compatible generic separator.
QStyle::PE_IndicatorMenuCheckMark34Check mark used in a menu.
QStyle::PE_IndicatorProgressChunk35Section of a progress bar indicator; see also QProgressBar.
QStyle::PE_Q3CheckListController0Qt 3 compatible Controller part of a list view item.
QStyle::PE_Q3CheckListIndicator2Qt 3 compatible Checkbox part of a list view item.
QStyle::PE_Q3CheckListExclusiveIndicator1Qt 3 compatible Radio button part of a list view item.
QStyle::PE_IndicatorBranch28Lines used to represent the branch of a tree in a tree view.
QStyle::PE_IndicatorToolBarHandle41The handle of a toolbar.
QStyle::PE_IndicatorToolBarSeparator42The separator in a toolbar.
QStyle::PE_PanelToolBar22The panel for a toolbar.
QStyle::PE_PanelTipLabel43The panel for a tip label.
QStyle::PE_FrameTabBarBase17The frame that is drawn for a tabbar, ususally drawn for a tabbar that isn't part of a tab widget
QStyle::PE_IndicatorTabTear44An indicator that a tab is partially scrolled out of the visible tab bar when there are many tabs.
QStyle::PE_CustomBase0xf000000Base value for custom PrimitiveElements. All values above this are reserved for custom use. Custom values must be greater than this value.

See also drawPrimitive().

enum QStyle::StandardPixmap

This enum represents a StandardPixmap. A StandardPixmap is a pixmap that can follow some existing GUI style or guideline.

ConstantValueDescription
QStyle::SP_TitleBarMinButton1Minimize button on title bars (e.g., in QWorkspace)
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_DesktopIcon13 
QStyle::SP_TrashIcon14 
QStyle::SP_ComputerIcon15 
QStyle::SP_DriveFDIcon16 
QStyle::SP_DriveHDIcon17 
QStyle::SP_DriveCDIcon18 
QStyle::SP_DriveDVDIcon19 
QStyle::SP_DriveNetIcon20 
QStyle::SP_DirOpenIcon21 
QStyle::SP_DirClosedIcon22 
QStyle::SP_DirLinkIcon23 
QStyle::SP_FileIcon24 
QStyle::SP_FileLinkIcon25 
QStyle::SP_FileDialogStart28 
QStyle::SP_FileDialogEnd29 
QStyle::SP_FileDialogToParent30 
QStyle::SP_FileDialogNewFolder31 
QStyle::SP_FileDialogDetailedView32 
QStyle::SP_FileDialogInfoView33 
QStyle::SP_FileDialogContentsView34 
QStyle::SP_FileDialogListView35 
QStyle::SP_FileDialogBack36 
QStyle::SP_DockWidgetCloseButton8Close button on dock windows (see also QDockWidget)
QStyle::SP_ToolBarHorizontalExtensionButton26Extension button for horizontal toolbars
QStyle::SP_ToolBarVerticalExtensionButton27Extension button for vertical toolbars
QStyle::SP_CustomBase0xf0000000Base value for custom ControlElements; custom values must be greater than this value

See also standardPixmap().

enum QStyle::StateFlag
flags QStyle::State

This enum represents flags for drawing PrimitiveElements. Not all primitives use all of these flags. Note that these flags may mean different things to different primitives.

ConstantValue
QStyle::State_Active0x00010000
QStyle::State_AutoRaise0x00001000
QStyle::State_Bottom0x00000400
QStyle::State_Children0x00080000
QStyle::State_None0x00000000
QStyle::State_DownArrow0x00000040
QStyle::State_Editing0x00400000
QStyle::State_Enabled0x00000001
QStyle::State_FocusAtBorder0x00000800
QStyle::State_HasFocus0x00000100
QStyle::State_HasFocus0x00000100
QStyle::State_Horizontal0x00000080
QStyle::State_Item0x00100000
QStyle::State_MouseOver0x00002000
QStyle::State_NoChange0x00000010
QStyle::State_Off0x00000008
QStyle::State_On0x00000020
QStyle::State_Open0x00040000
QStyle::State_Raised0x00000002
QStyle::State_Selected0x00008000
QStyle::State_Sibling0x00200000
QStyle::State_Sunken0x00000004
QStyle::State_Top0x00000200
QStyle::State_UpArrow0x00004000
QStyle::State_KeyboardFocusChange0x00800000
QStyle::State_ReadOnly0x02000000

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

See also drawPrimitive().

enum QStyle::StyleHint

This enum represents a StyleHint. A StyleHint is a general look and/or feel hint.

ConstantValueDescription
QStyle::SH_EtchDisabledText0Disabled text is "etched" as it is on Windows.
QStyle::SH_DitherDisabledText1 
QStyle::SH_GUIStyle0x00000100The GUI style to use.
QStyle::SH_ScrollBar_MiddleClickAbsolutePosition2A boolean value. If true, middle clicking on a scroll bar causes the slider to jump to that position. If false, middle clicking is ignored.
QStyle::SH_ScrollBar_LeftClickAbsolutePosition39A boolean value. If true, left clicking on a scroll bar causes the slider to jump to that position. If false, left clicking will behave as appropriate for each control.
QStyle::SH_ScrollBar_ScrollWhenPointerLeavesControl3A boolean value. If true, when clicking a scroll bar SubControl, holding the mouse button down and moving the pointer outside the SubControl, the scroll bar continues to scroll. If false, the scollbar stops scrolling when the pointer leaves the SubControl.
QStyle::SH_ScrollBar_RollBetweenButtons64A boolean value. If true, when clicking a scrollbar 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 pushbutton).
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, like Motif, otherwise right aligned.
QStyle::SH_ProgressDialog_TextLabelAlignment10Type Qt::Alignment. Text label alignment in progress dialogs; Qt::Center on windows, Qt::VCenter 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 menubar 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_AllowActiveAndDisabled14Allows disabled menu items to be active.
QStyle::SH_Menu_SpaceActivatesItem15Pressing the space bar activates the item, as done on Motif.
QStyle::SH_Menu_SubMenuPopupDelay16The number of milliseconds to wait before opening a submenu (256 on windows, 96 on Motif).
QStyle::SH_Menu_Scrollable30Whether popup menus must support scrolling.
QStyle::SH_Menu_SloppySubMenus33Whether popupmenu's must support sloppy submenu; as implemented on Mac OS.
QStyle::SH_ScrollView_FrameOnlyAroundContents17Whether scrollviews draw their frame only around contents (like Motif), or around contents, scroll bars and corner widgets (like Windows).
QStyle::SH_MenuBar_AltKeyNavigation18Menu bars items are navigable by pressing Alt, followed by using the arrow keys to select the desired item.
QStyle::SH_ComboBox_ListMouseTracking19Mouse tracking in combobox drop-down lists.
QStyle::SH_Menu_MouseTracking20Mouse tracking in popup menus.
QStyle::SH_MenuBar_MouseTracking21Mouse tracking in menubars.
QStyle::SH_Menu_FillScreenWithScroll45Whether scrolling popups should fill the screen as they are scrolled.
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_Q3ListViewExpand_SelectMouseType40Which type of mouse event should cause a list view expansion to be selected.
QStyle::SH_TabBar_PreferNoArrows38Whether a tabbar should suggest a size to prevent scoll 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_StopMouseOverSlider27Stops auto-repeat when the slider reaches the mouse position.
QStyle::SH_BlinkCursorWhenTextSelected28Whether cursor should blink when text is selected.
QStyle::SH_RichText_FullWidthSelection29Whether richtext selections should extend to the full width of the document.
QStyle::SH_GroupBox_TextLabelVerticalAlignment31How to vertically align a groupbox's text label.
QStyle::SH_GroupBox_TextLabelColor32How to paint a groupbox's text label.
QStyle::SH_DialogButtons_DefaultButton36Which button gets the default status in a dialog's button widget.
QStyle::SH_ToolBox_SelectedPageTitleBold37Boldness of the selected page title in a QToolBox.
QStyle::SH_LineEdit_PasswordCharacter35The Unicode character to be used for passwords.
QStyle::SH_Table_GridLineColor34 
QStyle::SH_UnderlineShortcut41Whether shortcuts are underlined.
QStyle::SH_SpinBox_AnimateButton42Animate a click when up or down is pressed in a spin box.
QStyle::SH_SpinBox_KeyPressAutoRepeatRate43Auto-repeat interval for spinbox key presses.
QStyle::SH_SpinBox_ClickAutoRepeatRate44Auto-repeat interval for spinbox mouse clicks.
QStyle::SH_ToolTipLabel_Opacity46An integer indicating the opacity for the tip label, 0 is completely transparent, 255 is completely opaque.
QStyle::SH_DrawMenuBarSeparator47Indicates whether or not the menubar draws separators.
QStyle::SH_TitleBar_ModifyNotification48Indicates if the titlebar should show a '*' for windows that are modified.
QStyle::SH_Button_FocusPolicy49The default focus policy for buttons.
QStyle::SH_CustomBase0xf0000000Base value for custom ControlElements. Custom values must be greater than this value.
QStyle::SH_MenuBar_DismissOnSecondClick50A boolean indicating if a menu in the menubar should be dismissed when it is clicked on a second time. (Example: Clicking and releasing on the File Menu in a menubar and then immediately clicking on the File Menu again.)
QStyle::SH_MessageBox_UseBorderForButtonSpacing51A 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_TitleBar_AutoRaise52A boolean indicating whether controls on a title bar ought to update when the mouse is over them.
QStyle::SH_ToolButton_PopupDelay53An int indicating the popup delay in milliseconds for menus attached to tool buttons.
QStyle::SH_FocusFrame_Mask54The mask of the focus frame.
QStyle::SH_RubberBand_Mask55The mask of the rubber band.
QStyle::SH_WindowFrame_Mask56The mask of the window frame.
QStyle::SH_SpinControls_DisableOnBounds57Determines if the spin controls will shown as disabled when reaching the spin range boundary.
QStyle::SH_Dial_BackgroundRole58Defines the style's preferred background role (as QPalette::ColorRole) for a dial widget.
QStyle::SH_ScrollBar_BackgroundMode The backgroundMode() for a scroll bar.
QStyle::SH_ComboBox_LayoutDirection59The layout direction for the combo box. By default it should be the same value as the QStyleOption's direction.
QStyle::SH_ItemView_EllipsisLocation60The location where ellipses should be added for item text that is too long to fit in an view item.
QStyle::SH_ItemView_ShowDecorationSelected61When an item in an item view is selected, also highlight the branch or other decoration.
QStyle::SH_ItemView_ActivateItemOnSingleClick62Emit 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.

See also styleHint().

enum QStyle::SubControl
flags QStyle::SubControls

This enum represents a SubControl within a ComplexControl.

ConstantValueDescription
QStyle::SC_None0x00000000Special value that matches no other SubControl.
QStyle::SC_ScrollBarAddLine0x00000001Scroll bar add line (i.e., down/right arrow); see also QScrollBar
QStyle::SC_ScrollBarSubLine0x00000002Scroll bar sub line (i.e., up/left arrow)
QStyle::SC_ScrollBarAddPage0x00000004Scroll bar add page (i.e., page down)
QStyle::SC_ScrollBarSubPage0x00000008Scroll bar sub page (i.e., page up)
QStyle::SC_ScrollBarFirst0x00000010Scroll bar first line (i.e., home)
QStyle::SC_ScrollBarLast0x00000020Scroll bar last line (i.e., end)
QStyle::SC_ScrollBarSlider0x00000040Scroll bar slider handle
QStyle::SC_ScrollBarGroove0x00000080Special sub-control which contains the area in which the slider handle may move
QStyle::SC_SpinBoxUp0x00000001Spinwidget up/increase; see also QSpinBox
QStyle::SC_SpinBoxDown0x00000002Spinwidget down/decrease
QStyle::SC_SpinBoxFrame0x00000004Spinwidget frame
QStyle::SC_SpinBoxEditField0x00000008Spinwidget edit field
QStyle::SC_ComboBoxEditField0x00000002Combobox edit field; see also QComboBox
QStyle::SC_ComboBoxArrow0x00000004Combobox arrow button
QStyle::SC_ComboBoxFrame0x00000001Combobox frame
QStyle::SC_ComboBoxListBoxPopup0x00000008The reference rect for the combobox popup Used to calculate the position of the popup.
QStyle::SC_SliderGroove0x00000001Special sub-control which contains the area in which the slider handle may move
QStyle::SC_SliderHandle0x00000002Slider handle
QStyle::SC_SliderTickmarks0x00000004Slider tickmarks
QStyle::SC_ToolButton0x00000001Tool button (see also QToolButton)
QStyle::SC_ToolButtonMenu0x00000002Sub-control for opening a popup menu in a tool button; see also Q3PopupMenu
QStyle::SC_TitleBarSysMenu0x00000001System menu button (i.e., restore, close, etc.)
QStyle::SC_TitleBarMinButton0x00000002Minimize button
QStyle::SC_TitleBarMaxButton0x00000004Maximize button
QStyle::SC_TitleBarCloseButton0x00000008Close button
QStyle::SC_TitleBarLabel0x00000100Window title label
QStyle::SC_TitleBarNormalButton0x00000010Normal (restore) button
QStyle::SC_TitleBarShadeButton0x00000020Shade button
QStyle::SC_TitleBarUnshadeButton0x00000040Unshade button
QStyle::SC_TitleBarContextHelpButton0x00000080Context Help button
QStyle::SC_Q3ListView0x00000001The list view area
QStyle::SC_Q3ListViewExpand0x00000004Expand item (i.e., show/hide child items)
QStyle::SC_DialHandle0x00000002The handle of the dial (i.e. what you use to control the dial)
QStyle::SC_DialGroove0x00000001The groove for the dial
QStyle::SC_DialTickmarks0x00000004The tickmarks for the dial
QStyle::SC_GroupBoxFrame0x00000008The frame of a group box
QStyle::SC_GroupBoxLabel0x00000002The title of a group box
QStyle::SC_GroupBoxCheckBox0x00000001The optional check box of a group box
QStyle::SC_GroupBoxContents0x00000004The group box contents
QStyle::SC_All0xffffffffSpecial value that matches all SubControls

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

See also ComplexControl.

enum QStyle::SubElement

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

ConstantValueDescription
QStyle::SE_PushButtonContents0Area containing the label (icon with text or pixmap)
QStyle::SE_PushButtonFocusRect1Area for the focus rect (usually larger than the contents rect)
QStyle::SE_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_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_ComboBoxFocusRect10Area for the focus indicator
QStyle::SE_SliderFocusRect11Area for the focus indicator
QStyle::SE_Q3DockWindowHandleRect12Area for the tear-off handle
QStyle::SE_ProgressBarGroove13Area for the groove
QStyle::SE_ProgressBarContents14Area for the progress indicator
QStyle::SE_ProgressBarLabel15Area for the text label
QStyle::SE_DialogButtonAccept16Area for a dialog's accept button
QStyle::SE_DialogButtonReject17Area for a dialog's reject button
QStyle::SE_DialogButtonApply18Area for a dialog's apply button
QStyle::SE_DialogButtonHelp19Area for a dialog's help button
QStyle::SE_DialogButtonAll20Area for a dialog's all button
QStyle::SE_DialogButtonRetry23Area for a dialog's retry button
QStyle::SE_DialogButtonAbort21Area for a dialog's abort button
QStyle::SE_DialogButtonIgnore22Area for a dialog's ignore button
QStyle::SE_DialogButtonCustom24Area for a dialog's custom widget area (in the button row)
QStyle::SE_HeaderArrow27 
QStyle::SE_HeaderLabel26 
QStyle::SE_TabWidgetLeftCorner31 
QStyle::SE_TabWidgetRightCorner32 
QStyle::SE_TabWidgetTabBar28 
QStyle::SE_TabWidgetTabContents30 
QStyle::SE_TabWidgetTabPane29 
QStyle::SE_ToolBoxTabContents25Area for a toolbox tab's icon and label
QStyle::SE_ViewItemCheckIndicator33Area for a view item's check mark
QStyle::SE_TabBarTearIndicator34Area for the tear indicator on a tab bar with scroll arrows.
QStyle::SE_TreeViewDisclosureItem35Area for the actual disclosure item in a tree branch.
QStyle::SE_CustomBase0xf0000000Base value for custom ControlElements Custom values must be greater than this value

See also subElementRect().


Member Function Documentation

QStyle::QStyle ()

Constructs a style object.

QStyle::~QStyle ()   [virtual]

Destroys the style object.

QRect QStyle::alignedRect ( Qt::LayoutDirection direction, Qt::Alignment alignment, const QSize & size, const QRect & rectangle )   [static]

Returns a new rectangle of size that is aligned to rectangle according to alignment and based on direction.

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

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

The widget argument is optional and may contain a widget to aid in drawing control.

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

Here is a table listing the elements and what they can be cast to, along with an explaination of the flags.

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

See also ComplexControl, SubControl, and QStyleOptionComplex.

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

Draws the ControlElement element with painter with the style options specified by option.

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

What follows is a table of the elements and the QStyleOption structure the option parameter can cast to. The flags stored in the QStyleOption state variable are also listed. If a ControlElement is not listed here, it uses a plain QStyleOption.

ControlElementOption CastStyle FlagRemark
CE_MenuItem, CE_MenuBarItemQStyleOptionMenuItemState_SelectedThe menu item is currently selected item
State_EnabledThe item is enabled
State_DownArrowSet if the menu item is down (i.e., if the mouse button or the space bar is pressed)
State_HasFocusSet if the menubar has input focus
CE_PushButton, 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 progressbar is enabled
State_HasFocusSet if the progressbar has input focus
CE_Header, CE_HeaderSection, CE_HeaderLabelQStyleOptionHeader
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 ControlElement, State, and QStyleOption.

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

Draws the pixmap in rectangle rect with alignment alignment using painter.

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

Draws the text in rectangle rect using painter and palette pal.

Text is drawn using the painter's pen. If an explicit textRole is specified, then the text is drawn using the color specified in pal for the specified role. The enabled bool indicates whether or not the item is enabled; when reimplementing this bool should influence how the item is drawn.

The text is aligned and wrapped according to alignment.

See also Qt::Alignment.

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

Draw the primitive option elem with 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.

What follows is a table of the elements and the QStyleOption structure the option parameter can be cast to. The flags stored in the QStyleOption state variable are also listed. If a PrimitiveElement is not listed here, it uses a plain QStyleOption.

The QStyleOption is the the following for the following types of PrimitiveElements.

PrimitiveElementOption CastStyle 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.
PE_Q3CheckListExclusiveIndicator, PE_Q3CheckListIndicatorQStyleOptionQ3ListViewState_OnIndicates whether or not the controller is selected.
State_NoChangeIndicates a "tri-state" controller.
State_EnabledIndicates the controller is enabled.
PE_IndicatorBranchQStyleOptionState_DownArrowIndicates that the Tree Branch is pressed
State_OpenIndicates that the tree branch is expanded.
PE_IndicatorHeaderArrowQStyleOptionHeaderState_UpArrowIndicates that the arrow should be drawn up; otherwise it should be down.
PE_FrameGroupBox, PE_Frame, PE_FrameLineEdit, PE_FrameMenu, PE_FrameDockWidgetQStyleOptionFrameState_SunkenIndicates that the Frame should be sunken.
PE_IndicatorToolBarHandleQStyleOptionState_HorizontalIndicates that the window handle is horizontal instead of vertical.
PE_Q3DockWindowSeparatorQStyleOptionState_HorizontalIndicates that the separator is horizontal instead of vertical.
PE_IndicatorSpinPlus, PE_IndicatorSpinMinus, PE_IndicatorSpinUp, PE_IndicatorSpinDown,QStyleOptionSpinBoxState_SunkenIndicates that the button is pressed.

See also PrimitiveElement, State, and QStyleOption.

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

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

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

Not all types of pixmaps will change from their input in which case the result will simply be the pixmap passed in.

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

Returns the SubControl in the ComplexControl control with the style options specified by option at the point pos. The option argument is a pointer to a QStyleOptionComplex structure or one of its subclasses. The structure can be cast to the appropriate type based on the value of control. See drawComplexControl() for details.

The widget argument is optional and can contain additional information for the functions.

Note that pos is expressed in screen coordinates.

See also drawComplexControl(), ComplexControl, SubControl, subControlRect(), and QStyleOptionComplex.

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

Returns the appropriate area within rectangle rect in which to draw the pixmap with alignment defined in alignment.

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

Returns the appropriate area (see below) within rectangle rect in which to draw text using the font metrics metrics.

The text is aligned in accordance with alignment. The enabled bool indicates whether or not the item is enabled.

If rect is larger than the area needed to render the text the rectangle that is returned will be offset within rect in accordance with the alignment alignment. For example, if alignment is Qt::AlignCenter, the returned rectangle will be centered within rect. If rect is smaller than the area needed, the rectangle that is returned will be larger than rect (the smallest rectangle large enough to render the text).

See also Qt::Alignment.

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

Returns the pixel metric for the given metric. The option and widget can be used for calculating the metric. The option can be cast to the appropriate type based on the value of metric. Note that option may be zero even for PixelMetrics that can make use of option. See the table below for the appropriate option casts:

PixelMetricOption Cast
PM_SliderControlThicknessQStyleOptionSlider
PM_SliderLengthQStyleOptionSlider
PM_SliderTickmarkOffsetQStyleOptionSlider
PM_SliderSpaceAvailableQStyleOptionSlider
PM_ScrollBarExtentQStyleOptionSlider
PM_TabBarTabOverlapQStyleOptionTab
PM_TabBarTabHSpaceQStyleOptionTab
PM_TabBarTabVSpaceQStyleOptionTab
PM_TabBarBaseHeightQStyleOptionTab
PM_TabBarBaseOverlapQStyleOptionTab

In general, the widget argument is not used.

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

Initializes the appearance of widget.

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

Reasonable actions in this function might be to call QWidget::setBackgroundMode() for the widget. An example of highly unreasonable use would be setting the geometry! Reimplementing this function gives you a back-door through which you can change the appearance of a widget. With Qt 4.0's style engine you will rarely need to write your own polish(); instead reimplement drawItem(), drawPrimitive(), etc.

The QWidget::inherits() function may provide enough information to allow class-specific customizations. But be careful not to hard-code things too much because new QStyle subclasses are expected to work reasonably with all current and future widgets.

See also unpolish().

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

This is an overloaded member function, provided for convenience. It behaves essentially like the above function.

Late initialization of the QApplication object app.

See also unpolish().

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

This is an overloaded member function, provided for convenience. It behaves essentially like the above function.

The style may have certain requirements for color palettes. In this function it has the chance to change the palette pal according to these requirements.

See also QPalette and QApplication::setPalette().

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

Returns the size of styled object described in option based on the contents size contentsSize.

The option argument is a pointer to a QStyleOption or one of its subclasses. The option can be cast to the appropriate type based on the value of type. The widget widget is optional argument and can contain extra information used for calculating the size. See the table below for the appropriate option usage:

ContentsTypeOption Cast
CT_PushButtonQStyleOptionButton
CT_CheckBoxQStyleOptionButton
CT_RadioButtonQStyleOptionButton
CT_ToolButtonQStyleOptionToolButton
CT_ComboBoxQStyleOptionComboBox
CT_SplitterQStyleOption
CT_Q3DockWindowQStyleOptionQ3DockWindow
CT_ProgressBarQStyleOptionProgressBar
CT_MenuItemQStyleOptionMenuItem

See also ContentsType and QStyleOption.

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

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

This function can handle the entire integer range without overflow, providing 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 upsideDown to true to reverse this behavior.

See also sliderValueFromPosition().

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

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

This function can handle the entire integer range without overflow.

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

See also sliderPositionFromValue().

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

Returns an icon for standardIcon.

The option argument can be used to pass extra information required when determining the icon.

The widget argument is optional and may contain a widget that may aid determining the icon.

Warning: Because of binary compatibility constraints, this function is not virtual. If you want to provide your own icons in a QStyle subclass, add a slot called standardIconImplementation() to you subclass. The standardIcon() function will dynamically detect the slot and call it.

This function was introduced in Qt 4.1.

See also standardIconImplementation() and standardPixmap().

QIcon QStyle::standardIconImplementation ( StandardPixmap standardIcon, const QStyleOption * option = 0, const QWidget * widget = 0 ) const   [protected slot]

Returns an icon for standardIcon.

The option argument contains extra information required when determining the icon. The widget argument is optional and may contain a widget that may aid determining the icon.

The default implementation simply calls standardPixmap(standardIcon, option, widget).

Warning: Because of binary compatibility constraints, the standardIcon() function, introduced in Qt 4.1, isn't virtual. If you want to provide your own icons in a QStyle subclass, add a slot called standardIconImplementation() to your subclass. The standardIcon() function will dynamically detect the slot and call it.

This function was introduced in Qt 4.1.

See also standardIcon().

QPalette QStyle::standardPalette () const   [virtual]

Returns the style's standard palette. On systems that support system colors, the style's standard palette is not used.

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

Returns a pixmap for standardPixmap.

The option argument can be used to pass extra information required when drawing the ControlElement.

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

See also standardIcon().

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

Returns the style hint hint for widget described in the QStyleOption option. Currently returnData and widget are not used; they are provided for future enhancement. The option parameter is used only in SH_ComboBox_Popup, SH_ComboBox_LayoutDirection, and SH_GroupBox_TextLabelColor.

For an explanation of the return value, see StyleHint.

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

Returns the rectangle for the SubControl subControl in the ComplexControl control, with the style options specified by option in visual coordinates.

The option argument is a pointer to a QStyleOptionComplex or one of its subclasses. The structure can be cast to the appropriate type based on the value of control. See drawComplexControl() for details.

The widget is optional and can contain additional information for the function.

See also drawComplexControl(), ComplexControl, SubControl, and QStyleOptionComplex.

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

Returns the sub-area element as described in option in logical coordinates.

The widget argument is optional and may contain a widget that may aid determining the subRect.

The QStyleOption can be cast to the appropriate type based on the value of element. See the table below for the appropriate option casts:

SubElementOption Cast
SE_PushButtonContentsQStyleOptionButton
SE_PushButtonFocusRectQStyleOptionButton
SE_CheckBoxIndicatorQStyleOptionButton
SE_CheckBoxContentsQStyleOptionButton
SE_CheckBoxFocusRectQStyleOptionButton
SE_RadioButtonIndicatorQStyleOptionButton
SE_RadioButtonContentsQStyleOptionButton
SE_RadioButtonFocusRectQStyleOptionButton
SE_ComboBoxFocusRectQStyleOptionComboBox
SE_Q3DockWindowHandleRectQStyleOptionQ3DockWindow
SE_ProgressBarGrooveQStyleOptionProgressBar
SE_ProgressBarContentsQStyleOptionProgressBar
SE_ProgressBarLabelQStyleOptionProgressBar

See also SubElement and QStyleOption.

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

Undoes the initialization of widget widget's appearance.

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

See also polish().

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

This is an overloaded member function, provided for convenience. It behaves essentially like the above function.

Undoes the polish of application app.

See also polish().

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 aligment was specified, the function returns the default alignment for the layout direction.

QWidget::layoutDirection

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

Returns the point logicalPos converted to screen coordinates based on direction. The boundingRect rectangle is used to perform the translation.

See also QWidget::layoutDirection.

QRect QStyle::visualRect ( Qt::LayoutDirection direction, const QRect & boundingRect, const QRect & logicalRect )   [static]

Returns the rectangle logicalRect converted to screen coordinates based on direction. The boundingRect rectangle is used to perform the translation.

This function is provided to aid style implementors in supporting right-to-left desktops. It typically is used in subControlRect().

See also QWidget::layoutDirection.


Copyright © 2005 Trolltech Trademarks
Qt 4.1.0
Hosted by uCoz