CopperSpice API  1.8.2
QDockWidget Class Reference

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

Inheritance diagram for QDockWidget:
QWidget QObject QPaintDevice

Public Typedefs

using DockWidgetFeatures = QFlags< DockWidgetFeature >
- Public Typedefs inherited from QWidget
using RenderFlags = QFlags< RenderFlag >

Public Types

enum  DockWidgetFeature
- Public Types inherited from QWidget
enum  RenderFlag
- Public Types inherited from QPaintDevice
enum  PaintDeviceMetric

Public Signals

void allowedAreasChanged (Qt::DockWidgetAreas allowedAreas)
void dockLocationChanged (Qt::DockWidgetArea area)
void featuresChanged (QDockWidget::DockWidgetFeatures features)
void topLevelChanged (bool topLevel)
void visibilityChanged (bool visible)
- Public Signals inherited from QWidget
void customContextMenuRequested (const QPoint &pos)
void windowIconChanged (const QIcon &icon)
void windowIconTextChanged (const QString &iconText)
void windowTitleChanged (const QString &title)
- Public Signals inherited from QObject
void destroyed (QObject *obj=nullptr)
void objectNameChanged (const QString &objectName)

Public Methods

 QDockWidget (const QString &title, QWidget *parent=nullptr, Qt::WindowFlags flags=Qt::EmptyFlag)
 QDockWidget (QWidget *parent=nullptr, Qt::WindowFlags flags=Qt::EmptyFlag)
 ~QDockWidget ()
Qt::DockWidgetAreas allowedAreas () const
DockWidgetFeatures features () const
bool isAreaAllowed (Qt::DockWidgetArea area) const
bool isFloating () const
void setAllowedAreas (Qt::DockWidgetAreas areas)
void setFeatures (DockWidgetFeatures features)
void setFloating (bool floating)
void setTitleBarWidget (QWidget *widget)
void setWidget (QWidget *widget)
QWidgettitleBarWidget () const
QActiontoggleViewAction () const
QWidgetwidget () const
- Public Methods inherited from QWidget
 QWidget (QWidget *parent=nullptr, Qt::WindowFlags flags=Qt::EmptyFlag)
 ~QWidget ()
