The QStyleOptionToolBar class is used to describe the parameters for drawing a toolbar. More...

#include <qstyleoption.h>

Inheritance diagram for QStyleOptionToolBar:

Public Types
enum	StyleOptionType { Type = SO_ToolBar }
	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	ToolBarFeature { None = 0x0, Movable = 0x1 }
	This enum is used to describe whether a toolbar is movable or not. More...

enum	ToolBarPosition { Beginning, Middle, End, OnlyOne }
	This enum is used to describe the position of a toolbar line, as well as the toolbar's position within the line. 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
	QStyleOptionToolBar ()
	Constructs a QStyleOptionToolBar, initializing the members variables to their default values. More...

	QStyleOptionToolBar (const QStyleOptionToolBar &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)

QStyleOption &	operator= (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
ToolBarFeatures	features
	This variable holds whether the toolbar is movable or not. More...

int	lineWidth
	This variable holds the line width for drawing the toolbar. More...

int	midLineWidth
	This variable holds the mid-line width for drawing the toolbar. More...

ToolBarPosition	positionOfLine
	This variable holds the position of the toolbar line. More...

ToolBarPosition	positionWithinLine
	This variable holds the position of the toolbar within a line. More...

Qt::ToolBarArea	toolBarArea
	This variable holds the location for drawing the toolbar. 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
	QStyleOptionToolBar (int version)

Additional Inherited Members
Related Functions inherited from QStyleOption
T	qstyleoption_cast (const QStyleOption *option)

T	qstyleoption_cast (QStyleOption *option)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. More...

Detailed Description

The QStyleOptionToolBar class is used to describe the parameters for drawing a toolbar.

Since: 4.1

QStyleOptionToolBar contains all the information that QStyle functions need to draw QToolBar.

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.

The QStyleOptionToolBar class holds the lineWidth and the midLineWidth for drawing the widget. It also stores information about which toolBarArea{area} the toolbar should be located in, whether it is movable or not, which position the toolbar line should have (positionOfLine), and the toolbar's position within the line (positionWithinLine).

In addition, the class provides a couple of enums: The ToolBarFeature enum is used to describe whether a toolbar is movable or not, and the ToolBarPosition enum is used to describe the position of a toolbar line, as well as the toolbar's position within the line.

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

See also: QStyleOption

Definition at line 369 of file qstyleoption.h.

Enumerations

◆ StyleOptionType

enum QStyleOptionToolBar::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_ToolBar 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 372 of file qstyleoption.h.

372 { Type = SO_ToolBar };

QStyleOption::SO_ToolBar

Definition: qstyleoption.h:74

QStyleOptionToolBar::Type

Definition: qstyleoption.h:372

◆ StyleOptionVersion

enum QStyleOptionToolBar::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 373 of file qstyleoption.h.

373 { Version = 1 };

QStyleOptionToolBar::Version

Definition: qstyleoption.h:373

◆ ToolBarFeature

enum QStyleOptionToolBar::ToolBarFeature

This enum is used to describe whether a toolbar is movable or not.

None The toolbar cannot be moved. The default value.
Movable The toolbar is movable, and a handle will appear when holding the cursor over the toolbar's boundary.

See also: features, QToolBar::isMovable()

Enumerator
None
Movable

Definition at line 375 of file qstyleoption.h.

375 { None = 0x0, Movable = 0x1 };

QStyleOptionToolBar::Movable

Definition: qstyleoption.h:375

QStyleOptionToolBar::None

Definition: qstyleoption.h:375

◆ ToolBarPosition

enum QStyleOptionToolBar::ToolBarPosition

This enum is used to describe the position of a toolbar line, as well as the toolbar's position within the line.

The order of the positions within a line starts at the top of a vertical line, and from the left within a horizontal line. The order of the positions for the lines is always from the the parent widget's boundary edges.

Beginning The toolbar is located at the beginning of the line, or the toolbar line is the first of several lines. There can only be one toolbar (and only one line) with this position.
Middle The toolbar is located in the middle of the line, or the toolbar line is in the middle of several lines. There can several toolbars (and lines) with this position.
End The toolbar is located at the end of the line, or the toolbar line is the last of several lines. There can only be one toolbar (and only one line) with this position.
OnlyOne There is only one toolbar or line. This is the default value of the positionOfLine and positionWithinLine variables.

See also: positionWithinLine, positionOfLine

Enumerator
Beginning
Middle
End
OnlyOne

Definition at line 374 of file qstyleoption.h.

374 { Beginning, Middle, End, OnlyOne };

QStyleOptionToolBar::End

Definition: qstyleoption.h:374

QStyleOptionToolBar::OnlyOne

Definition: qstyleoption.h:374

QStyleOptionToolBar::Beginning

Definition: qstyleoption.h:374

QStyleOptionToolBar::Middle

Definition: qstyleoption.h:374

Constructors and Destructors

◆ QStyleOptionToolBar() [1/3]

QStyleOptionToolBar::QStyleOptionToolBar ( )

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

Definition at line 1888 of file qstyleoption.cpp.

     : QStyleOption(Version, SO_ToolBar), positionOfLine(OnlyOne), positionWithinLine(OnlyOne),
       toolBarArea(Qt::TopToolBarArea), features(None), lineWidth(0), midLineWidth(0)
 {
 }

◆ QStyleOptionToolBar() [2/3]

QStyleOptionToolBar::QStyleOptionToolBar ( const QStyleOptionToolBar & other )

inline

Constructs a copy of the other style option.

Definition at line 384 of file qstyleoption.h.

384 : QStyleOption(Version, Type) { *this = other; }

QStyleOptionToolBar::Type

Definition: qstyleoption.h:372

QStyleOptionToolBar::Version

Definition: qstyleoption.h:373

QStyleOption::QStyleOption

QStyleOption(int version=QStyleOption::Version, int type=SO_Default)

Constructs a QStyleOption with the specified version and type.

Definition: qstyleoption.cpp:167

◆ QStyleOptionToolBar() [3/3]

QStyleOptionToolBar::QStyleOptionToolBar ( int version )

protected

Warning: This function is not part of the public interface.

Definition at line 1906 of file qstyleoption.cpp.

 : QStyleOption(version, SO_ToolBar), positionOfLine(OnlyOne), positionWithinLine(OnlyOne),
   toolBarArea(Qt::TopToolBarArea), features(None), lineWidth(0), midLineWidth(0)
 {
 
 }

Properties

◆ features

QStyleOptionToolBar::features

This variable holds whether the toolbar is movable or not.

The default value is None .

Definition at line 380 of file qstyleoption.h.

Referenced by QToolBar::initStyleOption().

◆ lineWidth

QStyleOptionToolBar::lineWidth

This variable holds the line width for drawing the toolbar.

The default value is 0.

Definition at line 381 of file qstyleoption.h.

Referenced by QToolBar::initStyleOption().

◆ midLineWidth

QStyleOptionToolBar::midLineWidth

This variable holds the mid-line width for drawing the toolbar.

The default value is 0.

Definition at line 382 of file qstyleoption.h.

◆ positionOfLine

QStyleOptionToolBar::positionOfLine

This variable holds the position of the toolbar line.

The default value is QStyleOptionToolBar::OnlyOne.

Definition at line 377 of file qstyleoption.h.

Referenced by QToolBarAreaLayout::getStyleOptionInfo().

◆ positionWithinLine

QStyleOptionToolBar::positionWithinLine

This variable holds the position of the toolbar within a line.

The default value is QStyleOptionToolBar::OnlyOne.

Definition at line 378 of file qstyleoption.h.

Referenced by QToolBarAreaLayout::getStyleOptionInfo().

◆ toolBarArea

QStyleOptionToolBar::toolBarArea

This variable holds the location for drawing the toolbar.

The default value is Qt::TopToolBarArea.

See also: Qt::ToolBarArea

Definition at line 379 of file qstyleoption.h.

Referenced by QMainWindowLayout::getStyleOptionInfo(), and QToolBar::initStyleOption().

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

/src/gui/styles/qstyleoption.h
/src/gui/styles/qstyleoption.cpp

Public Types

Public Functions

Public Variables

Protected Functions

Additional Inherited Members

Detailed Description

Enumerations

◆ StyleOptionType

◆ StyleOptionVersion

◆ ToolBarFeature

◆ ToolBarPosition

Constructors and Destructors

◆ QStyleOptionToolBar() [1/3]

◆ QStyleOptionToolBar() [2/3]

◆ QStyleOptionToolBar() [3/3]

Properties

◆ features

◆ lineWidth

◆ midLineWidth

◆ positionOfLine

◆ positionWithinLine

◆ toolBarArea