Qt 4.8
Public Types | Public Functions | Public Variables | Protected Functions | List of all members
QStyleOptionToolButton Class Reference

The QStyleOptionToolButton class is used to describe the parameters for drawing a tool button. More...

#include <qstyleoption.h>

Inheritance diagram for QStyleOptionToolButton:
QStyleOptionComplex QStyleOption

Public Types

enum  StyleOptionType { Type = SO_ToolButton }
 This enum is used to hold information about the type of the style option, and is defined for each QStyleOption subclass. More...
 
enum  StyleOptionVersion { Version = 1 }
 This enum is used to hold information about the version of the style option, and is defined for each QStyleOption subclass. More...
 
enum  ToolButtonFeature {
  None = 0x00, Arrow = 0x01, Menu = 0x04, MenuButtonPopup = Menu,
  PopupDelay = 0x08, HasMenu = 0x10
}
 Describes the various features that a tool button can have. More...
 
- Public Types inherited from QStyleOptionComplex
enum  StyleOptionType { Type = SO_Complex }
 This enum is used to hold information about the type of the style option, and is defined for each QStyleOption subclass. More...
 
enum  StyleOptionVersion { Version = 1 }
 This enum is used to hold information about the version of the style option, and is defined for each QStyleOption subclass. More...
 
- Public Types inherited from QStyleOption
enum  OptionType {
  SO_Default, SO_FocusRect, SO_Button, SO_Tab,
  SO_MenuItem, SO_Frame, SO_ProgressBar, SO_ToolBox,
  SO_Header, SO_Q3DockWindow, SO_DockWidget, SO_Q3ListViewItem,
  SO_ViewItem, SO_TabWidgetFrame, SO_TabBarBase, SO_RubberBand,
  SO_ToolBar, SO_GraphicsItem, SO_Complex = 0xf0000, SO_Slider,
  SO_SpinBox, SO_ToolButton, SO_ComboBox, SO_Q3ListView,
  SO_TitleBar, SO_GroupBox, SO_SizeGrip, SO_CustomBase = 0xf00,
  SO_ComplexCustomBase = 0xf000000
}
 This enum is used internally by QStyleOption, its subclasses, and qstyleoption_cast() to determine the type of style option. More...
 
enum  StyleOptionType { Type = SO_Default }
 This enum is used to hold information about the type of the style option, and is defined for each QStyleOption subclass. More...
 
enum  StyleOptionVersion { Version = 1 }
 This enum is used to hold information about the version of the style option, and is defined for each QStyleOption subclass. More...
 

Public Functions

 QStyleOptionToolButton ()
 Constructs a QStyleOptionToolButton, initializing the members variables to their default values. More...
 
 QStyleOptionToolButton (const QStyleOptionToolButton &other)
 Constructs a copy of the other style option. More...
 
- Public Functions inherited from QStyleOptionComplex
 QStyleOptionComplex (int version=QStyleOptionComplex::Version, int type=SO_Complex)
 Constructs a QStyleOptionComplex of the specified type and version, initializing the member variables to their default values. More...
 
 QStyleOptionComplex (const QStyleOptionComplex &other)
 Constructs a copy of the other style option. More...
 
- Public Functions inherited from QStyleOption
void init (const QWidget *w)
 Use initFrom(widget) instead. More...
 
void initFrom (const QWidget *w)
 
QStyleOptionoperator= (const QStyleOption &other)
 Assign other to this QStyleOption. More...
 
 QStyleOption (int version=QStyleOption::Version, int type=SO_Default)
 Constructs a QStyleOption with the specified version and type. More...
 
 QStyleOption (const QStyleOption &other)
 Constructs a copy of other. More...
 
 ~QStyleOption ()
 Destroys this style option object. More...
 

Public Variables

Qt::ArrowType arrowType
 the direction of the arrow for the tool button More...
 
ToolButtonFeatures features
 an OR combination of the tool button's features More...
 
QFont font
 the font that is used for the text More...
 
QIcon icon
 the icon for the tool button More...
 
QSize iconSize
 the size of the icon for the tool button More...
 
QPoint pos
 the position of the tool button More...
 
