|  | Home · All Classes · Modules

# QStyleOptionTab Class Reference
[QtGui module]

The QStyleOptionTab class is used to describe the parameters for drawing a tab bar. More...

Inherits QStyleOption.

Inherited by QStyleOptionTabV2.

### Types

- enum CornerWidget { NoCornerWidgets, LeftCornerWidget, RightCornerWidget }
- class CornerWidgets
- enum SelectedPosition { NotAdjacent, NextIsSelected, PreviousIsSelected }
- enum StyleOptionType { Type }
- enum StyleOptionVersion { Version }
- enum TabPosition { Beginning, Middle, End, OnlyOneTab }

### Methods

- __init__ (self)
- __init__ (self, QStyleOptionTab other)

### Members

- CornerWidgets cornerWidgets
- QIcon icon
- TabPosition position
- int row
- SelectedPosition selectedPosition
- QTabBar.Shape shape
- QString text

## Detailed Description

The QStyleOptionTab class is used to describe the parameters for drawing a tab bar.

The QStyleOptionTab class is used for drawing several built-in Qt widgets including QTabBar and the panel for QTabWidget. Note that to describe the parameters necessary for drawing a frame in Qt 4.1 or above, you must use the QStyleOptionFrameV2 subclass.

An instance of the QStyleOptiontabV2 class has type SO_Tab and version 1. 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. 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.

If you create your own QStyle subclass, you should handle both QStyleOptionTab and QStyleOptionTabV2.

For an example demonstrating how style options can be used, see the Styles example.

## Type Documentation

### QStyleOptionTab.CornerWidget

These flags indicate the corner widgets in a tab.

Constant | Value | Description
--- | --- | ---
`QStyleOptionTab.NoCornerWidgets` | `0x00` | There are no corner widgets
`QStyleOptionTab.LeftCornerWidget` | `0x01` | Left corner widget
`QStyleOptionTab.RightCornerWidget` | `0x02` | Right corner widget

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

See also cornerWidgets.

### QStyleOptionTab.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
--- | --- | ---
`QStyleOptionTab.NotAdjacent` | `0` | The tab is not adjacent to a selected tab (or is the selected tab).
`QStyleOptionTab.NextIsSelected` | `1` | The next tab (typically the tab on the right) is selected.
`QStyleOptionTab.PreviousIsSelected` | `2` | The previous tab (typically the tab on the left) is selected.

See also selectedPosition.

### QStyleOptionTab.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
--- | --- | ---
`QStyleOptionTab.Type` | `SO_Tab` | The type of style option provided (SO_Tab 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.

### QStyleOptionTab.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
--- | --- | ---
`QStyleOptionTab.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.

### QStyleOptionTab.TabPosition

This enum describes the position of the tab.

Constant | Value | Description
--- | --- | ---
`QStyleOptionTab.Beginning` | `0` | The tab is the first tab in the tab bar.
`QStyleOptionTab.Middle` | `1` | The tab is neither the first nor the last tab in the tab bar.
`QStyleOptionTab.End` | `2` | The tab is the last tab in the tab bar.
`QStyleOptionTab.OnlyOneTab` | `3` | The tab is both the first and the last tab in the tab bar.

See also position.

## Method Documentation

### QStyleOptionTab.__init__ (self)

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

### QStyleOptionTab.__init__ (self, QStyleOptionTab other)

Constructs a copy of the other style option.

## Member Documentation

### CornerWidgets cornerWidgets

This variable holds an OR combination of CornerWidget values indicating the corner widgets of the tab bar.

The default value is NoCornerWidgets.

See also CornerWidget.

### QIcon icon

This variable holds the icon for the tab.

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

### TabPosition position

This variable holds the position of the tab in the tab bar.

The default value is Beginning, i.e. the tab is the first tab in the tab bar.

### int row

This variable holds which row the tab is currently in.

The default value is 0, indicating the front row. Currently this property can only be 0.

### SelectedPosition 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.

### QTabBar.Shape shape

This variable holds the tab shape used to draw the tab; by default QTabBar.RoundedNorth.

See also QTabBar.Shape.

### QString text

This variable holds the text of the tab.

The default value is an empty string.