Qt
Internal/Contributor docs for the Qt SDK. Note: These are NOT official API docs; those are found at https://doc.qt.io/
Loading...
Searching...
No Matches
QStyleOptionTitleBar Class Reference

\variable QStyleOptionToolBox::selectedPosition More...

#include <qstyleoption.h>

Inheritance diagram for QStyleOptionTitleBar:
Collaboration diagram for QStyleOptionTitleBar:

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_DockWidget , SO_ViewItem , SO_TabWidgetFrame ,
  SO_TabBarBase , SO_RubberBand , SO_ToolBar , SO_GraphicsItem ,
  SO_Complex = 0xf0000 , SO_Slider , SO_SpinBox , SO_ToolButton ,
  SO_ComboBox , 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 Member Functions

 QStyleOptionTitleBar ()
 Constructs a QStyleOptionTitleBar, initializing the members variables to their default values.
 QStyleOptionTitleBar (const QStyleOptionTitleBar &other)
 Constructs a copy of the other style option.
QStyleOptionTitleBaroperator= (const QStyleOptionTitleBar &)=default
Public Member 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.
 QStyleOptionComplex (const QStyleOptionComplex &other)
 Constructs a copy of the other style option.
QStyleOptionComplexoperator= (const QStyleOptionComplex &)=default
Public Member Functions inherited from QStyleOption
 QStyleOption (int version=QStyleOption::Version, int type=SO_Default)
 Constructs a QStyleOption with the specified version and type.
 QStyleOption (const QStyleOption &other)
 Constructs a copy of other.
 ~QStyleOption ()
 Destroys this style option object.
void initFrom (const QWidget *w)
QStyleOptionoperator= (const QStyleOption &other)
 Assign other to this QStyleOption.

Public Attributes

QString text
QIcon icon
int titleBarState
Qt::WindowFlags titleBarFlags
Public Attributes inherited from QStyleOptionComplex
QStyle::SubControls subControls
QStyle::SubControls activeSubControls
Public Attributes inherited from QStyleOption
int version
int type
QStyle::State state
Qt::LayoutDirection direction
QRect rect
QFontMetrics fontMetrics
QPalette palette
QObjectstyleObject

Protected Member Functions

 QStyleOptionTitleBar (int version)

Additional Inherited Members

Detailed Description

\variable QStyleOptionToolBox::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.

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

\inmodule QtWidgets

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

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

See also
QStyleOption, QStyleOptionComplex, QMdiSubWindow

Definition at line 614 of file qstyleoption.h.

Member Enumeration Documentation

◆ StyleOptionType

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

\value Type The type of style option provided (\l{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 617 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.

\value 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 618 of file qstyleoption.h.

Constructor & Destructor Documentation

◆ QStyleOptionTitleBar() [1/3]

QStyleOptionTitleBar::QStyleOptionTitleBar ( )

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

Definition at line 2862 of file qstyleoption.cpp.

◆ QStyleOptionTitleBar() [2/3]

QStyleOptionTitleBar::QStyleOptionTitleBar ( const QStyleOptionTitleBar & other)
inline

Constructs a copy of the other style option.

Definition at line 626 of file qstyleoption.h.

◆ QStyleOptionTitleBar() [3/3]

QStyleOptionTitleBar::QStyleOptionTitleBar ( int version)
protected

Definition at line 2907 of file qstyleoption.cpp.

Member Function Documentation

◆ operator=()

QStyleOptionTitleBar & QStyleOptionTitleBar::operator= ( const QStyleOptionTitleBar & )
default

Member Data Documentation

◆ icon

QIcon QStyleOptionTitleBar::icon

Definition at line 621 of file qstyleoption.h.

◆ text

QString QStyleOptionTitleBar::text

Definition at line 620 of file qstyleoption.h.

◆ titleBarFlags

Qt::WindowFlags QStyleOptionTitleBar::titleBarFlags

Definition at line 623 of file qstyleoption.h.

◆ titleBarState

int QStyleOptionTitleBar::titleBarState

Definition at line 622 of file qstyleoption.h.


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