QString text
 the text of the tool button More...
 
Qt::ToolButtonStyle toolButtonStyle
 a Qt::ToolButtonStyle value describing the appearance of the tool button More...
 
- Public Variables inherited from QStyleOptionComplex
QStyle::SubControls activeSubControls
 This variable holds a bitwise OR of the sub-controls that are active for the complex control. More...
 
QStyle::SubControls subControls
 This variable holds a bitwise OR of the sub-controls to be drawn for the complex control. More...
 
- Public Variables inherited from QStyleOption
Qt::LayoutDirection direction
 the text layout direction that should be used when drawing text in the control More...
 
QFontMetrics fontMetrics
 the font metrics that should be used when drawing text in the control More...
 
QPalette palette
 the palette that should be used when painting the control More...
 
QRect rect
 the area that should be used for various calculations and painting More...
 
QStyle::State state
 the style flags that are used when drawing the control More...
 
int type
 the option type of the style option More...
 
int version
 the version of the style option More...
 

Protected Functions

 QStyleOptionToolButton (int version)
 

Additional Inherited Members

Detailed Description

The QStyleOptionToolButton class is used to describe the parameters for drawing a tool button.

QStyleOptionToolButton contains all the information that QStyle functions need to draw QToolButton.

For performance reasons, the access to the member variables is direct (i.e., using the . or -> operator). This low-level feel makes the structures straightforward to use and emphasizes that these are simply parameters used by the style functions.

For an example demonstrating how style options can be used, see the widgets/styles{Styles} example.

See also
QStyleOption, QStyleOptionComplex, QStyleOptionButton

Definition at line 768 of file qstyleoption.h.

Enumerations

◆ StyleOptionType

This enum is used to hold information about the type of the style option, and is defined for each QStyleOption subclass.

  • Type The type of style option provided (SO_ToolButton for this class).

The type is used internally by QStyleOption, its subclasses, and qstyleoption_cast() to determine the type of style option. In general you do not need to worry about this unless you want to create your own QStyleOption subclass and your own styles.

See also
StyleOptionVersion
Enumerator
Type 

Definition at line 771 of file qstyleoption.h.

◆ StyleOptionVersion

This enum is used to hold information about the version of the style option, and is defined for each QStyleOption subclass.

  • Version 1

The version is used by QStyleOption subclasses to implement extensions without breaking compatibility. If you use qstyleoption_cast(), you normally do not need to check it.

See also
StyleOptionType
Enumerator
Version 

Definition at line 772 of file qstyleoption.h.

◆ ToolButtonFeature

Describes the various features that a tool button can have.

  • None A normal tool button.
  • Arrow The tool button is an arrow.
  • Menu The tool button has a menu.
  • PopupDelay There is a delay to showing the menu.
  • HasMenu The button has a popup menu.
  • MenuButtonPopup The button should display an arrow to indicate that a menu is present.
See also
features, QToolButton::toolButtonStyle(), QToolButton::popupMode()
Enumerator
None 
Arrow 
Menu 
MenuButtonPopup 
PopupDelay 
HasMenu 

Definition at line 774 of file qstyleoption.h.

Constructors and Destructors

◆ QStyleOptionToolButton() [1/3]

QStyleOptionToolButton::QStyleOptionToolButton ( )

Constructs a QStyleOptionToolButton, initializing the members variables to their default values.

Definition at line 4336 of file qstyleoption.cpp.

4339 {
4340 }
Qt::ArrowType arrowType
the direction of the arrow for the tool button
Definition: qstyleoption.h:782
Qt::ToolButtonStyle toolButtonStyle
a Qt::ToolButtonStyle value describing the appearance of the tool button
Definition: qstyleoption.h:783
ToolButtonFeatures features
an OR combination of the tool button&#39;s features
Definition: qstyleoption.h:778
QStyleOptionComplex(int version=QStyleOptionComplex::Version, int type=SO_Complex)
Constructs a QStyleOptionComplex of the specified type and version, initializing the member variables...

◆ QStyleOptionToolButton() [2/3]

QStyleOptionToolButton::QStyleOptionToolButton ( const QStyleOptionToolButton other)
inline

