QStyleOptionToolBox Class | Qt Widgets | Qt 6.12.0
Description: The QStyleOptionToolBox class is used to describe the parameters needed for drawing a tool box.
Keywords: class

- Qt 6.12
- Qt Widgets
- C++ Classes
- QStyleOptionToolBox
- Qt 6.12.0 Reference Documentation

# QStyleOptionToolBox Class

The QStyleOptionToolBox class is used to describe the parameters needed for drawing a tool box. More...

Header: | `#include <QStyleOptionToolBox>`
CMake: | `find_package(Qt6 REQUIRED COMPONENTS Widgets)` `target_link_libraries(mytarget PRIVATE Qt6::Widgets)`
qmake: | `QT += widgets`
Inherits: | QStyleOption

- List of all members, including inherited members

## Public Types

enum | SelectedPosition { NotAdjacent, NextIsSelected, PreviousIsSelected }
enum | StyleOptionType { Type }
enum | StyleOptionVersion { Version }
enum | TabPosition { Beginning, Middle, End, OnlyOneTab }

## Public Functions

| QStyleOptionToolBox()
| QStyleOptionToolBox(const QStyleOptionToolBox &other)
QStyleOptionToolBox & | operator=(const QStyleOptionToolBox &)

## Public Variables

QIcon | icon
QStyleOptionToolBox::SelectedPosition | selectedPosition
QString | text

## Detailed Description

QStyleOptionToolBox contains all the information that QStyle functions need to draw QToolBox.

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.

See also QStyleOption and QToolBox.

## Member Type Documentation

### enum QStyleOptionToolBox::SelectedPosition

This enum describes the position of the selected tab. Some styles need to draw a tab differently depending on whether or not it is adjacent to the selected tab.

Constant | Value | Description
--- | --- | ---
`QStyleOptionToolBox::NotAdjacent` | `0` | The tab is not adjacent to a selected tab (or is the selected tab).
`QStyleOptionToolBox::NextIsSelected` | `1` | The next tab (typically the tab on the right) is selected.
`QStyleOptionToolBox::PreviousIsSelected` | `2` | The previous tab (typically the tab on the left) is selected.

See also selectedPosition.

### enum QStyleOptionToolBox::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
--- | --- | ---
`QStyleOptionToolBox::Type` | `SO_ToolBox` | The type of style option provided (SO_ToolBox 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 QStyleOptionToolBox::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
--- | --- | ---
`QStyleOptionToolBox::Version` | `1` | 2

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 QStyleOptionToolBox::TabPosition

This enum describes tab positions relative to other tabs.

Constant | Value | Description
--- | --- | ---
`QStyleOptionToolBox::Beginning` | `0` | The tab is the first (i.e., top-most) tab in the toolbox.
`QStyleOptionToolBox::Middle` | `1` | The tab is placed in the middle of the toolbox.
`QStyleOptionToolBox::End` | `2` | The tab is placed at the bottom of the toolbox.
`QStyleOptionToolBox::OnlyOneTab` | `3` | There is only one tab in the toolbox.

## Member Function Documentation

### QStyleOptionToolBox::QStyleOptionToolBox()

Creates a QStyleOptionToolBox, initializing the members variables to their default values.

### QStyleOptionToolBox::QStyleOptionToolBox(const QStyleOptionToolBox &other)

Constructs a copy of the other style option.

### `[noexcept default]` QStyleOptionToolBox &QStyleOptionToolBox::operator=(const QStyleOptionToolBox &)

Copy-assigns other to this QStyleOptionToolBox instance.

## Member Variable Documentation

### QIcon QStyleOptionToolBox::icon

This variable holds the icon for the tool box tab

The default value is an empty icon, i.e. an icon with neither a pixmap nor a filename.

### QStyleOptionToolBox::SelectedPosition QStyleOptionToolBox::selectedPosition

This variable holds the position of the selected tab in relation to this tab

The default value is NotAdjacent, i.e. the tab is not adjacent to a selected tab nor is it the selected tab.

### QString QStyleOptionToolBox::text

This variable holds the text for the tool box tab

The default value is an empty string.