Home · All Classes · Modules

QDockWidget Class Reference
^{[QtGui module]}

The QDockWidget class provides a widget that can be docked inside a QMainWindow or floated as a top-level window on the desktop. More...

Inherits QWidget.

Types

• enum DockWidgetFeature { DockWidgetClosable, DockWidgetMovable, DockWidgetFloatable, DockWidgetVerticalTitleBar, AllDockWidgetFeatures, NoDockWidgetFeatures }
• class DockWidgetFeatures

Methods

• __init__ (self, QString title, QWidget parent = None, Qt.WindowFlags flags = 0)
• __init__ (self, QWidget parent = None, Qt.WindowFlags flags = 0)
• Qt.DockWidgetAreas allowedAreas (self)
• changeEvent (self, QEvent event)
• closeEvent (self, QCloseEvent event)
• bool event (self, QEvent event)
• DockWidgetFeatures features (self)
• initStyleOption (self, QStyleOptionDockWidget option)
• bool isAreaAllowed (self, Qt.DockWidgetArea area)
• bool isFloating (self)
• paintEvent (self, QPaintEvent event)
• setAllowedAreas (self, Qt.DockWidgetAreas areas)
• setFeatures (self, DockWidgetFeatures features)
• setFloating (self, bool floating)
• setTitleBarWidget (self, QWidget widget)
• setWidget (self, QWidget widget)
• QWidget titleBarWidget (self)
• QAction toggleViewAction (self)
• QWidget widget (self)

Qt Signals

• void allowedAreasChanged (Qt::DockWidgetAreas)
• void dockLocationChanged (Qt::DockWidgetArea)
• void featuresChanged (QDockWidget::DockWidgetFeatures)
• void topLevelChanged (bool)
• void visibilityChanged (bool)

The QDockWidget class provides a widget that can be docked inside a QMainWindow or floated as a top-level window on the desktop.

QDockWidget provides the concept of dock widgets, also know as tool palettes or utility windows. Dock windows are secondary windows placed in the dock widget area around the central widget in a QMainWindow.

Dock windows can be moved inside their current area, moved into new areas and floated (e.g., undocked) by the end-user. The QDockWidget API allows the programmer to restrict the dock widgets ability to move, float and close, as well as the areas in which they can be placed.

A QDockWidget consists of a title bar and the content area. The title bar 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.

A QDockWidget acts as a wrapper for its child widget, set with setWidget(). Custom size hints, minimum and maximum sizes and size policies should be implemented in the child widget. QDockWidget will respect them, adjusting its own constraints to include the frame and title. Size constraints should not be set on the QDockWidget itself, because they change depending on whether it is docked; a docked QDockWidget has no frame and a smaller title bar.

Type Documentation

QDockWidget.DockWidgetFeature

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

Method Documentation

QDockWidget.__init__ (self, QString title, QWidget parent = None, Qt.WindowFlags flags = 0)

The parent argument, if not None, causes self to be owned by Qt instead of PyQt.

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.__init__ (self, QWidget parent = None, Qt.WindowFlags flags = 0)

The parent argument, if not None, causes self to be owned by Qt instead of PyQt.

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

Qt.DockWidgetAreas QDockWidget.allowedAreas (self)

QDockWidget.changeEvent (self, QEvent event)

Reimplemented from QWidget.changeEvent().

QDockWidget.closeEvent (self, QCloseEvent event)

Reimplemented from QWidget.closeEvent().

bool QDockWidget.event (self, QEvent event)

Reimplemented from QObject.event().

DockWidgetFeatures QDockWidget.features (self)

QDockWidget.initStyleOption (self, QStyleOptionDockWidget option)

Initialize option with the values from this QDockWidget. This method is useful for subclasses when they need a QStyleOptionDockWidget, but don't want to fill in all the information themselves.

See also QStyleOption.initFrom().

bool QDockWidget.isAreaAllowed (self, Qt.DockWidgetArea area)

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

bool QDockWidget.isFloating (self)

QDockWidget.paintEvent (self, QPaintEvent event)

Reimplemented from QWidget.paintEvent().

QDockWidget.setAllowedAreas (self, Qt.DockWidgetAreas areas)

QDockWidget.setFeatures (self, DockWidgetFeatures features)

QDockWidget.setFloating (self, bool floating)

QDockWidget.setTitleBarWidget (self, QWidget widget)

The widget argument has it's ownership transferred to Qt.

Sets an arbitrary widget as the dock widget's title bar. If widget is 0, any custom title bar widget previously set on the dock widget is removed, but not deleted, and the default title bar will be used instead.

If a title bar widget is set, QDockWidget will not use native window decorations when it is floated.

Here are some tips for implementing custom title bars:

• Mouse events that are not explicitly handled by the title bar widget must be ignored by calling QMouseEvent.ignore(). These events then propagate to the QDockWidget parent, which handles them in the usual manner, moving when the title bar is dragged, docking and undocking when it is double-clicked, etc.
• When DockWidgetVerticalTitleBar is set on QDockWidget, the title bar widget is repositioned accordingly. In resizeEvent(), the title bar should check what orientation it should assume:

   QDockWidget *dockWidget = qobject_cast<QDockWidget*>(parentWidget());
   if (dockWidget->features() & QDockWidget.DockWidgetVerticalTitleBar) {
       // I need to be vertical
   } else {
       // I need to be horizontal
   }
  

• The title bar widget must have a valid QWidget.sizeHint() and QWidget.minimumSizeHint(). These functions should take into account the current orientation of the title bar.
• It is not possible to remove a title bar from a dock widget. However, a similar effect can be achieved by setting a default constructed QWidget as the title bar widget.

Using qobject_cast() as shown above, the title bar widget has full access to its parent QDockWidget. Hence it can perform such operations as docking and hiding in response to user actions.

This function was introduced in Qt 4.3.

See also titleBarWidget() and DockWidgetVerticalTitleBar.

QDockWidget.setWidget (self, QWidget widget)

The widget argument has it's ownership transferred to Qt.

Sets the widget for the dock widget to widget.

If the dock widget is visible when widget is added, you must show() it explicitly.

Note that you must add the layout of the widget before you call this function; if not, the widget will not be visible.

See also widget().

QWidget QDockWidget.titleBarWidget (self)

Returns the custom title bar widget set on the QDockWidget, or 0 if no custom title bar has been set.

This function was introduced in Qt 4.3.

See also setTitleBarWidget().

QAction QDockWidget.toggleViewAction (self)

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.

QWidget QDockWidget.widget (self)

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

See also setWidget().

Qt Signal Documentation

void allowedAreasChanged (Qt::DockWidgetAreas)

This is the default overload of this signal.

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

void dockLocationChanged (Qt::DockWidgetArea)

This is the default overload of this signal.

This signal is emitted when the dock widget is moved to another dock area, or is moved to a different location in its current dock area. This happens when the dock widget is moved programmatically or is dragged to a new location by the user.

void featuresChanged (QDockWidget::DockWidgetFeatures)

This is the default overload of this signal.

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

void topLevelChanged (bool)

This is the default overload of this 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().

void visibilityChanged (bool)

This is the default overload of this signal.

This signal is emitted when the dock widget becomes visible (or invisible). This happens when the widget is hidden or shown, as well as when it is docked in a tabbed dock area and its tab becomes selected or unselected.