Constructs a copy of the other style option.

Definition at line 788 of file qstyleoption.h.

788 : QStyleOptionComplex(Version, Type) { *this = other; }
QStyleOptionComplex(int version=QStyleOptionComplex::Version, int type=SO_Complex)
Constructs a QStyleOptionComplex of the specified type and version, initializing the member variables...

◆ QStyleOptionToolButton() [3/3]

QStyleOptionToolButton::QStyleOptionToolButton ( int  version)
protected
Warning
This function is not part of the public interface.

Definition at line 4345 of file qstyleoption.cpp.

4348 
4349 {
4350 }
int version
the version of the style option
Definition: qstyleoption.h:86
Qt::ArrowType arrowType
the direction of the arrow for the tool button
Definition: qstyleoption.h:782
Qt::ToolButtonStyle toolButtonStyle
a Qt::ToolButtonStyle value describing the appearance of the tool button
Definition: qstyleoption.h:783
ToolButtonFeatures features
an OR combination of the tool button&#39;s features
Definition: qstyleoption.h:778
QStyleOptionComplex(int version=QStyleOptionComplex::Version, int type=SO_Complex)
Constructs a QStyleOptionComplex of the specified type and version, initializing the member variables...

Properties

◆ arrowType

QStyleOptionToolButton::arrowType

the direction of the arrow for the tool button

This value is only used if features includes Arrow . The default value is Qt::DownArrow.

Definition at line 782 of file qstyleoption.h.

Referenced by drawArrow(), QToolButton::initStyleOption(), and QDockWidgetTitleButton::paintEvent().

◆ features

QStyleOptionToolButton::features

an OR combination of the tool button's features

The default value is None .

See also
ToolButtonFeature

Definition at line 778 of file qstyleoption.h.

Referenced by QStyleSheetStyle::drawComplexControl(), QToolButton::initStyleOption(), QToolBarExtension::paintEvent(), QMenuBarExtension::paintEvent(), and QDockWidgetTitleButton::paintEvent().

◆ font

QStyleOptionToolButton::font

the font that is used for the text

This value is only used if toolButtonStyle is Qt::ToolButtonTextUnderIcon, Qt::ToolButtonTextBesideIcon, or Qt::ToolButtonTextOnly. By default, the application's default font is used.

Definition at line 785 of file qstyleoption.h.

Referenced by QStyleSheetStyle::drawComplexControl(), and QToolButton::initStyleOption().

◆ icon

QStyleOptionToolButton::icon

the icon for the tool button

The default value is an empty icon, i.e. an icon with neither a pixmap nor a filename.

See also
iconSize

Definition at line 779 of file qstyleoption.h.

Referenced by QToolButton::initStyleOption(), and QDockWidgetTitleButton::paintEvent().

◆ iconSize

QStyleOptionToolButton::iconSize

the size of the icon for the tool button

The default value is QSize(-1, -1), i.e. an invalid size.

Definition at line 780 of file qstyleoption.h.

Referenced by QToolButton::initStyleOption(), QDockWidgetTitleButton::paintEvent(), and QToolButton::sizeHint().

◆ pos

QStyleOptionToolButton::pos

the position of the tool button

The default value is a null point, i.e. (0, 0)

Definition at line 784 of file qstyleoption.h.

Referenced by QToolButton::initStyleOption().

◆ text

QStyleOptionToolButton::text

the text of the tool button

This value is only used if toolButtonStyle is Qt::ToolButtonTextUnderIcon, Qt::ToolButtonTextBesideIcon, or Qt::ToolButtonTextOnly. The default value is an empty string.

Definition at line 781 of file qstyleoption.h.

Referenced by QToolButton::initStyleOption().

◆ toolButtonStyle

QStyleOptionToolButton::toolButtonStyle

a Qt::ToolButtonStyle value describing the appearance of the tool button

The default value is Qt::ToolButtonIconOnly.

See also
QToolButton::toolButtonStyle()

Definition at line 783 of file qstyleoption.h.

Referenced by QToolButton::initStyleOption(), and QToolButton::sizeHint().


The documentation for this class was generated from the following files: