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

The QStyleOptionButton class is used to describe the parameters for drawing buttons. More...

#include <qstyleoption.h>

Inheritance diagram for QStyleOptionButton:
QStyleOption

Public Types

enum  ButtonFeature {
  None = 0x00, Flat = 0x01, HasMenu = 0x02, DefaultButton = 0x04,
  AutoDefaultButton = 0x08, CommandLinkButton = 0x10
}
 This enum describes the different types of features a push button can have. More...
 
enum  StyleOptionType { Type = SO_Button }
 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

 QStyleOptionButton ()
 Constructs a QStyleOptionButton, initializing the members variables to their default values. More...
 
 QStyleOptionButton (const QStyleOptionButton &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

ButtonFeatures features
 a bitwise OR of the features that describe this button More...
 
QIcon icon
 the icon of the button More...
 
QSize iconSize
 the size of the icon for the button More...
 
QString text
 the text of the button 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

 QStyleOptionButton (int version)
 

Additional Inherited Members

Detailed Description

The QStyleOptionButton class is used to describe the parameters for drawing buttons.

QStyleOptionButton contains all the information that QStyle functions need to draw graphical elements like QPushButton, QCheckBox, and QRadioButton.

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, QStyleOptionToolButton

Definition at line 279 of file qstyleoption.h.

Enumerations

◆ ButtonFeature

This enum describes the different types of features a push button can have.

  • None Indicates a normal push button.
  • Flat Indicates a flat push button.
  • HasMenu Indicates that the button has a drop down menu.
  • DefaultButton Indicates that the button is a default button.
  • AutoDefaultButton Indicates that the button is an auto default button.
  • CommandLinkButton Indicates that the button is a Windows Vista type command link.
See also
features
Enumerator
None 
Flat 
HasMenu 
DefaultButton 
AutoDefaultButton 
CommandLinkButton 

Definition at line 285 of file qstyleoption.h.

◆ 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_Button 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 282 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 283 of file qstyleoption.h.

Constructors and Destructors

◆ QStyleOptionButton() [1/3]

QStyleOptionButton::QStyleOptionButton ( )

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

Definition at line 1742 of file qstyleoption.cpp.

1744 {
1745 }
ButtonFeatures features
a bitwise OR of the features that describe this button
Definition: qstyleoption.h:289
QStyleOption(int version=QStyleOption::Version, int type=SO_Default)
Constructs a QStyleOption with the specified version and type.

◆ QStyleOptionButton() [2/3]

QStyleOptionButton::QStyleOptionButton ( const QStyleOptionButton other)
inline

Constructs a copy of the other style option.

Definition at line 295 of file qstyleoption.h.

295 : QStyleOption(Version, Type) { *this = other; }
QStyleOption(int version=QStyleOption::Version, int type=SO_Default)
Constructs a QStyleOption with the specified version and type.

◆ QStyleOptionButton() [3/3]

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

Definition at line 1750 of file qstyleoption.cpp.

1752 {
1753 }
int version
the version of the style option
Definition: qstyleoption.h:86
ButtonFeatures features
a bitwise OR of the features that describe this button
Definition: qstyleoption.h:289
QStyleOption(int version=QStyleOption::Version, int type=SO_Default)
Constructs a QStyleOption with the specified version and type.

Properties

◆ features

QStyleOptionButton::features

◆ icon

QStyleOptionButton::icon

the icon of the 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 291 of file qstyleoption.h.

Referenced by QRadioButton::initStyleOption(), QCheckBox::initStyleOption(), QPushButton::initStyleOption(), QCommandLinkButton::paintEvent(), QMacStylePrivate::pushButtonSizeFromContents(), QRadioButton::sizeHint(), and QCheckBox::sizeHint().

◆ iconSize

QStyleOptionButton::iconSize

the size of the icon for the button

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

Definition at line 292 of file qstyleoption.h.

Referenced by QRadioButton::initStyleOption(), QCheckBox::initStyleOption(), QPushButton::initStyleOption(), QMacStylePrivate::pushButtonSizeFromContents(), QRadioButton::sizeHint(), QCheckBox::sizeHint(), and QPushButton::sizeHint().

◆ text

QStyleOptionButton::text

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