QStyle Class Reference

Detailed Description

A large number of GUI elements are common to many widgets. The QStyle class allows the look of these elements to be modified across all widgets that use the QStyle functions. It also provides two feel options: Motif and Windows.

Although it is not possible to fully enumerate the look of graphical elements and the feel of widgets in a GUI, QStyle provides a considerable amount of control and customisability.

In Qt 1.x the look and feel option for widgets was specified by a single value: the GUIStyle. Starting with Qt 2.0, this notion was expanded to allow the look to be specified by virtual drawing functions.

Derived classes may reimplement some or all of the drawing functions to modify the look of all widgets that use those functions.

Languages written from right to left (such as Arabic and Hebrew) usually also mirror the whole layout of widgets. If you design a style, you should take special care when drawing asymmetric elements to make sure that they also look correct in a mirrored layout. You can start your application with -reverse to check the mirrored layout. Also notice, that for a reversed layout, the light usually comes from top right instead of top left.

The actual reverse layout is performed automatically when possible. However, for the sake of flexibility, the translation cannot be performed everywhere. The documentation for each function in the QStyle API states whether the function expects/returns logical or screen coordinates. Using logical coordinates (in ComplexControls, for example) provides great flexibility in controlling the look of a widget. Use visualRect() when necessary to translate logical coordinates into screen coordinates for drawing.

In Qt versions prior to 3.0, if you wanted a low level route into changing the appearance of a widget, you would reimplement polish(). With the new 3.0 style engine the recommended approach is to reimplement the draw functions, for example drawItem(), drawPrimitive(), drawControl(), drawControlMask(), drawComplexControl() and drawComplexControlMask(). Each of these functions is called with a range of parameters that provide information that you can use to determine how to draw them, e.g. style flags, rectangle, color group, etc.

For information on changing elements of an existing style or creating your own style see the Style overview.

Styles can also be created as plugins.

See also Widget Appearance and Style.

Member Type Documentation

QStyle::ComplexControl

This enum represents a ComplexControl. ComplexControls have different behaviour depending upon where the user clicks on them or which keys are pressed.

• QStyle::CC_SpinWidget
• QStyle::CC_ComboBox
• QStyle::CC_ScrollBar
• QStyle::CC_Slider
• QStyle::CC_ToolButton
• QStyle::CC_TitleBar
• QStyle::CC_ListView

• QStyle::CC_CustomBase - base value for custom ControlElements. All values above this are reserved for custom use. Therefore, custom values must be greater than this value.

See also SubControl and drawComplexControl().

QStyle::ContentsType

This enum represents a ContentsType. It is used to calculate sizes for the contents of various widgets.

• QStyle::CT_PushButton
• QStyle::CT_CheckBox
• QStyle::CT_RadioButton
• QStyle::CT_ToolButton
• QStyle::CT_ComboBox
• QStyle::CT_Splitter
• QStyle::CT_DockWindow
• QStyle::CT_ProgressBar
• QStyle::CT_PopupMenuItem
• QStyle::CT_TabBarTab
• QStyle::CT_Slider
• QStyle::CT_Header
• QStyle::CT_LineEdit
• QStyle::CT_MenuBar
• QStyle::CT_SpinBox
• QStyle::CT_SizeGrip
• QStyle::CT_TabWidget
• QStyle::CT_DialogButtons
• QStyle::CT_CustomBase - base value for custom ControlElements. All values above this are reserved for custom use. Custom values must be greater than this value.

See also sizeFromContents().

QStyle::ControlElement

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

• QStyle::CE_PushButton - the bevel and default indicator of a QPushButton.
• QStyle::CE_PushButtonLabel - the label (iconset with text or pixmap) of a QPushButton.
• QStyle::CE_CheckBox - the indicator of a QCheckBox.
• QStyle::CE_CheckBoxLabel - the label (text or pixmap) of a QCheckBox.
• QStyle::CE_RadioButton - the indicator of a QRadioButton.
• QStyle::CE_RadioButtonLabel - the label (text or pixmap) of a QRadioButton.
• QStyle::CE_TabBarTab - the tab within a QTabBar (a QTab).
• QStyle::CE_TabBarLabel - the label within a QTab.
• QStyle::CE_ProgressBarGroove - the groove where the progress indicator is drawn in a QProgressBar.
• QStyle::CE_ProgressBarContents - the progress indicator of a QProgressBar.
• QStyle::CE_ProgressBarLabel - the text label of a QProgressBar.
• QStyle::CE_PopupMenuItem - a menu item in a QPopupMenu.
• QStyle::CE_PopupMenuScroller - scrolling areas in a popumenu when the style supports scrolling.
• QStyle::CE_PopupMenuHorizontalExtra - extra frame area set aside with PM_PopupMenuFrameHorizontalExtra
• QStyle::CE_PopupMenuVerticalExtra - extra frame area set aside with PM_PopupMenuFrameVerticalExtra
• QStyle::CE_MenuBarItem - a menu item in a QMenuBar.
• QStyle::CE_ToolButtonLabel - a tool button's label.
• QStyle::CE_MenuBarEmptyArea - the empty area of a QMenuBar.
• QStyle::CE_DockWindowEmptyArea - the empty area of a QDockWindow.
• QStyle::CE_ToolBoxTab - the toolbox's tab area
• QStyle::CE_HeaderLabel - the header's label
• QStyle::CE_CustomBase - base value for custom ControlElements. All values above this are reserved for custom use. Therefore, custom values must be greater than this value.

