|
Home · All Classes · Main Classes · Grouped Classes · Modules · Functions | |
The QDockWidget class provides a widget that can be docked inside a QMainWindow or floated as a top-level window on the desktop. More...
#include <QDockWidget>
Inherits QWidget.
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 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.
| Constant | Value | Description |
|---|---|---|
| QDockWidget::DockWidgetClosable | 0x01 | The dock widget can be closed. |
| QDockWidget::DockWidgetMovable | 0x02 | The dock widget can be moved between docks by the user. |
| QDockWidget::DockWidgetFloatable | 0x04 | The dock widget can be detached from the main window, and floated as an independent window. |
| QDockWidget::AllDockWidgetFeatures | DockWidgetFeatureMask | The dock widget can be closed, moved, and floated. |
| QDockWidget::NoDockWidgetFeatures | 0x00 | The dock widget cannot be closed, moved, or floated. |
The DockWidgetFeatures type is a typedef for QFlags<DockWidgetFeature>. It stores an OR combination of DockWidgetFeature values.
This property holds areas where the dock widget may be placed.
The default is Qt::AllDockWidgetAreas.
Access functions:
See also Qt::DockWidgetArea.
This property holds whether the dock widget is movable, closable, and floatable.
Access functions:
See also DockWidgetFeature.
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:
See also isWindow().
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().
Constructs a QDockWidget with parent parent and window flags flags. The dock widget will be placed in the left dock widget area.
Destroys the dock widget.
This signal is emitted when the allowedAreas property changes. The allowedAreas parameter gives the new value of the property.
This signal is emitted when the features property changes. The features parameter gives the new value of the property.
Returns true if this dock widget can be placed in the given area; otherwise returns false.
Sets the widget for the dock widget to widget.
See also widget().
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.
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().
Returns the widget for the dock widget. This function returns zero if the widget has not been set.
See also setWidget().
| Copyright © 2007 Trolltech | Trademarks | Qt 4.2.3 |