QDockWidget Class Reference
^{[QtGui module]}

Appearance

A QDockWidget consists of a title bar and the content area. The titlebar displays the dock widgets window title, a float button and a close button. Depending on the state of the QDockWidget, the float and close buttons may be either disabled or not shown at all.

The visual appearance of the title bar and buttons is dependent on the style in use.

See also QMainWindow and Dock Widgets Example.

Member Type Documentation

enum QDockWidget::DockWidgetFeature
flags QDockWidget::DockWidgetFeatures

The DockWidgetFeatures type is a typedef for QFlags<DockWidgetFeature>. It stores an OR combination of DockWidgetFeature values.

Property Documentation

allowedAreas : Qt::DockWidgetAreas

This property holds areas where the dock widget may be placed.

The default is Qt::AllDockWidgetAreas.

Access functions:

• Qt::DockWidgetAreas allowedAreas () const
• void setAllowedAreas ( Qt::DockWidgetAreas areas )

See also Qt::DockWidgetArea.

features : DockWidgetFeatures

This property holds whether the dock widget is movable, closable, and floatable.

Access functions:

• DockWidgetFeatures features () const
• void setFeatures ( DockWidgetFeatures features )

See also DockWidgetFeature.

floating : bool

This property holds whether the dock widget is floating.

A floating dock widget is presented to the user as an independent window "on top" of its parent QMainWindow, instead of being docked in the QMainWindow.

Access functions:

• bool isFloating () const
• void setFloating ( bool floating )

See also isWindow().

Member Function Documentation

QDockWidget::QDockWidget ( const QString & title, QWidget * parent = 0, Qt::WindowFlags flags = 0 )

Constructs a QDockWidget with parent parent and window flags flags. The dock widget will be placed in the left dock widget area.

The window title is set to title. This title is used when the QDockWidget is docked and undocked. It is also used in the context menu provided by QMainWindow.

See also setWindowTitle().

QDockWidget::QDockWidget ( QWidget * parent = 0, Qt::WindowFlags flags = 0 )

Constructs a QDockWidget with parent parent and window flags flags. The dock widget will be placed in the left dock widget area.

QDockWidget::~QDockWidget ()

Destroys the dock widget.

void QDockWidget::allowedAreasChanged ( Qt::DockWidgetAreas allowedAreas )   [signal]

This signal is emitted when the allowedAreas property changes. The allowedAreas parameter gives the new value of the property.

void QDockWidget::featuresChanged ( QDockWidget::DockWidgetFeatures features )   [signal]

This signal is emitted when the features property changes. The features parameter gives the new value of the property.

bool QDockWidget::isAreaAllowed ( Qt::DockWidgetArea area ) const

Returns true if this dock widget can be placed in the given area; otherwise returns false.

void QDockWidget::setWidget ( QWidget * widget )

Sets the widget for the dock widget to widget.

See also widget().

QAction * QDockWidget::toggleViewAction () const

Returns a checkable action that can be used to show or close this dock widget.

The action's text is set to the dock widget's window title.

See also QAction::text and QWidget::windowTitle.

void QDockWidget::topLevelChanged ( bool topLevel )   [signal]

This signal is emitted when the floating property changes. The topLevel parameter is true if the dock widget is now floating; otherwise it is false.

See also isWindow().

QWidget * QDockWidget::widget () const

Returns the widget for the dock widget. This function returns zero if the widget has not been set.

See also setWidget().