See also drawControl().

QStyle::PixelMetric

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

• QStyle::PM_ButtonMargin - amount of whitespace between pushbutton labels and the frame.
• QStyle::PM_ButtonDefaultIndicator - width of the default-button indicator frame.
• QStyle::PM_MenuButtonIndicator - width of the menu button indicator proportional to the widget height.
• QStyle::PM_ButtonShiftHorizontal - horizontal contents shift of a button when the button is down.
• QStyle::PM_ButtonShiftVertical - vertical contents shift of a button when the button is down.
• QStyle::PM_DefaultFrameWidth - default frame width, usually 2.
• QStyle::PM_SpinBoxFrameWidth - frame width of a spin box.
• QStyle::PM_MDIFrameWidth - frame width of an MDI window.
• QStyle::PM_MDIMinimizedWidth - width of a minimized MSI window.
• QStyle::PM_MaximumDragDistance - Some feels require the scrollbar 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_ScrollBarExtent - width of a vertical scrollbar and the height of a horizontal scrollbar.
• QStyle::PM_ScrollBarSliderMin - the minimum height of a vertical scrollbar's slider and the minimum width of a horiztonal scrollbar slider.
• QStyle::PM_SliderThickness - total slider thickness.
• QStyle::PM_SliderControlThickness - thickness of the slider handle.
• QStyle::PM_SliderLength - length of the slider.
• QStyle::PM_SliderTickmarkOffset - the offset between the tickmarks and the slider.
• QStyle::PM_SliderSpaceAvailable - the available space for the slider to move.
• QStyle::PM_DockWindowSeparatorExtent - width of a separator in a horiztonal dock window and the height of a separator in a vertical dock window.
• QStyle::PM_DockWindowHandleExtent - width of the handle in a horizontal dock window and the height of the handle in a vertical dock window.
• QStyle::PM_DockWindowFrameWidth - frame width of a dock window.
• QStyle::PM_MenuBarFrameWidth - frame width of a menubar.
• QStyle::PM_MenuBarItemSpacing - spacing between menubar items.
• QStyle::PM_ToolBarItemSpacing - spacing between toolbar items.
• QStyle::PM_TabBarTabOverlap - number of pixels the tabs should overlap.
• QStyle::PM_TabBarTabHSpace - extra space added to the tab width.
• QStyle::PM_TabBarTabVSpace - extra space added to the tab height.
• QStyle::PM_TabBarBaseHeight - height of the area between the tab bar and the tab pages.
• QStyle::PM_TabBarBaseOverlap - number 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_ProgressBarChunkWidth - width of a chunk in a progress bar indicator.
• QStyle::PM_SplitterWidth - width of a splitter.
• QStyle::PM_TitleBarHeight - height of the title bar.
• QStyle::PM_PopupMenuFrameHorizontalExtra - additional border, e.g. for panels
• QStyle::PM_PopupMenuFrameVerticalExtra - additional border, e.g. for panels
• QStyle::PM_IndicatorWidth - width of a check box indicator.
• QStyle::PM_IndicatorHeight - height of a checkbox indicator.
• QStyle::PM_ExclusiveIndicatorWidth - width of a radio button indicator.
• QStyle::PM_ExclusiveIndicatorHeight - height of a radio button indicator.
• QStyle::PM_PopupMenuScrollerHeight - height of the scroller area in a popupmenu.
• QStyle::PM_PopupMenuScrollerHeight - height of the scroller area in a popupmenu.
• QStyle::PM_CheckListButtonSize - area (width/height) of the checkbox/radiobutton in a QCheckListItem
• QStyle::PM_CheckListControllerSize - area (width/height) of the controller in a QCheckListItem
• QStyle::PM_DialogButtonsSeparator - distance between buttons in a dialog buttons widget.
• QStyle::PM_DialogButtonsButtonWidth - minimum width of a button in a dialog buttons widget.
• QStyle::PM_DialogButtonsButtonHeight - minimum height of a button in a dialog buttons widget.
• QStyle::PM_HeaderMarkSize
• QStyle::PM_HeaderGripMargin
• QStyle::PM_HeaderMargin
• QStyle::PM_CustomBase - base value for custom ControlElements. All values above this are reserved for custom use. Therefore, custom values must be greater than this value.