bool acceptDrops () const
QString accessibleDescription () const
QString accessibleName () const
QList< QAction * > actions () const
void activateWindow ()
void addAction (QAction *action)
void addActions (const QList< QAction * > &actions)
void adjustSize ()
bool autoFillBackground () const
QPalette::ColorRole backgroundRole () const
QBackingStorebackingStore () const
QSize baseSize () const
QWidget * childAt (const QPoint &position) const
QWidget * childAt (int x, int y) const
QRect childrenRect () const
QRegion childrenRegion () const
void clearFocus ()
void clearMask ()
QMargins contentsMargins () const
QRect contentsRect () const
Qt::ContextMenuPolicy contextMenuPolicy () const
QCursor cursor () const
WId effectiveWinId () const
void ensurePolished () const
Qt::FocusPolicy focusPolicy () const
QWidget * focusProxy () const
QWidget * focusWidget () const
const QFontfont () const
QFontInfo fontInfo () const
QFontMetrics fontMetrics () const
QPalette::ColorRole foregroundRole () const
QRect frameGeometry () const
QSize frameSize () const
const QRectgeometry () const
void getContentsMargins (int *left, int *top, int *right, int *bottom) const
QPixmap grab (const QRect &rectangle=QRect (QPoint (0, 0), QSize (-1,-1)))
void grabGesture (Qt::GestureType gestureType, Qt::GestureFlags flags=Qt::GestureFlags ())
void grabKeyboard ()
void grabMouse ()
void grabMouse (const QCursor &cursor)
int grabShortcut (const QKeySequence &key, Qt::ShortcutContext context=Qt::WindowShortcut)
QGraphicsEffectgraphicsEffect () const
QGraphicsProxyWidgetgraphicsProxyWidget () const
bool hasEditFocus () const
bool hasFocus () const
virtual bool hasHeightForWidth () const
bool hasMouseTracking () const
int height () const
virtual int heightForWidth (int width) const
Qt::InputMethodHints inputMethodHints () const
virtual QVariant inputMethodQuery (Qt::InputMethodQuery query) const
void insertAction (QAction *before, QAction *action)
void insertActions (QAction *before, QList< QAction * > actions)
bool isActiveWindow () const
bool isAncestorOf (const QWidget *child) const
bool isEnabled () const
bool isEnabledTo (const QWidget *parent) const
bool isEnabledToTLW () const
bool isFullScreen () const
bool isHidden () const
bool isMaximized () const
bool isMinimized () const
bool isModal () const
bool isTopLevel () const
bool isVisible () const
bool isVisibleTo (const QWidget *parent) const
bool isWindow () const
bool isWindowModified () const
QLayoutlayout () const
Qt::LayoutDirection layoutDirection () const
QLocale locale () const
QPoint mapFrom (const QWidget *parent, const QPoint &pos) const
QPoint mapFromGlobal (const QPoint &pos) const
QPoint mapFromParent (const QPoint &pos) const
QPoint mapTo (const QWidget *parent, const QPoint &pos) const
QPoint mapToGlobal (const QPoint &pos) const
QPoint mapToParent (const QPoint &pos) const
QRegion mask () const
int maximumHeight () const
QSize maximumSize () const
int maximumWidth () const
int minimumHeight () const
QSize minimumSize () const
virtual QSize minimumSizeHint () const
int minimumWidth () const
void move (const QPoint &point)
void move (int x, int y)
QWidget * nativeParentWidget () const
QWidget * nextInFocusChain () const
QRect normalGeometry () const
void overrideWindowFlags (Qt::WindowFlags flags)
QPaintEnginepaintEngine () const override
const QPalettepalette () const
QWidget * parentWidget () const
QPoint pos () const
QWidget * previousInFocusChain () const
QRect rect () const
void releaseKeyboard ()
void releaseMouse ()
void releaseShortcut (int id)
void removeAction (QAction *action)
void render (QPaintDevice *target, const QPoint &targetOffset=QPoint (), const QRegion &sourceRegion=QRegion (), RenderFlags renderFlags=RenderFlags (DrawWindowBackground|DrawChildren))
void render (QPainter *painter, const QPoint &targetOffset=QPoint (), const QRegion &sourceRegion=QRegion (), RenderFlags renderFlags=RenderFlags (DrawWindowBackground|DrawChildren))
void repaint (const QRect &rect)
void repaint (const QRegion &region)
void repaint (int x, int y, int w, int h)
void resize (const QSize &size)
void resize (int w, int h)
bool restoreGeometry (const QByteArray &geometry)
QByteArray saveGeometry () const
void scroll (int dx, int dy)
void scroll (int dx, int dy, const QRect &rect)
void setAcceptDrops (bool on)
void setAccessibleDescription (const QString &description)
void setAccessibleName (const QString &name)
void setAttribute (Qt::WidgetAttribute attribute, bool enable=true)
void setAutoFillBackground (bool enable)
void setBackgroundRole (QPalette::ColorRole role)
void setBaseSize (const QSize &size)
void setBaseSize (int basew, int baseh)
void setContentsMargins (const QMargins &margins)
void setContentsMargins (int left, int top, int right, int bottom)
void setContextMenuPolicy (Qt::ContextMenuPolicy policy)
void setCursor (const QCursor &cursor)
void setEditFocus (bool enable)
void setFixedHeight (int h)
void setFixedSize (const QSize &size)
void setFixedSize (int w, int h)
void setFixedWidth (int w)
void setFocus (Qt::FocusReason reason)
void setFocusPolicy (Qt::FocusPolicy policy)
void setFocusProxy (QWidget *widget)
void setFont (const QFont &font)
void setForegroundRole (QPalette::ColorRole role)
void setGeometry (const QRect &rect)
void setGeometry (int x, int y, int w, int h)
void setGraphicsEffect (QGraphicsEffect *effect)
void setInputMethodHints (Qt::InputMethodHints hints)
void setLayout (QLayout *layout)
void setLayoutDirection (Qt::LayoutDirection direction)
void setLocale (const QLocale &locale)
void setMask (const QBitmap &bitmap)
void setMask (const QRegion &region)
void setMaximumHeight (int maxh)
void setMaximumSize (const QSize &size)
void setMaximumSize (int maxw, int maxh)
void setMaximumWidth (int maxw)
void setMinimumHeight (int minh)
void setMinimumSize (const QSize &size)
void setMinimumSize (int minw, int minh)
void setMinimumWidth (int minw)
void setMouseTracking (bool enable)
void setPalette (const QPalette &palette)
void setParent (QWidget *parent)
void setParent (QWidget *parent, Qt::WindowFlags flags)
void setShortcutAutoRepeat (int id, bool enable=true)
void setShortcutEnabled (int id, bool enable=true)
void setSizeIncrement (const QSize &size)
void setSizeIncrement (int w, int h)
void setSizePolicy (QSizePolicy policy)
void setSizePolicy (QSizePolicy::Policy horizontal, QSizePolicy::Policy vertical)
void setStatusTip (const QString &data)
void setStyle (QStyle *style)
void setToolTip (const QString &data)
void setToolTipDuration (int msec)
void setUpdatesEnabled (bool enable)
void setWhatsThis (const QString &str)
void setWindowFilePath (const QString &filePath)
void setWindowFlags (Qt::WindowFlags flags)
void setWindowIcon (const QIcon &icon)
void setWindowModality (Qt::WindowModality windowModality)
void setWindowOpacity (qreal level)
void setWindowRole (const QString &role)
void setWindowState (Qt::WindowStates windowState)
QSize size () const
virtual QSize sizeHint () const
QSize sizeIncrement () const
QSizePolicy sizePolicy () const
void stackUnder (QWidget *widget)
QString statusTip () const
QStylestyle () const
QString styleSheet () const
bool testAttribute (Qt::WidgetAttribute attribute) const
QString toolTip () const
int toolTipDuration () const
QWidget * topLevelWidget () const
bool underMouse () const
void ungrabGesture (Qt::GestureType gestureType)
void unsetCursor ()
void unsetLayoutDirection ()
void unsetLocale ()
void update (const QRect &rect)
void update (const QRegion &region)
void update (int x, int y, int w, int h)
void updateGeometry ()
bool updatesEnabled () const
QRegion visibleRegion () const
QString whatsThis () const
int width () const
QWidget * window () const
QString windowFilePath () const
Qt::WindowFlags windowFlags () const
QWindowwindowHandle () const
QIcon windowIcon () const
Qt::WindowModality windowModality () const
qreal windowOpacity () const
QString windowRole () const
Qt::WindowStates windowState () const
QString windowTitle () const
Qt::WindowType windowType () const
WId winId () const
int x () const
int y () const
- Public Methods inherited from QObject
 QObject (QObject *parent=nullptr)
 ~QObject ()
