QtBase  v6.3.1
Public Types | Public Member Functions | Public Attributes | Protected Member Functions | List of all members
QStyleOptionToolButton Class Reference

the title of the dock window More...

#include <qstyleoption.h>

Inheritance diagram for QStyleOptionToolButton:
Inheritance graph
[legend]
Collaboration diagram for QStyleOptionToolButton:
Collaboration graph
[legend]

Public Types

enum  StyleOptionType { Type = SO_ToolButton }
 
enum  StyleOptionVersion { Version = 1 }
 
enum  ToolButtonFeature {
  None = 0x00 , Arrow = 0x01 , Menu = 0x04 , MenuButtonPopup = Menu ,
  PopupDelay = 0x08 , HasMenu = 0x10
}
 
- Public Types inherited from QStyleOptionComplex
enum  StyleOptionType { Type = SO_Complex }
 
enum  StyleOptionVersion { Version = 1 }
 
- 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_DockWidget , SO_ViewItem , SO_TabWidgetFrame ,
  SO_TabBarBase , SO_RubberBand , SO_ToolBar , SO_GraphicsItem ,
  SO_Complex = 0xf0000 , SO_Slider , SO_SpinBox , SO_ToolButton ,
  SO_ComboBox , SO_TitleBar , SO_GroupBox , SO_SizeGrip ,
  SO_CustomBase = 0xf00 , SO_ComplexCustomBase = 0xf000000
}
 
enum  StyleOptionType { Type = SO_Default }
 
enum  StyleOptionVersion { Version = 1 }
 

Public Member Functions

 QStyleOptionToolButton ()
 
 QStyleOptionToolButton (const QStyleOptionToolButton &other)
 
QStyleOptionToolButtonoperator= (const QStyleOptionToolButton &)=default
 
- Public Member Functions inherited from QStyleOptionComplex
 QStyleOptionComplex (int version=QStyleOptionComplex::Version, int type=SO_Complex)
 
 QStyleOptionComplex (const QStyleOptionComplex &other)
 
QStyleOptionComplexoperator= (const QStyleOptionComplex &)=default
 
- Public Member Functions inherited from QStyleOption
 QStyleOption (int version=QStyleOption::Version, int type=SO_Default)
 
 QStyleOption (const QStyleOption &other)
 
 ~QStyleOption ()
 
void initFrom (const QWidget *w)
 
QStyleOptionoperator= (const QStyleOption &other)
 

Public Attributes

ToolButtonFeatures features
 
QIcon icon
 
QSize iconSize
 
QString text
 
Qt::ArrowType arrowType
 
Qt::ToolButtonStyle toolButtonStyle
 
QPoint pos
 
QFont font
 
- Public Attributes inherited from QStyleOptionComplex
QStyle::SubControls subControls
 
QStyle::SubControls activeSubControls
 
- Public Attributes inherited from QStyleOption
int version
 
int type
 
QStyle::State state
 
Qt::LayoutDirection direction
 
QRect rect
 
QFontMetrics fontMetrics
 
QPalette palette
 
QObjectstyleObject
 

Protected Member Functions

 QStyleOptionToolButton (int version)
 

Additional Inherited Members

Detailed Description

the title of the dock window

\variable QStyleOptionDockWidget::title

The default value is an empty string.

\variable QStyleOptionDockWidget::closable

whether the dock window is closable

The default value is true.

\variable QStyleOptionDockWidget::movable

whether the dock window is movable

The default value is false.

\variable QStyleOptionDockWidget::floatable

whether the dock window is floatable

The default value is true.

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

\inmodule QtWidgets

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

For performance reasons, there are few member functions and the access to the member variables is direct (i.e., using the . or -> operator). This 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 \l {widgets/styles}{Styles} example.

See also
QStyleOption, QStyleOptionComplex, QStyleOptionButton

Definition at line 578 of file qstyleoption.h.

Member Enumeration Documentation

◆ StyleOptionType

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

\value Type The type of style option provided (\l{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 581 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.

\value 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 582 of file qstyleoption.h.

◆ ToolButtonFeature

Describes the various features that a tool button can have.

\value None A normal tool button. \value Arrow The tool button is an arrow. \value Menu The tool button has a menu. \value PopupDelay There is a delay to showing the menu. \value HasMenu The button has a popup menu. \value 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 584 of file qstyleoption.h.

Constructor & Destructor Documentation

◆ QStyleOptionToolButton() [1/3]

QStyleOptionToolButton::QStyleOptionToolButton ( )

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

Definition at line 2405 of file qstyleoption.cpp.

◆ QStyleOptionToolButton() [2/3]

QStyleOptionToolButton::QStyleOptionToolButton ( const QStyleOptionToolButton other)
inline

Constructs a copy of the other style option.

Definition at line 598 of file qstyleoption.h.

Here is the call graph for this function:

◆ QStyleOptionToolButton() [3/3]

QStyleOptionToolButton::QStyleOptionToolButton ( int  version)
protected

Definition at line 2413 of file qstyleoption.cpp.

Member Function Documentation

◆ operator=()

QStyleOptionToolButton& QStyleOptionToolButton::operator= ( const QStyleOptionToolButton )
default

Member Data Documentation

◆ arrowType

Qt::ArrowType QStyleOptionToolButton::arrowType

Definition at line 592 of file qstyleoption.h.

◆ features

ToolButtonFeatures QStyleOptionToolButton::features

Definition at line 588 of file qstyleoption.h.

◆ font

QFont QStyleOptionToolButton::font

Definition at line 595 of file qstyleoption.h.

◆ icon

QIcon QStyleOptionToolButton::icon

Definition at line 589 of file qstyleoption.h.

◆ iconSize

QSize QStyleOptionToolButton::iconSize

Definition at line 590 of file qstyleoption.h.

◆ pos

QPoint QStyleOptionToolButton::pos

Definition at line 594 of file qstyleoption.h.

◆ text

QString QStyleOptionToolButton::text

Definition at line 591 of file qstyleoption.h.

◆ toolButtonStyle

Qt::ToolButtonStyle QStyleOptionToolButton::toolButtonStyle

Definition at line 593 of file qstyleoption.h.


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