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

#include <qstyleoption.h>

Inheritance 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_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
	QStyleOptionDockWidget ()
	Constructs a QStyleOptionDockWidget, initializing the member variables to their default values. More...

	QStyleOptionDockWidget (const QStyleOptionDockWidget &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)

QStyleOption &	operator= (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	closable
	whether the dock window is closable More...

bool	floatable
	whether the dock window is floatable More...

bool	movable
	whether the dock window is movable More...

QString	title
	the title of the dock window 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
	QStyleOptionDockWidget (int version)

Additional Inherited Members
Related Functions inherited from QStyleOption
T	qstyleoption_cast (const QStyleOption *option)

T	qstyleoption_cast (QStyleOption *option)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. More...

Detailed Description

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

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

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

Definition at line 504 of file qstyleoption.h.

Enumerations

◆ StyleOptionType

enum QStyleOptionDockWidget::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_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 507 of file qstyleoption.h.

507 { Type = SO_DockWidget };

QStyleOption::SO_DockWidget

Definition: qstyleoption.h:73

QStyleOptionDockWidget::Type

Definition: qstyleoption.h:507

◆ StyleOptionVersion

enum QStyleOptionDockWidget::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 508 of file qstyleoption.h.

508 { Version = 1 };

QStyleOptionDockWidget::Version

Definition: qstyleoption.h:508

Constructors and Destructors

◆ QStyleOptionDockWidget() [1/3]

QStyleOptionDockWidget::QStyleOptionDockWidget ( )

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

Definition at line 4163 of file qstyleoption.cpp.

     : QStyleOption(Version, SO_DockWidget), closable(false),
       movable(false), floatable(false)
 {
 }

◆ QStyleOptionDockWidget() [2/3]

QStyleOptionDockWidget::QStyleOptionDockWidget ( const QStyleOptionDockWidget & other )

inline

Constructs a copy of the other style option.

Definition at line 516 of file qstyleoption.h.

516 : QStyleOption(Version, Type) { *this = other; }

QStyleOptionDockWidget::Version

Definition: qstyleoption.h:508

QStyleOption::QStyleOption

QStyleOption(int version=QStyleOption::Version, int type=SO_Default)

Constructs a QStyleOption with the specified version and type.

Definition: qstyleoption.cpp:167

QStyleOptionDockWidget::Type

Definition: qstyleoption.h:507

◆ QStyleOptionDockWidget() [3/3]

QStyleOptionDockWidget::QStyleOptionDockWidget ( int version )

protected

Warning: This function is not part of the public interface.

Definition at line 4172 of file qstyleoption.cpp.

     : QStyleOption(version, SO_DockWidget), closable(false),
       movable(false), floatable(false)
 {
 }

Properties

◆ closable

QStyleOptionDockWidget::closable

whether the dock window is closable

The default value is true.

Definition at line 511 of file qstyleoption.h.

Referenced by QDockWidget::initStyleOption(), QCommonStyle::subElementRect(), and QMacStyle::subElementRect().

◆ floatable

QStyleOptionDockWidget::floatable

whether the dock window is floatable

The default value is true.

Definition at line 513 of file qstyleoption.h.

Referenced by QDockWidget::initStyleOption(), QCommonStyle::subElementRect(), and QMacStyle::subElementRect().

◆ movable

QStyleOptionDockWidget::movable

whether the dock window is movable

The default value is false.

Definition at line 512 of file qstyleoption.h.

Referenced by QDockWidget::initStyleOption().

◆ title

QStyleOptionDockWidget::title

the title of the dock window

The default value is an empty string.

Definition at line 510 of file qstyleoption.h.

Referenced by QPlastiqueStyle::drawComplexControl(), QStyleSheetStyle::drawControl(), and QDockWidget::initStyleOption().

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

/src/gui/styles/qstyleoption.h
/src/gui/styles/qstyleoption.cpp

Public Types

Public Functions

Public Variables

Protected Functions

Additional Inherited Members