diff options
| author | Axel Spoerl <axel.spoerl@qt.io> | 2022-03-28 18:09:15 +0200 |
|---|---|---|
| committer | Axel Spoerl <axel.spoerl@qt.io> | 2022-04-19 19:12:20 +0200 |
| commit | 87762234a7de535935da29358a669d134266ae6a (patch) | |
| tree | aa8b82bc4619ab883980eaef464e47a404edfae0 /src/corelib/global/qnamespace.qdoc | |
| parent | 9ff40b59da58160dc26c54204a615a2456e07405 (diff) | |
Update documentation of enum Qt::DockWidgetArea
Describe enum usage in QDockWidget::isAreaAllowed() as well as meaning
of enum members.
Pick-to: 6.3 6.2 5.15
Change-Id: Ib88509feb001be27c11fd167c9009da50ce1b851
Reviewed-by: Volker Hilsheimer <volker.hilsheimer@qt.io>
Diffstat (limited to 'src/corelib/global/qnamespace.qdoc')
| -rw-r--r-- | src/corelib/global/qnamespace.qdoc | 16 |
1 files changed, 10 insertions, 6 deletions
diff --git a/src/corelib/global/qnamespace.qdoc b/src/corelib/global/qnamespace.qdoc index 59a479d3d4..2bb93f4663 100644 --- a/src/corelib/global/qnamespace.qdoc +++ b/src/corelib/global/qnamespace.qdoc @@ -798,14 +798,18 @@ /*! \enum Qt::DockWidgetArea - \value LeftDockWidgetArea - \value RightDockWidgetArea - \value TopDockWidgetArea - \value BottomDockWidgetArea - \value AllDockWidgetAreas - \value NoDockWidgetArea + Represents the areas a QDockWidget can be plugged to. + \note A floating dock widget with tabs can be docked anywhere. + + \value LeftDockWidgetArea The left dock area of a QMainWindow. + \value RightDockWidgetArea The right dock area of a QMainWindow. + \value TopDockWidgetArea The top dock area of a QMainWindow. + \value BottomDockWidgetArea The bottom dock area of a QMainWindow. + \value AllDockWidgetAreas All dock widget areas (default). + \value NoDockWidgetArea No dock widget areas. \omitvalue DockWidgetArea_Mask + \sa QDockWidget::setAllowedAreas, QDockWidget::isAreaAllowed */ /*! |