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

The QStyleOptionTitleBar class is used to describe the parameters for drawing a title bar. More...

#include <qstyleoption.h>

Inheritance diagram for QStyleOptionTitleBar:
QStyleOptionComplex QStyleOption

Public Types

enum  StyleOptionType { Type = SO_TitleBar }
 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 Types inherited from QStyleOptionComplex
enum  StyleOptionType { Type = SO_Complex }
 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 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

 QStyleOptionTitleBar ()
 Constructs a QStyleOptionTitleBar, initializing the members variables to their default values. More...
 
 QStyleOptionTitleBar (const QStyleOptionTitleBar &other)
 Constructs a copy of the other style option. More...
 
- Public Functions inherited from QStyleOptionComplex
 QStyleOptionComplex (int version=QStyleOptionComplex::Version, int type=SO_Complex)
 Constructs a QStyleOptionComplex of the specified type and version, initializing the member variables to their default values. More...
 
 QStyleOptionComplex (const QStyleOptionComplex &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

QIcon icon
 the icon for the title bar More...
 
QString text
 the text of the title bar More...
 
Qt::WindowFlags titleBarFlags
 the widget flags for the title bar More...
 
int titleBarState
 the state of the title bar More...
 
- Public Variables inherited from QStyleOptionComplex
QStyle::SubControls activeSubControls
 This variable holds a bitwise OR of the sub-controls that are active for the complex control. More...
 
QStyle::SubControls subControls
 This variable holds a bitwise OR of the sub-controls to be drawn for the complex control. 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

 QStyleOptionTitleBar (int version)
 

Additional Inherited Members

Detailed Description

The QStyleOptionTitleBar class is used to describe the parameters for drawing a title bar.

QStyleOptionTitleBar contains all the information that QStyle functions need to draw the title bar of a QMdiSubWindow.

For performance reasons, the access to the member variables is direct (i.e., using the . or -> operator). This low-level feel makes the structures straightforward to use and emphasizes that these are simply parameters used by the style functions.

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

See also
QStyleOption, QStyleOptionComplex, QMdiSubWindow

Definition at line 816 of file qstyleoption.h.

Enumerations

◆ 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_TitleBar 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 819 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 820 of file qstyleoption.h.

Constructors and Destructors

◆ QStyleOptionTitleBar() [1/3]

QStyleOptionTitleBar::QStyleOptionTitleBar ( )

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

Definition at line 5041 of file qstyleoption.cpp.

5043 {
5044 }
Qt::WindowFlags titleBarFlags
the widget flags for the title bar
Definition: qstyleoption.h:825
int titleBarState
the state of the title bar
Definition: qstyleoption.h:824
QStyleOptionComplex(int version=QStyleOptionComplex::Version, int type=SO_Complex)
Constructs a QStyleOptionComplex of the specified type and version, initializing the member variables...

◆ QStyleOptionTitleBar() [2/3]

QStyleOptionTitleBar::QStyleOptionTitleBar ( const QStyleOptionTitleBar other)
inline

Constructs a copy of the other style option.

Definition at line 828 of file qstyleoption.h.

828 : QStyleOptionComplex(Version, Type) { *this = other; }
QStyleOptionComplex(int version=QStyleOptionComplex::Version, int type=SO_Complex)
Constructs a QStyleOptionComplex of the specified type and version, initializing the member variables...

◆ QStyleOptionTitleBar() [3/3]

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

Definition at line 5095 of file qstyleoption.cpp.

5097 {
5098 }
int version
the version of the style option
Definition: qstyleoption.h:86
Qt::WindowFlags titleBarFlags
the widget flags for the title bar
Definition: qstyleoption.h:825
int titleBarState
the state of the title bar
Definition: qstyleoption.h:824
QStyleOptionComplex(int version=QStyleOptionComplex::Version, int type=SO_Complex)
Constructs a QStyleOptionComplex of the specified type and version, initializing the member variables...

Properties

◆ icon

QStyleOptionTitleBar::icon

the icon for the title bar

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

Definition at line 823 of file qstyleoption.h.

Referenced by QWorkspaceTitleBar::initStyleOption(), QDecorationStyled::paint(), QDecorationStyled::region(), QDecorationStyled::titleBarHeight(), and QMdiSubWindowPrivate::titleBarOptions().

◆ text

QStyleOptionTitleBar::text

◆ titleBarFlags

QStyleOptionTitleBar::titleBarFlags

◆ titleBarState

QStyleOptionTitleBar::titleBarState

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