See also pixelMetric().

QStyle::PrimitiveElement

This enum represents the PrimitiveElements of a style. A PrimitiveElement is a common GUI element, such as a checkbox indicator or pushbutton bevel.

• QStyle::PE_ButtonCommand - button used to initiate an action, for example, a QPushButton.
• QStyle::PE_ButtonDefault - this button is the default button, e.g. in a dialog.
• QStyle::PE_ButtonBevel - generic button bevel.
• QStyle::PE_ButtonTool - tool button, for example, a QToolButton.
• QStyle::PE_ButtonDropDown - drop down button, for example, a tool button that displays a popup menu, for example, QPopupMenu.

• QStyle::PE_FocusRect - generic focus indicator.

• QStyle::PE_ArrowUp - up arrow.
• QStyle::PE_ArrowDown - down arrow.
• QStyle::PE_ArrowRight - right arrow.
• QStyle::PE_ArrowLeft - left arrow.

• QStyle::PE_SpinWidgetUp - up symbol for a spin widget, for example a QSpinBox.
• QStyle::PE_SpinWidgetDown - down symbol for a spin widget.
• QStyle::PE_SpinWidgetPlus - increase symbol for a spin widget.
• QStyle::PE_SpinWidgetMinus - decrease symbol for a spin widget.

• QStyle::PE_Indicator - on/off indicator, for example, a QCheckBox.
• QStyle::PE_IndicatorMask - bitmap mask for an indicator.
• QStyle::PE_ExclusiveIndicator - exclusive on/off indicator, for example, a QRadioButton.
• QStyle::PE_ExclusiveIndicatorMask - bitmap mask for an exclusive indicator.

• QStyle::PE_DockWindowHandle - tear off handle for dock windows and toolbars, for example QDockWindows and QToolBars.
• QStyle::PE_DockWindowSeparator - item separator for dock window and toolbar contents.
• QStyle::PE_DockWindowResizeHandle - resize handle for dock windows.
• QStyle::PE_Splitter - splitter handle; see also QSplitter.

• QStyle::PE_Panel - generic panel frame; see also QFrame.
• QStyle::PE_PanelPopup - panel frame for popup windows/menus; see also QPopupMenu.
• QStyle::PE_PanelMenuBar - panel frame for menu bars.
• QStyle::PE_PanelDockWindow - panel frame for dock windows and toolbars.
• QStyle::PE_PanelTabWidget - panel frame for tab widgets.
• QStyle::PE_PanelLineEdit - panel frame for line edits.
• QStyle::PE_PanelGroupBox - panel frame for group boxes.
• QStyle::PE_TabBarBase - area below tabs in a tab widget, for example, QTab.

• QStyle::PE_HeaderSection - section of a list or table header; see also QHeader.
• QStyle::PE_HeaderArrow - arrow used to indicate sorting on a list or table header
• QStyle::PE_StatusBarSection - section of a status bar; see also QStatusBar.

• QStyle::PE_GroupBoxFrame - frame around a group box; see also QGroupBox.
• QStyle::PE_WindowFrame - frame around a MDI window or a docking window

• QStyle::PE_Separator - generic separator.

• QStyle::PE_SizeGrip - window resize handle; see also QSizeGrip.

• QStyle::PE_CheckMark - generic check mark; see also QCheckBox.

• QStyle::PE_ScrollBarAddLine - scrollbar line increase indicator (i.e. scroll down); see also QScrollBar.
• QStyle::PE_ScrollBarSubLine - scrollbar line decrease indicator (i.e. scroll up).
• QStyle::PE_ScrollBarAddPage - scolllbar page increase indicator (i.e. page down).
• QStyle::PE_ScrollBarSubPage - scrollbar page decrease indicator (i.e. page up).
• QStyle::PE_ScrollBarSlider - scrollbar slider
• QStyle::PE_ScrollBarFirst - scrollbar first line indicator (i.e. home).
• QStyle::PE_ScrollBarLast - scrollbar last line indicator (i.e. end).

