QStyleOptionToolButton Class

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

Header:	#include <QStyleOptionToolButton>
CMake:	find_package(Qt6 COMPONENTS Widgets REQUIRED) target_link_libraries(mytarget PRIVATE Qt6::Widgets)
qmake:	QT += widgets
Inherits:	QStyleOptionComplex

• List of all members, including inherited members

Public Types

enum	StyleOptionType { Type }
enum	StyleOptionVersion { Version }
enum	ToolButtonFeature { None, Arrow, Menu, PopupDelay, HasMenu, MenuButtonPopup }
flags	ToolButtonFeatures

Public Functions

	QStyleOptionToolButton(const QStyleOptionToolButton &other)
	QStyleOptionToolButton()

Public Variables

Qt::ArrowType	arrowType
QStyleOptionToolButton::ToolButtonFeatures	features
QFont	font
QIcon	icon
QSize	iconSize
QPoint	pos
QString	text
Qt::ToolButtonStyle	toolButtonStyle

Detailed Description

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 Styles example.

See also QStyleOption, QStyleOptionComplex, and QStyleOptionButton.

Member Type Documentation

enum QStyleOptionToolButton::StyleOptionType

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

Constant	Value	Description
QStyleOptionToolButton::Type	SO_ToolButton	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.

enum QStyleOptionToolButton::StyleOptionVersion

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

Constant	Value	Description
QStyleOptionToolButton::Version	1	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.

enum QStyleOptionToolButton::ToolButtonFeatureflags QStyleOptionToolButton::ToolButtonFeatures

Describes the various features that a tool button can have.

Constant	Value	Description
QStyleOptionToolButton::None	0x00	A normal tool button.
QStyleOptionToolButton::Arrow	0x01	The tool button is an arrow.
QStyleOptionToolButton::Menu	0x04	The tool button has a menu.
QStyleOptionToolButton::PopupDelay	0x08	There is a delay to showing the menu.
QStyleOptionToolButton::HasMenu	0x10	The button has a popup menu.
QStyleOptionToolButton::MenuButtonPopup	Menu	The button should display an arrow to indicate that a menu is present.

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

See also features, QToolButton::toolButtonStyle(), and QToolButton::popupMode().

Member Function Documentation

QStyleOptionToolButton::QStyleOptionToolButton(const QStyleOptionToolButton &other)

Constructs a copy of the other style option.

QStyleOptionToolButton::QStyleOptionToolButton()

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