QtGui.QStyleOptionTab Class Reference

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

Inheritance diagram for QtGui.QStyleOptionTab:

Collaboration diagram for QtGui.QStyleOptionTab:

Public Types
enum	CornerWidget { LeftCornerWidget = 1, NoCornerWidgets = 0, RightCornerWidget = 2 }
	More...
enum	SelectedPosition { NextIsSelected = 1, NotAdjacent = 0, PreviousIsSelected = 2 }
	More...
enum	StyleOptionType { Type = 3 }
	More...
enum	StyleOptionVersion { Version = 1 }
	More...
enum	TabPosition { Beginning = 0, End = 2, Middle = 1, OnlyOneTab = 3 }
	More...
Public Types inherited from QtGui.QStyleOption
enum	OptionType {   SO_Button = 2, SO_ComboBox = 983044, SO_Complex = 983040, SO_ComplexCustomBase = 251658240,   SO_CustomBase = 3840, SO_Default = 0, SO_DockWidget = 10, SO_FocusRect = 1,   SO_Frame = 5, SO_GraphicsItem = 17, SO_GroupBox = 983047, SO_Header = 8,   SO_MenuItem = 4, SO_ProgressBar = 6, SO_Q3DockWindow = 9, SO_Q3ListView = 983045,   SO_Q3ListViewItem = 11, SO_RubberBand = 15, SO_SizeGrip = 983048, SO_Slider = 983041,   SO_SpinBox = 983042, SO_Tab = 3, SO_TabBarBase = 14, SO_TabWidgetFrame = 13,   SO_TitleBar = 983046, SO_ToolBar = 16, SO_ToolBox = 7, SO_ToolButton = 983043,   SO_ViewItem = 12 }
	More...
enum	StyleOptionType { Type = 0 }
	More...
enum	StyleOptionVersion { Version = 1 }
	More...

Public Member Functions
	QStyleOptionTab ()
	QStyleOptionTab (QStyleOptionTab other)
override void	CreateProxy ()
new void	Dispose ()
Public Member Functions inherited from QtGui.QStyleOption
	QStyleOption (QStyleOption other)
	QStyleOption (int version=(int) QStyleOption.StyleOptionVersion.Version, int type=(int) QStyleOption.OptionType.SO_Default)
new void	Init (QWidget w)
new void	InitFrom (QWidget w)
new void	Dispose ()

Protected Member Functions
	QStyleOptionTab (System.Type dummy)
	QStyleOptionTab (int version)
Protected Member Functions inherited from QtGui.QStyleOption
	QStyleOption (System.Type dummy)

Properties
new QStyleOptionTab.CornerWidget	CornerWidgets [get, set]
new QIcon	Icon [get, set]
new QStyleOptionTab.TabPosition	Position [get, set]
new int	Row [get, set]
new QStyleOptionTab.SelectedPosition	selectedPosition [get, set]
new QTabBar.Shape	Shape [get, set]
new string	Text [get, set]
Properties inherited from QtGui.QStyleOption
virtual System.IntPtr	SmokeObject [get, set]
new Qt.LayoutDirection	Direction [get, set]
new QFontMetrics	FontMetrics [get, set]
new QPalette	Palette [get, set]
new QRect	Rect [get, set]
new QStyle.StateFlag	State [get, set]
new int	Type [get, set]
new int	Version [get, set]

Additional Inherited Members
Protected Attributes inherited from QtGui.QStyleOption
SmokeInvocation	interceptor

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.

See also QStyleOptionTabV2 and QStyleOption.

Member Enumeration Documentation

enum QtGui.QStyleOptionTab.CornerWidget

These flags indicate the corner widgets in a tab.

See also cornerWidgets.

Enumerator:

LeftCornerWidget	Left corner widget
NoCornerWidgets	There are no corner widgets
RightCornerWidget	Right corner widget

enum QtGui.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.

See also selectedPosition.

Enumerator:

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

enum QtGui.QStyleOptionTab.StyleOptionType

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

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	The type of style option provided (SO_Tab for this class).

enum QtGui.QStyleOptionTab.StyleOptionVersion

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

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

1

enum QtGui.QStyleOptionTab.TabPosition

This enum describes the position of the tab.

See also position.

Enumerator:

Beginning	The tab is the first tab in the tab bar.
End	The tab is the last tab in the tab bar.
Middle	The tab is neither the first nor the last tab in the tab bar.
OnlyOneTab	The tab is both the first and the last tab in the tab bar.

Constructor & Destructor Documentation

QtGui.QStyleOptionTab.QStyleOptionTab ( System.Type  dummy )

protected

QtGui.QStyleOptionTab.QStyleOptionTab

(

)

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

QtGui.QStyleOptionTab.QStyleOptionTab

(

QStyleOptionTab

other

)

Constructs a copy of the other style option.

QtGui.QStyleOptionTab.QStyleOptionTab ( int  version )

protected

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

Member Function Documentation

override void QtGui.QStyleOptionTab.CreateProxy ( )

virtual

Reimplemented from QtGui.QStyleOption.

Reimplemented in QtGui.QStyleOptionTabV3, and QtGui.QStyleOptionTabV2.

new void QtGui.QStyleOptionTab.Dispose

(

)

Property Documentation

new QStyleOptionTab.CornerWidget QtGui.QStyleOptionTab.CornerWidgets

getset

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.

new QIcon QtGui.QStyleOptionTab.Icon

getset

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.

new QStyleOptionTab.TabPosition QtGui.QStyleOptionTab.Position

getset

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.

new int QtGui.QStyleOptionTab.Row

getset

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.

new QStyleOptionTab.SelectedPosition QtGui.QStyleOptionTab.selectedPosition

getset

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.

new QTabBar.Shape QtGui.QStyleOptionTab.Shape

getset

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

See also QTabBar::Shape.

new string QtGui.QStyleOptionTab.Text

getset

This variable holds the text of the tab.

The default value is an empty string.