• QStyle::PE_ProgressBarChunk - section of a progress bar indicator; see also QProgressBar.
• QStyle::PE_CheckListController - controller part of a listview item
• QStyle::PE_CheckListIndicator - checkbox part of a listview item
• QStyle::PE_CheckListExclusiveIndicator - radiobutton part of a listview item
• QStyle::PE_RubberBand - rubber band used in such things as iconview
• QStyle::PE_CustomBase - base value for custom PrimitiveElements. All values above this are reserved for custom use. Custom values must be greater than this value.

See also drawPrimitive().

QStyle::StyleFlags

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. For an explanation of the relationship between primitives and their flags, as well as the different meanings of the flags, see the Style overview.

• QStyle::Style_Default
• QStyle::Style_Enabled
• QStyle::Style_Raised
• QStyle::Style_Sunken
• QStyle::Style_Off
• QStyle::Style_NoChange
• QStyle::Style_On
• QStyle::Style_Down
• QStyle::Style_Horizontal
• QStyle::Style_HasFocus
• QStyle::Style_Top
• QStyle::Style_Bottom
• QStyle::Style_FocusAtBorder
• QStyle::Style_AutoRaise
• QStyle::Style_MouseOver
• QStyle::Style_Up
• QStyle::Style_Selected
• QStyle::Style_HasFocus
• QStyle::Style_Active
• QStyle::Style_ButtonDefault

See also drawPrimitive().

QStyle::StyleHint

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

• QStyle::SH_EtchDisabledText - disabled text is "etched" like Windows.
• QStyle::SH_GUIStyle - the GUI style to use.
• QStyle::SH_ScrollBar_BackgroundMode - the background mode for a QScrollBar. Possible values are any of those in the BackgroundMode enum.
• QStyle::SH_ScrollBar_MiddleClickAbsolutePosition - a boolean value. If TRUE, middle clicking on a scrollbar causes the slider to jump to that position. If FALSE, the middle clicking is ignored.
• QStyle::SH_ScrollBar_LeftClickAbsolutePosition - a boolean value. If TRUE, left clicking on a scrollbar causes the slider to jump to that position. If FALSE, the left clicking will behave as appropriate for each control.
• QStyle::SH_ScrollBar_ScrollWhenPointerLeavesControl - a boolean value. If TRUE, when clicking a scrollbar SubControl, holding the mouse button down and moving the pointer outside the SubControl, the scrollbar continues to scroll. If FALSE, the scollbar stops scrolling when the pointer leaves the SubControl.
• QStyle::SH_TabBar_Alignment - the alignment for tabs in a QTabWidget. Possible values are Qt::AlignLeft, Qt::AlignCenter and Qt::AlignRight.
• QStyle::SH_Header_ArrowAlignment - the placement of the sorting indicator may appear in list or table headers. Possible values are Qt::Left or Qt::Right.
• QStyle::SH_Slider_SnapToValue - sliders snap to values while moving, like Windows
• QStyle::SH_Slider_SloppyKeyEvents - key presses handled in a sloppy manner, i.e. left on a vertical slider subtracts a line.
• QStyle::SH_ProgressDialog_CenterCancelButton - center button on progress dialogs, like Motif, otherwise right aligned.
• QStyle::SH_ProgressDialog_TextLabelAlignment - Qt::AlignmentFlags -- text label alignment in progress dialogs; Center on windows, Auto|VCenter otherwise.
• QStyle::SH_PrintDialog_RightAlignButtons - right align buttons in the print dialog, like Windows.
• QStyle::SH_MainWindow_SpaceBelowMenuBar - 1 or 2 pixel space between the menubar and the dockarea, like Windows.
• QStyle::SH_FontDialog_SelectAssociatedText - select the text in the line edit, or when selecting an item from the listbox, or when the line edit receives focus, like Windows.
• QStyle::SH_PopupMenu_AllowActiveAndDisabled - allows disabled menu items to be active.
• QStyle::SH_PopupMenu_SpaceActivatesItem - pressing Space activates the item, like Motif.
• QStyle::SH_PopupMenu_SubMenuPopupDelay - the number of milliseconds to wait before opening a submenu; 256 on windows, 96 on Motif.
• QStyle::SH_PopupMenu_Scrollable - whether popupmenu's must support scrolling.
• QStyle::SH_PopupMenu_SloppySubMenus - whether popupmenu's must support sloppy submenu; as implemented on Mac OS.
• QStyle::SH_ScrollView_FrameOnlyAroundContents - whether scrollviews draw their frame only around contents (like Motif), or around contents, scrollbars and corner widgets (like Windows).
• QStyle::SH_MenuBar_AltKeyNavigation - menubars items are navigable by pressing Alt, followed by using the arrow keys to select the desired item.
• QStyle::SH_ComboBox_ListMouseTracking - mouse tracking in combobox dropdown lists.
• QStyle::SH_PopupMenu_MouseTracking - mouse tracking in popup menus.
• QStyle::SH_MenuBar_MouseTracking - mouse tracking in menubars.
• QStyle::SH_ItemView_ChangeHighlightOnFocus - gray out selected items when losing focus.
• QStyle::SH_Widget_ShareActivation - turn on sharing activation with floating modeless dialogs.
• QStyle::SH_TabBar_SelectMouseType - which type of mouse event should cause a tab to be selected.
• QStyle::SH_ListViewExpand_SelectMouseType - which type of mouse event should cause a listview expansion to be selected.
• QStyle::SH_TabBar_PreferNoArrows - whether a tabbar should suggest a size to prevent scoll arrows.
• QStyle::SH_ComboBox_Popup - allows popups as a combobox dropdown menu.
• QStyle::SH_Workspace_FillSpaceOnMaximize - the workspace should maximize the client area.
• QStyle::SH_TitleBar_NoBorder - the titlebar has no border
• QStyle::SH_ScrollBar_StopMouseOverSlider - stops autorepeat when slider reaches mouse
• QStyle::SH_BlinkCursorWhenTextSelected - whether cursor should blink when text is selected
• QStyle::SH_RichText_FullWidthSelection - whether richtext selections should extend the full width of the document.
• QStyle::SH_GroupBox_TextLabelVerticalAlignment - how to vertically align a groupbox's text label.
• QStyle::SH_GroupBox_TextLabelColor - how to paint a groupbox's text label.
• QStyle::SH_DialogButtons_DefaultButton - which buttons gets the default status in a dialog's button widget.
• QStyle::SH_CustomBase - base value for custom ControlElements. All values above this are reserved for custom use. Therefore, custom values must be greater than this value.
• QStyle::SH_ToolButton_Uses3D - indicates whether QToolButtons should use a 3D frame when the mouse is over them
• QStyle::SH_ToolBox_SelectedPageTitleBold - Boldness of the selected page title in a QToolBox.
• QStyle::SH_LineEdit_PasswordCharacter - The QChar Unicode character to be used for passwords.
• QStyle::SH_Table_GridLineColor
• QStyle::SH_UnderlineAccelerator - whether accelerators are underlined

