Qt 4.8
Public Types | Public Functions | Public Variables | Protected Functions | List of all members
QStyleOptionTab Class Reference

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

#include <qstyleoption.h>

Inheritance diagram for QStyleOptionTab:
QStyleOption QStyleOptionTabV2 QStyleOptionTabV3

Public Types

enum  CornerWidget { NoCornerWidgets = 0x00, LeftCornerWidget = 0x01, RightCornerWidget = 0x02 }
 These flags indicate the corner widgets in a tab. More...
 
enum  SelectedPosition { NotAdjacent, NextIsSelected, PreviousIsSelected }
 This enum describes the position of the selected tab. More...
 
enum  StyleOptionType { Type = SO_Tab }
 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  TabPosition { Beginning, Middle, End, OnlyOneTab }
 This enum describes the position of the tab. 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

 QStyleOptionTab ()
 Constructs a QStyleOptionTab object, initializing the members variables to their default values. More...
 
 QStyleOptionTab (const QStyleOptionTab &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)
 
QStyleOptionoperator= (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

CornerWidgets cornerWidgets
 an OR combination of CornerWidget values indicating the corner widgets of the tab bar More...
 
QIcon icon
 the icon for the tab More...
 
TabPosition position
 the position of the tab in the tab bar More...
 
int row
 which row the tab is currently in More...
 
SelectedPosition selectedPosition
 the position of the selected tab in relation to this tab More...
 
QTabBar::Shape shape
 the tab shape used to draw the tab; by default QTabBar::RoundedNorth More...
 
QString text
 the text of the tab 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

 QStyleOptionTab (int version)
 

Additional Inherited Members

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 widgets/styles{Styles} example.

See also
QStyleOptionTabV2, QStyleOption

Definition at line 304 of file qstyleoption.h.

Enumerations

◆ CornerWidget

These flags indicate the corner widgets in a tab.

  • NoCornerWidgets There are no corner widgets
  • LeftCornerWidget Left corner widget
  • RightCornerWidget Right corner widget
See also
cornerWidgets
Enumerator
NoCornerWidgets 
LeftCornerWidget 
RightCornerWidget 

Definition at line 312 of file qstyleoption.h.

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

  • NotAdjacent The tab is not adjacent to a selected tab (or is the selected tab).
  • NextIsSelected The next tab (typically the tab on the right) is selected.
  • PreviousIsSelected The previous tab (typically the tab on the left) is selected.
See also
selectedPosition
Enumerator
NotAdjacent 
NextIsSelected 
PreviousIsSelected 

Definition at line 311 of file qstyleoption.h.

◆ 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_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
Enumerator
Type 

Definition at line 307 of file qstyleoption.h.

◆ 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 308 of file qstyleoption.h.

◆ TabPosition

This enum describes the position of the tab.

  • Beginning The tab is the first tab in the tab bar.
  • Middle The tab is neither the first nor the last tab in the tab bar.
  • End The tab is the last tab in the tab bar.
  • OnlyOneTab The tab is both the first and the last tab in the tab bar.
See also
position
Enumerator
Beginning 
Middle 
End 
OnlyOneTab 

Definition at line 310 of file qstyleoption.h.

Constructors and Destructors

◆ QStyleOptionTab() [1/3]

QStyleOptionTab::QStyleOptionTab ( )

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

Definition at line 2106 of file qstyleoption.cpp.

2109  row(0),
2112 {
2113 }
TabPosition position
the position of the tab in the tab bar
Definition: qstyleoption.h:320
QTabBar::Shape shape
the tab shape used to draw the tab; by default QTabBar::RoundedNorth
Definition: qstyleoption.h:316
int row
which row the tab is currently in
Definition: qstyleoption.h:319
CornerWidgets cornerWidgets
an OR combination of CornerWidget values indicating the corner widgets of the tab bar ...
Definition: qstyleoption.h:322
SelectedPosition selectedPosition
the position of the selected tab in relation to this tab
Definition: qstyleoption.h:321
QStyleOption(int version=QStyleOption::Version, int type=SO_Default)
Constructs a QStyleOption with the specified version and type.

◆ QStyleOptionTab() [2/3]

QStyleOptionTab::QStyleOptionTab ( const QStyleOptionTab other)
inline

Constructs a copy of the other style option.

Definition at line 325 of file qstyleoption.h.

325 : QStyleOption(Version, Type) { *this = other; }
QStyleOption(int version=QStyleOption::Version, int type=SO_Default)
Constructs a QStyleOption with the specified version and type.

◆ QStyleOptionTab() [3/3]

QStyleOptionTab::QStyleOptionTab ( int  version)
protected
Warning
This function is not part of the public interface.

Definition at line 2118 of file qstyleoption.cpp.

2121  row(0),
2124 {
2125 }
int version
the version of the style option
Definition: qstyleoption.h:86
TabPosition position
the position of the tab in the tab bar
Definition: qstyleoption.h:320
QTabBar::Shape shape
the tab shape used to draw the tab; by default QTabBar::RoundedNorth
Definition: qstyleoption.h:316
int row
which row the tab is currently in
Definition: qstyleoption.h:319
CornerWidgets cornerWidgets
an OR combination of CornerWidget values indicating the corner widgets of the tab bar ...
Definition: qstyleoption.h:322
SelectedPosition selectedPosition
the position of the selected tab in relation to this tab
Definition: qstyleoption.h:321
QStyleOption(int version=QStyleOption::Version, int type=SO_Default)
Constructs a QStyleOption with the specified version and type.

Properties

◆ cornerWidgets

QStyleOptionTab::cornerWidgets

an OR combination of CornerWidget values indicating the corner widgets of the tab bar

The default value is NoCornerWidgets.

See also
CornerWidget

Definition at line 322 of file qstyleoption.h.

Referenced by QTabBar::initStyleOption().

◆ icon

QStyleOptionTab::icon

the icon for the tab

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

Definition at line 318 of file qstyleoption.h.

Referenced by QCommonStyle::drawControl(), QTabBar::initStyleOption(), QCommonStylePrivate::tabLayout(), and QTabBar::tabSizeHint().

◆ position

QStyleOptionTab::position

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.

Definition at line 320 of file qstyleoption.h.

Referenced by QWindowsMobileStylePrivate::drawTabBarTab(), and QTabBar::initStyleOption().

◆ row

QStyleOptionTab::row

which row the tab is currently in

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

Definition at line 319 of file qstyleoption.h.

Referenced by QTabBar::initStyleOption().

◆ selectedPosition

QStyleOptionTab::selectedPosition

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.

Definition at line 321 of file qstyleoption.h.

Referenced by QWindowsMobileStylePrivate::drawTabBarTab(), drawTabShape(), and QTabBar::initStyleOption().

◆ shape

QStyleOptionTab::shape

◆ text

QStyleOptionTab::text

the text of the tab

The default value is an empty string.

Definition at line 317 of file qstyleoption.h.

Referenced by QMacStyle::drawControl(), QTabBar::initStyleOption(), and QTabBar::tabSizeHint().


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