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

The QStyleOptionTabV3 class is used to describe the parameters necessary for drawing a tabs in Qt 4.5 or above. More...

#include <qstyleoption.h>

Inheritance diagram for QStyleOptionTabV3:
QStyleOptionTabV2 QStyleOptionTab QStyleOption

Public Types

enum  StyleOptionVersion { Version = 3 }
 This enum is used to hold information about the version of the style option, and is defined for each QStyleOption subclass. More...
 
- Public Types inherited from QStyleOptionTabV2
enum  StyleOptionVersion { Version = 2 }
 This enum is used to hold information about the version of the style option, and is defined for each QStyleOption subclass. More...
 
- Public Types inherited from QStyleOptionTab
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

QStyleOptionTabV3operator= (const QStyleOptionTab &other)
 Assigns the other style option to this QStyleOptionTabV3. More...
 
 QStyleOptionTabV3 ()
 Constructs a QStyleOptionTabV3. More...
 
 QStyleOptionTabV3 (const QStyleOptionTabV3 &other)
 Constructs a copy of the other style option. More...
 
 QStyleOptionTabV3 (const QStyleOptionTabV2 &other)
 Constructs a copy of the other style option. More...
 
 QStyleOptionTabV3 (const QStyleOptionTab &other)
 Constructs a QStyleOptionTabV3 copy of the other style option which can be either of the QStyleOptionTabV3, QStyleOptionTabV2 or QStyleOptionTab types. More...
 
- Public Functions inherited from QStyleOptionTabV2
QStyleOptionTabV2operator= (const QStyleOptionTab &other)
 Assigns the other style option to this QStyleOptionTabV2. More...
 
 QStyleOptionTabV2 ()
 Constructs a QStyleOptionTabV2. More...
 
 QStyleOptionTabV2 (const QStyleOptionTabV2 &other)
 Constructs a copy of the other style option. More...
 
 QStyleOptionTabV2 (const QStyleOptionTab &other)
 Constructs a QStyleOptionTabV2 copy of the other style option which can be either of the QStyleOptionTabV2 or QStyleOptionTab types. More...
 
- Public Functions inherited from QStyleOptionTab
 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

bool documentMode
 whether the tabbar is in document mode. More...
 
QSize leftButtonSize
 the size for the left widget on the tab. More...
 
QSize rightButtonSize
 the size for the right widget on the tab. More...
 
- Public Variables inherited from QStyleOptionTabV2
QSize iconSize
 the size for the icons More...
 
- Public Variables inherited from QStyleOptionTab
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

 QStyleOptionTabV3 (int version)
 
- Protected Functions inherited from QStyleOptionTabV2
 QStyleOptionTabV2 (int version)
 
- Protected Functions inherited from QStyleOptionTab
 QStyleOptionTab (int version)
 

Additional Inherited Members

Detailed Description

The QStyleOptionTabV3 class is used to describe the parameters necessary for drawing a tabs in Qt 4.5 or above.

Since
4.5

An instance of the QStyleOptionTabV3 class has type SO_Tab and version 3. 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, QStyleOptionTabV2 and QStyleOptionTabV3. One way to achieve this is to use the QStyleOptionTabV3 copy constructor. For example:

if (const QStyleOptionTab *tabOption =
qstyleoption_cast<const QStyleOptionTab *>(option)) {
QStyleOptionTabV2 tabV2(*tabOption);
// draw the tab using tabV2
}

In the example above: If tabOption's version is 1, the extra member (iconSize) will be set to an invalid size for tabV2. If tabOption's version is 2, the constructor will simply copy the tab's iconSize.

For an example demonstrating how style options can be used, see the widgets/styles{Styles} example.

See also
QStyleOptionTab, QStyleOption

Definition at line 347 of file qstyleoption.h.

Enumerations

◆ StyleOptionVersion

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

  • Version 3

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

Constructors and Destructors

◆ QStyleOptionTabV3() [1/5]

QStyleOptionTabV3::QStyleOptionTabV3 ( )

Constructs a QStyleOptionTabV3.

Definition at line 2524 of file qstyleoption.cpp.

2526  , documentMode(false)
2527 {
2528 }
QStyleOptionTabV2()
Constructs a QStyleOptionTabV2.
bool documentMode
whether the tabbar is in document mode.
Definition: qstyleoption.h:351

◆ QStyleOptionTabV3() [2/5]

QStyleOptionTabV3::QStyleOptionTabV3 ( const QStyleOptionTabV3 other)
inline

Constructs a copy of the other style option.

Definition at line 355 of file qstyleoption.h.

355 : QStyleOptionTabV2(Version) { *this = other; }
QStyleOptionTabV2()
Constructs a QStyleOptionTabV2.

