QStyleOptionToolBar#

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

Note

This documentation may contain snippets that were automatically translated from C++ to Python. We always welcome contributions to the snippet translation. If you see an issue with the translation, you can also let us know by creating a ticket on https:/bugreports.qt.io/projects/PYSIDE

Detailed Description#

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

The QStyleOptionToolBar class holds the lineWidth and the midLineWidth for drawing the widget. It also stores information about which 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 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

class PySide6.QtWidgets.QStyleOptionToolBar#

PySide6.QtWidgets.QStyleOptionToolBar(other)

PySide6.QtWidgets.QStyleOptionToolBar(version)

Parameters:

other – PySide6.QtWidgets.QStyleOptionToolBar
version – int

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

Constructs a copy of the other style option.

PySide6.QtWidgets.QStyleOptionToolBar.StyleOptionType#

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

Constant

Description

QStyleOptionToolBar.Type

The type of style option provided ( SO_ToolBar for this class).

Constant	Description
QStyleOptionToolBar.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

PySide6.QtWidgets.QStyleOptionToolBar.StyleOptionVersion#

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

Constant

Description

QStyleOptionToolBar.Version

1

Constant	Description
QStyleOptionToolBar.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

PySide6.QtWidgets.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 parent widget’s boundary edges.

Constant

Description

QStyleOptionToolBar.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.

QStyleOptionToolBar.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.

QStyleOptionToolBar.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.

QStyleOptionToolBar.OnlyOne

There is only one toolbar or line. This is the default value of the positionOfLine and positionWithinLine variables.

See also

positionWithinLine positionOfLine

Constant	Description
QStyleOptionToolBar.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.
QStyleOptionToolBar.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.
QStyleOptionToolBar.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.
QStyleOptionToolBar.OnlyOne	There is only one toolbar or line. This is the default value of the positionOfLine and positionWithinLine variables.

PySide6.QtWidgets.QStyleOptionToolBar.ToolBarFeature#

(inherits enum.Flag) This enum is used to describe whether a toolbar is movable or not.

Constant

Description

QStyleOptionToolBar.None

The toolbar cannot be moved. The default value.

QStyleOptionToolBar.Movable

The toolbar is movable, and a handle will appear when holding the cursor over the toolbar’s boundary.

See also

features isMovable()

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

PySide6.QtWidgets.QStyleOptionToolBar.positionOfLine#

PySide6.QtWidgets.QStyleOptionToolBar.positionWithinLine#

PySide6.QtWidgets.QStyleOptionToolBar.toolBarArea#

PySide6.QtWidgets.QStyleOptionToolBar.features#

PySide6.QtWidgets.QStyleOptionToolBar.lineWidth#

PySide6.QtWidgets.QStyleOptionToolBar.midLineWidth#