See also styleHint().

QStyle::StylePixmap

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

• QStyle::SP_TitleBarMinButton - minimize button on titlebars. For example, in a QWorkspace.
• QStyle::SP_TitleBarMaxButton - maximize button on titlebars.
• QStyle::SP_TitleBarCloseButton - close button on titlebars.
• QStyle::SP_TitleBarNormalButton - normal (restore) button on titlebars.
• QStyle::SP_TitleBarShadeButton - shade button on titlebars.
• QStyle::SP_TitleBarUnshadeButton - unshade button on titlebars.
• QStyle::SP_MessageBoxInformation - the 'information' icon.
• QStyle::SP_MessageBoxWarning - the 'warning' icon.
• QStyle::SP_MessageBoxCritical - the 'critical' icon.
• QStyle::SP_MessageBoxQuestion - the 'question' icon.

• QStyle::SP_DockWindowCloseButton - close button on dock windows; see also QDockWindow.

• QStyle::SP_CustomBase - base value for custom ControlElements. All values above this are reserved for custom use. Therefore, custom values must be greater than this value.

See also stylePixmap().

QStyle::SubControl

This enum represents a SubControl within a ComplexControl.

• QStyle::SC_None - special value that matches no other SubControl.

• QStyle::SC_ScrollBarAddLine - scrollbar add line (i.e. down/right arrow); see also QScrollbar.
• QStyle::SC_ScrollBarSubLine - scrollbar sub line (i.e. up/left arrow).
• QStyle::SC_ScrollBarAddPage - scrollbar add page (i.e. page down).
• QStyle::SC_ScrollBarSubPage - scrollbar sub page (i.e. page up).
• QStyle::SC_ScrollBarFirst - scrollbar first line (i.e. home).
• QStyle::SC_ScrollBarLast - scrollbar last line (i.e. end).
• QStyle::SC_ScrollBarSlider - scrollbar slider handle.
• QStyle::SC_ScrollBarGroove - special subcontrol which contains the area in which the slider handle may move.

