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
QStyleOptionDockWidget Class Reference

\variable QStyleOptionComplex::subControls More...

#include <qstyleoption.h>

Inheritance diagram for QStyleOptionDockWidget:
Collaboration diagram for QStyleOptionDockWidget:

Public Types

enum  StyleOptionType { Type = SO_DockWidget }
 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

 QStyleOptionDockWidget ()
 Constructs a QStyleOptionDockWidget, initializing the member variables to their default values.
 QStyleOptionDockWidget (const QStyleOptionDockWidget &other)
 Constructs a copy of the other style option.
QStyleOptionDockWidgetoperator= (const QStyleOptionDockWidget &)=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 title
bool closable
bool movable
bool floatable
bool verticalTitleBar
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

 QStyleOptionDockWidget (int version)

Additional Inherited Members

Detailed Description

\variable QStyleOptionComplex::subControls

This variable holds a bitwise OR of the \l{QStyle::SubControl} {sub-controls} to be drawn for the complex control.

The default value is QStyle::SC_All.

See also
QStyle::SubControl

\variable QStyleOptionComplex::activeSubControls

This variable holds a bitwise OR of the \l{QStyle::SubControl} {sub-controls} that are active for the complex control.

The default value is QStyle::SC_None.

See also
QStyle::SubControl

The QStyleOptionDockWidget class is used to describe the parameters for drawing a dock widget.

\inmodule QtWidgets

QStyleOptionDockWidget contains all the information that QStyle functions need to draw graphical elements like QDockWidget.

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

Definition at line 378 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_DockWidget} 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 381 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 2

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

Constructor & Destructor Documentation

◆ QStyleOptionDockWidget() [1/3]

QStyleOptionDockWidget::QStyleOptionDockWidget ( )

Constructs a QStyleOptionDockWidget, initializing the member variables to their default values.

Definition at line 2250 of file qstyleoption.cpp.

◆ QStyleOptionDockWidget() [2/3]

QStyleOptionDockWidget::QStyleOptionDockWidget ( const QStyleOptionDockWidget & other)
inline

Constructs a copy of the other style option.

Definition at line 391 of file qstyleoption.h.

◆ QStyleOptionDockWidget() [3/3]

QStyleOptionDockWidget::QStyleOptionDockWidget ( int version)
protected

Definition at line 2258 of file qstyleoption.cpp.

Member Function Documentation

◆ operator=()

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

Member Data Documentation

◆ closable

bool QStyleOptionDockWidget::closable

Definition at line 385 of file qstyleoption.h.

◆ floatable

bool QStyleOptionDockWidget::floatable

Definition at line 387 of file qstyleoption.h.

◆ movable

bool QStyleOptionDockWidget::movable

Definition at line 386 of file qstyleoption.h.

◆ title

QString QStyleOptionDockWidget::title

Definition at line 384 of file qstyleoption.h.

◆ verticalTitleBar

bool QStyleOptionDockWidget::verticalTitleBar

Definition at line 388 of file qstyleoption.h.


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