◆ QStyleOptionTabV3() [3/5]

QStyleOptionTabV3::QStyleOptionTabV3 ( const QStyleOptionTabV2 other)
inline

Constructs a copy of the other style option.

Definition at line 356 of file qstyleoption.h.

356 : QStyleOptionTabV2(Version) { *this = other; }
QStyleOptionTabV2()
Constructs a QStyleOptionTabV2.

◆ QStyleOptionTabV3() [4/5]

QStyleOptionTabV3::QStyleOptionTabV3 ( const QStyleOptionTab other)

Constructs a QStyleOptionTabV3 copy of the other style option which can be either of the QStyleOptionTabV3, QStyleOptionTabV2 or QStyleOptionTab types.

If the other style option's version is 1 or 2, the new style option's leftButtonSize and rightButtonSize is set to an invalid value. If its version is 3, its leftButtonSize and rightButtonSize values are simply copied to the new style option.

Definition at line 2566 of file qstyleoption.cpp.

2568 {
2569  if (const QStyleOptionTabV3 *tab = qstyleoption_cast<const QStyleOptionTabV3 *>(&other)) {
2570  *this = *tab;
2571  } else {
2572  *((QStyleOptionTabV2 *)this) = other;
2573  version = Version;
2574  }
2575 }
int version
the version of the style option
Definition: qstyleoption.h:86
The QStyleOptionTabV2 class is used to describe the parameters necessary for drawing a tabs in Qt 4...
Definition: qstyleoption.h:333
QStyleOptionTabV2()
Constructs a QStyleOptionTabV2.
The QStyleOptionTabV3 class is used to describe the parameters necessary for drawing a tabs in Qt 4...
Definition: qstyleoption.h:347

◆ QStyleOptionTabV3() [5/5]

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

Definition at line 2533 of file qstyleoption.cpp.

2535 {
2536 }
int version
the version of the style option
Definition: qstyleoption.h:86
QStyleOptionTabV2()
Constructs a QStyleOptionTabV2.

Functions

◆ operator=()

QStyleOptionTabV3 & QStyleOptionTabV3::operator= ( const QStyleOptionTab other)

Assigns the other style option to this QStyleOptionTabV3.

The other style option can be either of the QStyleOptionTabV3, QStyleOptionTabV2 or QStyleOptionTab types.

If the other style option's version is 1 or 2, the new style option's leftButtonSize and rightButtonSize is set to an invalid value. If its version is 3, its leftButtonSize and rightButtonSize values are simply copied to the new style option.

Definition at line 2587 of file qstyleoption.cpp.

2588 {
2590 
2591  if (const QStyleOptionTabV3 *tab = qstyleoption_cast<const QStyleOptionTabV3 *>(&other)) {
2592  leftButtonSize = tab->leftButtonSize;
2593  rightButtonSize = tab->rightButtonSize;
2594  } else {
2595  leftButtonSize = QSize();
2596  rightButtonSize = QSize();
2597  documentMode = false;
2598  }
2599  return *this;
2600 }
QStyleOptionTabV2 & operator=(const QStyleOptionTab &other)
Assigns the other style option to this QStyleOptionTabV2.
QSize rightButtonSize
the size for the right widget on the tab.
Definition: qstyleoption.h:353
bool documentMode
whether the tabbar is in document mode.
Definition: qstyleoption.h:351
The QStyleOptionTabV3 class is used to describe the parameters necessary for drawing a tabs in Qt 4...
Definition: qstyleoption.h:347
The QSize class defines the size of a two-dimensional object using integer point precision.
Definition: qsize.h:53
QSize leftButtonSize
the size for the left widget on the tab.
Definition: qstyleoption.h:352

Properties

◆ documentMode

QStyleOptionTabV3::documentMode

whether the tabbar is in document mode.

The default value is false;

Definition at line 351 of file qstyleoption.h.

Referenced by QMacStyle::drawControl(), and operator=().

◆ leftButtonSize

QStyleOptionTabV3::leftButtonSize

the size for the left widget on the tab.

The default value is QSize(-1, -1), i.e. an invalid size;

Definition at line 352 of file qstyleoption.h.

Referenced by QMacStyle::drawControl(), operator=(), QCommonStylePrivate::tabLayout(), and QTabBar::tabSizeHint().

◆ rightButtonSize

QStyleOptionTabV3::rightButtonSize

the size for the right widget on the tab.

The default value is QSize(-1, -1), i.e. an invalid size;

Definition at line 353 of file qstyleoption.h.

Referenced by QMacStyle::drawControl(), operator=(), QCommonStylePrivate::tabLayout(), and QTabBar::tabSizeHint().


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