• QStyle::SC_SpinWidgetUp - spinwidget up/increase; see also QSpinBox.
• QStyle::SC_SpinWidgetDown - spinwidget down/decrease.
• QStyle::SC_SpinWidgetFrame - spinwidget frame.
• QStyle::SC_SpinWidgetEditField - spinwidget edit field.
• QStyle::SC_SpinWidgetButtonField - spinwidget button field.

• QStyle::SC_ComboBoxEditField - combobox edit field; see also QComboBox.
• QStyle::SC_ComboBoxArrow - combobox arrow
• QStyle::SC_ComboBoxFrame - combobox frame
• QStyle::SC_ComboBoxListBoxPopup - combobox list box
• QStyle::SC_SliderGroove - special subcontrol which contains the area in which the slider handle may move.
• QStyle::SC_SliderHandle - slider handle.
• QStyle::SC_SliderTickmarks - slider tickmarks.

• QStyle::SC_ToolButton - tool button; see also QToolbutton.
• QStyle::SC_ToolButtonMenu - subcontrol for opening a popup menu in a tool button; see also QPopupMenu.

• QStyle::SC_TitleBarSysMenu - system menu button (i.e. restore, close, etc.).
• QStyle::SC_TitleBarMinButton - minimize button.
• QStyle::SC_TitleBarMaxButton - maximize button.
• QStyle::SC_TitleBarCloseButton - close button.
• QStyle::SC_TitleBarLabel - window title label.
• QStyle::SC_TitleBarNormalButton - normal (restore) button.
• QStyle::SC_TitleBarShadeButton - shade button.
• QStyle::SC_TitleBarUnshadeButton - unshade button.

• QStyle::SC_ListView - the list view area.
• QStyle::SC_ListViewBranch - (internal)
• QStyle::SC_ListViewExpand - expand item (i.e. show/hide child items).

• QStyle::SC_All - special value that matches all SubControls.

See also ComplexControl.

QStyle::SubRect

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

• QStyle::SR_PushButtonContents - area containing the label (iconset with text or pixmap).
• QStyle::SR_PushButtonFocusRect - area for the focus rect (usually larger than the contents rect).
• QStyle::SR_CheckBoxIndicator - area for the state indicator (e.g. check mark).
• QStyle::SR_CheckBoxContents - area for the label (text or pixmap).
• QStyle::SR_CheckBoxFocusRect - area for the focus indicator.

• QStyle::SR_RadioButtonIndicator - area for the state indicator.
• QStyle::SR_RadioButtonContents - area for the label.
• QStyle::SR_RadioButtonFocusRect - area for the focus indicator.

• QStyle::SR_ComboBoxFocusRect - area for the focus indicator.

• QStyle::SR_SliderFocusRect - area for the focus indicator.

• QStyle::SR_DockWindowHandleRect - area for the tear-off handle.

• QStyle::SR_ProgressBarGroove - area for the groove.
• QStyle::SR_ProgressBarContents - area for the progress indicator.
• QStyle::SR_ProgressBarLabel - area for the text label.

• QStyle::SR_ToolButtonContents - area for the tool button's label.
• QStyle::SR_DialogButtonAccept - area for a dialog's accept button.
• QStyle::SR_DialogButtonReject - area for a dialog's reject button.
• QStyle::SR_DialogButtonApply - area for a dialog's apply button.
• QStyle::SR_DialogButtonHelp - area for a dialog's help button.
• QStyle::SR_DialogButtonAll - area for a dialog's all button.
• QStyle::SR_DialogButtonRetry - area for a dialog's retry button.
• QStyle::SR_DialogButtonAbort - area for a dialog's abort button.
• QStyle::SR_DialogButtonIgnore - area for a dialog's ignore button.
• QStyle::SR_DialogButtonCustom - area for a dialog's custom widget area (in button row).
• QStyle::SR_ToolBoxTabContents - area for a toolbox tab's icon and label
• QStyle::SR_CustomBase - base value for custom ControlElements. All values above this are reserved for custom use. Therefore, custom values must be greater than this value.

See also subRect().

Member Function Documentation

QStyle::QStyle ()

QStyle::~QStyle () [virtual]

int QStyle::defaultFrameWidth () const

void QStyle::drawComplexControl ( ComplexControl control, QPainter * p, const QWidget * widget, const QRect & r, const QColorGroup & cg, SFlags how = Style_Default, SCFlags sub = SC_All, SCFlags subActive = SC_None, const QStyleOption & opt = QStyleOption::Default ) const [pure virtual]

