1berry/qtbase
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Harden internal documentation of QDockWidgetGroupWindow

Browse Source 
QDockWidgetGroupWindow was documented by a few lines of code comments,
omitting the most critical part of its design: It must not become able
to acquire focus (i.e. be dragged or dropped) while having only one
QDockWidget child.

=> replace legacy code comments by structured internal documentation.

Pick-to: 6.5
Change-Id: I410ebf2e4c20c7479038417a4d8448dce8ab995f
Reviewed-by: Volker Hilsheimer <volker.hilsheimer@qt.io>
(cherry picked from commit 3591ea900b720ff48aace14cd81c8ec9d22b5c73)
Reviewed-by: Qt Cherry-pick Bot <cherrypick_bot@qt-project.org>
This commit is contained in:
Axel Spoerl 2023-12-04 09:18:44 +01:00 committed by Qt Cherry-pick Bot
parent b5f5af3543
commit ccca14cdd8
1 changed files with 34 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

44
src/widgets/widgets/qmainwindowlayout.cpp
View File

@ -153,16 +153,40 @@ QDebug operator<<(QDebug debug, const QMainWindowLayout *layout)
#endif // QT_CONFIG(dockwidget) && !defined(QT_NO_DEBUG) #endif // QT_CONFIG(dockwidget) && !defined(QT_NO_DEBUG)
/******************************************************************************
** QDockWidgetGroupWindow /*!
*/ \internal
// QDockWidgetGroupWindow is the floating window containing several QDockWidgets floating together. QDockWidgetGroupWindow is a floating window, containing several QDockWidgets floating together.
// (QMainWindow::GroupedDragging feature) This requires QMainWindow::GroupedDragging to be enabled.
// QDockWidgetGroupLayout is the layout of that window and use a QDockAreaLayoutInfo to layout QDockWidgets floating jointly in a QDockWidgetGroupWindow are considered to be docked.
// the QDockWidgets inside it. Their \c isFloating property is \c false.
// If there is only one QDockWidgets, or all QDockWidgets are tabbed together, it is equivalent QDockWidget children of a QDockWidgetGroupWindow are either:
// of a floating QDockWidget (the title of the QDockWidget is the title of the window). But if there \list
// are nested QDockWidget, an additional title bar is there. \li tabbed (as long as Qt is compiled with the \c tabbar feature), or
\li arranged next to each other, equivalent to the default on a main window dock.
\endlist
QDockWidgetGroupWindow uses QDockWidgetGroupLayout to lay out its QDockWidget children.
It stores layout information in a QDockAreaLayoutInfo, including temporary spacer items
and rubber bands.
If its QDockWidget children are tabbed, the QDockWidgetGroupWindow shows the active QDockWidget's
title as its own window title.
QDockWidgetGroupWindow is designed to hold more than one QDockWidget.
A QDockWidgetGroupWindow with only one QDockWidget child may occur only temporarily
\list
\li in its construction phase, or
\li during a hover: While QDockWidget A is hovered over B, B is converted into a QDockWidgetGroupWindow.
\endlist
A QDockWidgetGroupWindow with only one QDockWidget child must never get focus, be dragged or dropped.
To enforce this restriction, QDockWidgetGrouWindow will remove itself after its second QDockWidget
child has been removed. It will make its last QDockWidget child a single, floating QDockWidget.
Eventually, the empty QDockWidgetGroupWindow will call deleteLater() on itself.
*/
#if QT_CONFIG(dockwidget) #if QT_CONFIG(dockwidget)
class QDockWidgetGroupLayout : public QLayout, class QDockWidgetGroupLayout : public QLayout,
public QMainWindowLayoutSeparatorHelper<QDockWidgetGroupLayout> public QMainWindowLayoutSeparatorHelper<QDockWidgetGroupLayout>