bool blockSignals (bool block)
const QList< QObject * > & children () const
bool connect (const QObject *sender, const QString &signalMethod, const QString &location, const QString &slotMethod, Qt::ConnectionType type=Qt::AutoConnection)
bool connect (const QObject *sender, const QString &signalMethod, const QString &slotMethod, Qt::ConnectionType type=Qt::AutoConnection)
bool disconnect (const QObject *receiver, const QString &slotMethod=QString ()) const
bool disconnect (const QString &signalMethod, const QString &location, const QObject *receiver=nullptr, const QString &slotMethod=QString ()) const
bool disconnect (const QString &signalMethod=QString (), const QObject *receiver=nullptr, const QString &slotMethod=QString ()) const
void dumpObjectInfo ()
void dumpObjectTree ()
QList< QStringdynamicPropertyNames () const
virtual bool event (QEvent *event)
virtual bool eventFilter (QObject *watched, QEvent *event)
template<typename T >
findChild (const QString &childName=QString ()) const
template<class T >
QList< T > findChildren (const QRegularExpression &regExp, Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
template<class T >
QList< T > findChildren (const QString &childName=QString (), Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
bool inherits (const QString &className) const
void installEventFilter (QObject *filterObj)
bool isWidgetType () const
bool isWindowType () const
void killTimer (int id)
const QMetaObjectmetaObject () const
void moveToThread (QThread *targetThread)
QString objectName () const
QObject * parent () const
template<class T = QVariant>
property (const QString &name) const
void removeEventFilter (QObject *obj)
void setObjectName (const QString &name)
void setParent (QObject *parent)
bool setProperty (const QString &name, const QVariant &value)
bool signalsBlocked () const
int startTimer (int interval, Qt::TimerType timerType=Qt::CoarseTimer)
QThreadthread () const
- Public Methods inherited from QPaintDevice
virtual ~QPaintDevice ()
int colorCount () const
int depth () const
int devicePixelRatio () const
qreal devicePixelRatioF () const
int height () const
int heightMM () const
int logicalDpiX () const
int logicalDpiY () const
bool paintingActive () const
int physicalDpiX () const
int physicalDpiY () const
int width () const
int widthMM () const

Protected Methods

void changeEvent (QEvent *event) override
void closeEvent (QCloseEvent *event) override
bool event (QEvent *event) override
void initStyleOption (QStyleOptionDockWidget *option) const
void paintEvent (QPaintEvent *event) override
- Protected Methods inherited from QWidget
virtual void actionEvent (QActionEvent *event)
virtual void contextMenuEvent (QContextMenuEvent *event)
void create (WId window=0, bool initializeWindow=true, bool destroyOldWindow=true)
void destroy (bool destroyWindow=true, bool destroySubWindows=true)
virtual void dragEnterEvent (QDragEnterEvent *event)
virtual void dragLeaveEvent (QDragLeaveEvent *event)
virtual void dragMoveEvent (QDragMoveEvent *event)
virtual void dropEvent (QDropEvent *event)
virtual void enterEvent (QEvent *event)
bool event (QEvent *event) override
virtual void focusInEvent (QFocusEvent *event)
bool focusNextChild ()
virtual bool focusNextPrevChild (bool next)
virtual void focusOutEvent (QFocusEvent *event)
bool focusPreviousChild ()
virtual void hideEvent (QHideEvent *event)
void initPainter (QPainter *painter) const override
virtual void inputMethodEvent (QInputMethodEvent *event)
virtual void keyPressEvent (QKeyEvent *event)
virtual void keyReleaseEvent (QKeyEvent *event)
virtual void leaveEvent (QEvent *event)
int metric (PaintDeviceMetric metric) const override
virtual void mouseDoubleClickEvent (QMouseEvent *event)
virtual void mouseMoveEvent (QMouseEvent *event)
virtual void mousePressEvent (QMouseEvent *event)
virtual void mouseReleaseEvent (QMouseEvent *event)
virtual void moveEvent (QMoveEvent *event)
virtual bool nativeEvent (const QByteArray &eventType, void *message, long *result)
virtual void resizeEvent (QResizeEvent *event)
virtual void showEvent (QShowEvent *event)
virtual void tabletEvent (QTabletEvent *event)
virtual void wheelEvent (QWheelEvent *event)
- Protected Methods inherited from QObject
virtual void childEvent (QChildEvent *event)
virtual void connectNotify (const QMetaMethod &signalMethod) const
virtual void customEvent (QEvent *event)
virtual void disconnectNotify (const QMetaMethod &signalMethod) const
bool isSignalConnected (const QMetaMethod &signalMethod) const
int receivers (const QString &signal) const
QObject * sender () const
int senderSignalIndex () const
virtual void timerEvent (QTimerEvent *event)
- Protected Methods inherited from QPaintDevice
 QPaintDevice ()


- Properties inherited from QWidget
- Properties inherited from QObject

Additional Inherited Members

- Public Slots inherited from QWidget
bool close ()
void hide ()
void lower ()
void raise ()
void repaint ()
void setDisabled (bool disable)
void setEnabled (bool enable)
void setFocus ()
void setHidden (bool hidden)
void setStyleSheet (const QString &styleSheet)
virtual void setVisible (bool visible)
void setWindowModified (bool modified)
void setWindowTitle (const QString &title)
void show ()
void showFullScreen ()
void showMaximized ()
void showMinimized ()
void showNormal ()
void update ()
- Public Slots inherited from QObject
void deleteLater ()
- Static Public Methods inherited from QWidget
static QWidget * createWindowContainer (QWindow *window, QWidget *parent=nullptr, Qt::WindowFlags flags=Qt::EmptyFlag)
static QWidget * find (WId id)
static QWidget * keyboardGrabber ()
static QWidget * mouseGrabber ()
static void setTabOrder (QWidget *firstWidget, QWidget *secondWidget)
- Static Public Methods inherited from QObject
static bool connect (const QObject *sender, const QMetaMethod &signalMethod, const QObject *receiver, const QMetaMethod &slotMethod, Qt::ConnectionType type=Qt::AutoConnection)
static bool connect (const QObject *sender, const QString &signalMethod, const QObject *receiver, const QString &slotMethod, Qt::ConnectionType type=Qt::AutoConnection, const QString &location=QString ())
static bool connect (const QObject *sender, const QString &signalMethod, const QString &location, const QObject *receiver, const QString &slotMethod, Qt::ConnectionType type=Qt::AutoConnection)
template<class Sender , class SignalClass , class... SignalArgs, class Receiver , class SlotClass , class... SlotArgs, class SlotReturn >
static bool connect (const Sender *sender, void (SignalClass::*signalMethod)(SignalArgs...), const Receiver *receiver, SlotReturn (SlotClass::*slotMethod)(SlotArgs...), Qt::ConnectionType type=Qt::AutoConnection)
template<class Sender , class SignalClass , class... SignalArgs, class Receiver , class T >
static bool connect (const Sender *sender, void (SignalClass::*signalMethod)(SignalArgs...), const Receiver *receiver, T slotLambda, Qt::ConnectionType type=Qt::AutoConnection)
static bool disconnect (const QObject *sender, const QMetaMethod &signalMethod, const QObject *receiver, const QMetaMethod &slotMethod)
static bool disconnect (const QObject *sender, const QString &signalMethod, const QObject *receiver, const QString &slotMethod)
static bool disconnect (const QObject *sender, const QString &signalMethod, const QString &location, const QObject *receiver, const QString &slotMethod)
static bool disconnect (const QObject *sender, std::nullptr_t, const QObject *receiver, std::nullptr_t)
template<class Sender , class SignalClass , class... SignalArgs, class Receiver , class SlotClass , class... SlotArgs, class SlotReturn >
static bool disconnect (const Sender *sender, void (SignalClass::*signalMethod)(SignalArgs...), const Receiver *receiver, SlotReturn (SlotClass::*slotMethod)(SlotArgs...))
template<class Sender , class SignalClass , class... SignalArgs, class Receiver >
static bool disconnect (const Sender *sender, void (SignalClass::*signalMethod)(SignalArgs...), const Receiver *receiver, std::nullptr_t slotMethod=nullptr)
template<class Sender , class SignalClass , class... SignalArgs, class Receiver , class T >
static bool disconnect (const Sender *sender, void (SignalClass::*signalMethod)(SignalArgs...), const Receiver *receiver, T slotMethod)
static QMetaObjectstaticMetaObject ()
static QString tr (const char *text, const char *comment=nullptr, std::optional< int > numArg=std::optional< int >())
- Protected Slots inherited from QWidget
void updateMicroFocus ()

Detailed Description

The QDockWidget class provides a widget that can be docked inside a QMainWindow or floated as a top-level window. This class 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.

See also

Member Typedef Documentation

Member Enumeration Documentation

QDockWidget::DockWidgetClosable0x01 Dock widget can be closed. On some systems the dock widget always has a close button when it is floating.
QDockWidget::DockWidgetMovable0x02 Dock widget can be moved between docks by the user.
QDockWidget::DockWidgetFloatable0x04 Dock widget can be detached from the main window, and floated as an independent window.
QDockWidget::DockWidgetVerticalTitleBar0x08 Dock widget displays a vertical title bar on the left side. This can be used to increase the amount of vertical space in a QMainWindow.
QDockWidget::AllDockWidgetFeatures DockWidgetClosable |
DockWidgetMovable  |
(Deprecated) Dock widget can be closed, moved, and floated. Since new features might be added in future releases, be aware the look and behavior of dock widgets might change, prefer individual flags
QDockWidget::NoDockWidgetFeatures0x00 Dock widget can not be closed, moved, or floated.

Constructor & Destructor Documentation

QDockWidget::QDockWidget ( const QString title,
QWidget parent = nullptr,
Qt::WindowFlags  flags = Qt::EmptyFlag 

Constructs a QDockWidget with parent and window 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
QDockWidget::QDockWidget ( QWidget parent = nullptr,
Qt::WindowFlags  flags = Qt::EmptyFlag 

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

QDockWidget::~QDockWidget ( )

Destroys the dock widget.

Method Documentation

Qt::DockWidgetAreas QDockWidget::allowedAreas ( ) const

Returns the value of the property.

void QDockWidget::allowedAreasChanged ( Qt::DockWidgetAreas  allowedAreas)

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

void QDockWidget::changeEvent ( QEvent event)

Reimplemented from QWidget::changeEvent()

void QDockWidget::closeEvent ( QCloseEvent event)

Reimplemented from QWidget::closeEvent()

void QDockWidget::dockLocationChanged ( Qt::DockWidgetArea  area)

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.

bool QDockWidget::event ( QEvent event)

Reimplemented from QWidget::event()

DockWidgetFeatures QDockWidget::features ( ) const

Returns the value of the property.

void QDockWidget::featuresChanged ( QDockWidget::DockWidgetFeatures  features)

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

void QDockWidget::initStyleOption ( QStyleOptionDockWidget option) const

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

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

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

bool QDockWidget::isFloating ( ) const

Returns the value of the property.

void QDockWidget::paintEvent ( QPaintEvent event)

Reimplemented from QWidget::paintEvent()

void QDockWidget::setAllowedAreas ( Qt::DockWidgetAreas  areas)

Sets the value of the property to areas.

void QDockWidget::setFeatures ( DockWidgetFeatures  features)

Sets the value of the property to features.

void QDockWidget::setFloating ( bool  floating)

Sets the value of the property to floating.

void QDockWidget::setTitleBarWidget ( QWidget widget)

Sets an arbitrary widget as the dock widget's title bar. If widget is a nullptr then any custom title bar widget previously set on the dock widget is removed but not deleted. In addition, the default title bar will be used instead. If a title bar widget is set then 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 the QDockWidget is set to the enum value of DockWidgetVerticalTitleBar the the title bar widget is repositioned. The resizeEvent() method should check the title bar orientation.

    QDockWidget *dockWidget = dynamic_cast<QDockWidget*>(parentWidget());
    if (dockWidget->features() & QDockWidget::DockWidgetFeature::DockWidgetVerticalTitleBar) {
    // vertical
    } else {
    // horizontal
  • The title bar widget must have a valid QWidget::sizeHint() and QWidget::minimumSizeHint(). These methods 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.
See also
titleBarWidget(), QDockWidget::DockWidgetFeature
void QDockWidget::setWidget ( QWidget widget)

Sets the widget for the dock widget to widget. If the dock widget is visible when widget is added, you must show() it explicitly. You must add the layout of the widget before you call this function; if not, the widget will not be visible.

See also
QWidget * QDockWidget::titleBarWidget ( ) const

Returns the custom title bar widget set on the QDockWidget or a nullptr if no custom title bar has been set.

See also
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, QWidget::windowTitle
void QDockWidget::topLevelChanged ( bool  topLevel)

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
void QDockWidget::visibilityChanged ( bool  visible)

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.

QWidget * QDockWidget::widget ( ) const

Returns the widget for the dock widget. This method returns a nullptr if the widget has not been set.

See also

Property Documentation


This property holds areas where the dock widget may be placed. The default is Qt::AllDockWidgetAreas.

See also
PropertiesClass Methods
read allowedAreas
write setAllowedAreas
notify allowedAreasChanged

This property holds whether the dock widget is movable, closable, and floatable. By default, this property is set to a combination of DockWidgetClosable, DockWidgetMovable and DockWidgetFloatable.

See also
PropertiesClass Methods
read features
write setFeatures
notify featuresChanged

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.

By default, this property is true.

See also
PropertiesClass Methods
read isFloating
write setFloating

This property holds the dock widget title (caption). By default, this property contains an empty string.

PropertiesClass Methods
read windowTitle
write setWindowTitle
designable true