Draws the ComplexControl control using the painter p in the area r. Colors are used from the color group cg. The sub argument specifies which SubControls to draw. Multiple SubControls can be OR'ed together. The subActive argument specifies which SubControl is active.

The rect r should be in logical coordinates. Reimplementations of this function should use visualRect() to change the logical coordinates into screen coordinates when using drawPrimitive() and drawControl().

The how argument is used to control how the ComplexControl is drawn. Multiple flags can OR'ed together. See the table below for an explanation of which flags are used with the various ComplexControls.

The widget argument is a pointer to a QWidget or one of its subclasses. The widget can be cast to the appropriate type based on the value of control. The opt argument can be used to pass extra information required when drawing the ComplexControl. Note that opt may be the default value even for ComplexControls that can make use of the extra options. See the table below for the appropriate widget and opt usage:

See also ComplexControl and SubControl.

void QStyle::drawComplexControlMask ( ComplexControl control, QPainter * p, const QWidget * widget, const QRect & r, const QStyleOption & opt = QStyleOption::Default ) const [pure virtual]

Draw a bitmask for the ComplexControl control using the painter p in the area r. See drawComplexControl() for an explanation of the use of the widget and opt arguments.

The rect r should be in logical coordinates. Reimplementations of this function should use visualRect() to change the logical corrdinates into screen coordinates when using drawPrimitive() and drawControl().

See also drawComplexControl() and ComplexControl.

void QStyle::drawControl ( ControlElement element, QPainter * p, const QWidget * widget, const QRect & r, const QColorGroup & cg, SFlags how = Style_Default, const QStyleOption & opt = QStyleOption::Default ) const [pure virtual]

Draws the ControlElement element using the painter p in the area r. Colors are used from the color group cg.

The rect r should be in screen coordinates.

The how argument is used to control how the ControlElement is drawn. Multiple flags can be OR'ed together. See the table below for an explanation of which flags are used with the various ControlElements.

The widget argument is a pointer to a QWidget or one of its subclasses. The widget can be cast to the appropriate type based on the value of element. The opt argument can be used to pass extra information required when drawing the ControlElement. Note that opt may be the default value even for ControlElements that can make use of the extra options. See the table below for the appropriate widget and opt usage:

See also ControlElement and StyleFlags.

void QStyle::drawControlMask ( ControlElement element, QPainter * p, const QWidget * widget, const QRect & r, const QStyleOption & opt = QStyleOption::Default ) const [pure virtual]

Draw a bitmask for the ControlElement element using the painter p in the area r. See drawControl() for an explanation of the use of the widget and opt arguments.

The rect r should be in screen coordinates.

See also drawControl() and ControlElement.

void QStyle::drawItem ( QPainter * p, const QRect & r, int flags, const QColorGroup & g, bool enabled, const QPixmap * pixmap, const QString & text, int len = -1, const QColor * penColor = 0 ) const [virtual]

By default, if both the text and the pixmap are not null, the pixmap is drawn and the text is ignored.

void QStyle::drawPrimitive ( PrimitiveElement pe, QPainter * p, const QRect & r, const QColorGroup & cg, SFlags flags = Style_Default, const QStyleOption & opt = QStyleOption::Default ) const [pure virtual]

Draws the style PrimitiveElement pe using the painter p in the area r. Colors are used from the color group cg.

The rect r should be in screen coordinates.

The flags argument is used to control how the PrimitiveElement is drawn. Multiple flags can be OR'ed together.

For example, a pressed button would be drawn with the flags Style_Enabled and Style_Down.

The opt argument can be used to control how various PrimitiveElements are drawn. Note that opt may be the default value even for PrimitiveElements that make use of extra options. When opt is non-default, it is used as follows:

For all other PrimitiveElements, opt is unused.

See also StyleFlags.

Example: themes/wood.cpp.

QRect QStyle::itemRect ( QPainter * p, const QRect & r, int flags, bool enabled, const QPixmap * pixmap, const QString & text, int len = -1 ) const [virtual]

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

By default, if both the text and the pixmap are not null, the pixmap is drawn and the text is ignored.

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

Returns the pixel metric for metric. The widget argument is a pointer to a QWidget or one of its subclasses. The widget can be cast to the appropriate type based on the value of metric. Note that widget may be zero even for PixelMetrics that can make use of widget. See the table below for the appropriate widget casts:

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

This function is called for every widget at some point after it has been fully created but just before it is shown 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 3.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 * ) [virtual]

See also unPolish().

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

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

