QDockWidget: Clarify documentation of floating property

QDockWidget::isFloating() returns true for single, floating dock
widgets. It returns false, if the dock widget is part of a floating
tab (i.e. it is a QDockWidgetGroupWindow child).

=> Clarify documentation.

Pick-to: 6.7 6.6 6.5
Change-Id: I3c5a4a86b89dcb001e7561de7dcc604bae0d9cee
Reviewed-by: Volker Hilsheimer <volker.hilsheimer@qt.io>
This commit is contained in:
Axel Spoerl 2023-12-04 10:32:25 +01:00
parent c697e19c16
commit 92b5992a29

View File

@ -1434,9 +1434,12 @@ QDockWidget::DockWidgetFeatures QDockWidget::features() const
\property QDockWidget::floating
\brief 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.
A floating dock widget is presented to the user as a single, independent
window "on top" of its parent QMainWindow, instead of being docked
either in the QMainWindow, or in a group of tabbed dock widgets.
Floating dock widgets can be individually positioned and resized, both
programmatically or by mouse interaction.
By default, this property is \c true.