See also QPalette and QApplication::setPalette().

void QStyle::polishPopupMenu ( QPopupMenu * ) [pure virtual]

SubControl QStyle::querySubControl ( ComplexControl control, const QWidget * widget, const QPoint & pos, const QStyleOption & opt = QStyleOption::Default ) const [pure virtual]

Returns the SubControl for widget at the point pos. The widget argument is a pointer to a QWidget or one of its subclasses. The widget can be cast to the appropriate type based on the value of control. The opt argument can be used to pass extra information required when drawing the ComplexControl. Note that opt may be the default value even for ComplexControls that can make use of the extra options. See drawComplexControl() for an explanation of the widget and opt arguments.

Note that pos is passed in screen coordinates. When using querySubControlMetrics() to check for hits and misses, use visualRect() to change the logical coordinates into screen coordinates.

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

QRect QStyle::querySubControlMetrics ( ComplexControl control, const QWidget * widget, SubControl subcontrol, const QStyleOption & opt = QStyleOption::Default ) const [pure virtual]

Returns the rect for the SubControl subcontrol for widget in logical coordinates.

The widget argument is a pointer to a QWidget or one of its subclasses. The widget can be cast to the appropriate type based on the value of control. The opt argument can be used to pass extra information required when drawing the ComplexControl. Note that opt may be the default value even for ComplexControls that can make use of the extra options. See drawComplexControl() for an explanation of the widget and opt arguments.

See also drawComplexControl(), ComplexControl, and SubControl.

QSize QStyle::scrollBarExtent () const

QSize QStyle::sizeFromContents ( ContentsType contents, const QWidget * widget, const QSize & contentsSize, const QStyleOption & opt = QStyleOption::Default ) const [pure virtual]

Returns the size of widget based on the contents size contentsSize.

The widget argument is a pointer to a QWidget or one of its subclasses. The widget can be cast to the appropriate type based on the value of contents. The opt argument can be used to pass extra information required when calculating the size. Note that opt may be the default value even for ContentsTypes that can make use of the extra options. See the table below for the appropriate widget and opt usage:

int QStyle::styleHint ( StyleHint stylehint, const QWidget * widget = 0, const QStyleOption & opt = QStyleOption::Default, QStyleHintReturn * returnData = 0 ) const [pure virtual]

Returns the style hint stylehint for widget. Currently, widget, opt, and returnData are unused; they're included to allow for future enhancements.

For an explanation of the return value see StyleHint.

QPixmap QStyle::stylePixmap ( StylePixmap stylepixmap, const QWidget * widget = 0, const QStyleOption & opt = QStyleOption::Default ) const [pure virtual]

Returns a pixmap for stylepixmap.

The opt argument can be used to pass extra information required when drawing the ControlElement. Note that opt may be the default value even for StylePixmaps that can make use of the extra options. Currently, the opt argument is unused.

The widget argument is a pointer to a QWidget or one of its subclasses. The widget can be cast to the appropriate type based on the value of stylepixmap. See the table below for the appropriate widget casts:

See also StylePixmap.

QRect QStyle::subRect ( SubRect subrect, const QWidget * widget ) const [pure virtual]

Returns the sub-area subrect for the widget in logical coordinates.

The widget argument is a pointer to a QWidget or one of its subclasses. The widget can be cast to the appropriate type based on the value of subrect. See the table below for the appropriate widget casts:

The tear-off handle (SR_DockWindowHandleRect) for QDockWindow is a private class. Use QWidget::parentWidget() to access the QDockWindow:

        if ( !widget->parentWidget() )
            return;
        const QDockWindow *dw = (const QDockWindow *) widget->parentWidget();
    

See also SubRect.

void QStyle::tabbarMetrics ( const QWidget * t, int & hf, int & vf, int & ov ) const

void QStyle::unPolish ( QWidget * ) [virtual]

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 * ) [virtual]

Undoes the application polish.

See also polish().

QRect QStyle::visualRect ( const QRect & logical, const QWidget * w ) [static]

Returns the rect logical in screen coordinates. The bounding rect for widget w is used to perform the translation. This function is provided to aid style implementors in supporting right-to-left mode.

See also QApplication::reverseLayout().

QRect QStyle::visualRect ( const QRect & logical, const QRect & bounding ) [static]

Returns the rect logical in screen coordinates. The rect bounding is used to perform the translation. This function is provided to aid style implementors in supporting right-to-left mode.

See also QApplication::reverseLayout().

This file is part of the Qt toolkit. Copyright © 1995-2005 Trolltech. All Rights Reserved.