diff options
| author | Jan Arve Sæther <jan-arve.saether@qt.io> | 2021-09-28 10:54:22 +0200 |
|---|---|---|
| committer | Jan Arve Sæther <jan-arve.saether@qt.io> | 2021-10-21 17:33:58 +0200 |
| commit | 803749e324adf33652642ed38abe92572d0a89b9 (patch) | |
| tree | 7ff511175078801d5721f062518bdd9db95e4241 /src/quicklayouts | |
| parent | c699225822e7ad111cc0827d00694b697e6d1a72 (diff) | |
Doc: Add references to the overview pages from each layout type
Previously, it only pointed from the overview pages down to the
individual layout types, and not vice-versa.
Pick-to: 6.2
Change-Id: Ic86e0e4e713ec00e582dc0a0a4a95903d53dac03
Reviewed-by: Samuel Ghinet <samuel.ghinet@qt.io>
Reviewed-by: Venugopal Shivashankar <Venugopal.Shivashankar@qt.io>
Diffstat (limited to 'src/quicklayouts')
| -rw-r--r-- | src/quicklayouts/qquicklinearlayout.cpp | 18 | ||||
| -rw-r--r-- | src/quicklayouts/qquickstacklayout.cpp | 5 |
2 files changed, 22 insertions, 1 deletions
diff --git a/src/quicklayouts/qquicklinearlayout.cpp b/src/quicklayouts/qquicklinearlayout.cpp index fc00691820..c7b0e66e04 100644 --- a/src/quicklayouts/qquicklinearlayout.cpp +++ b/src/quicklayouts/qquicklinearlayout.cpp @@ -53,6 +53,10 @@ \ingroup layouts \brief Identical to \l GridLayout, but having only one row. + To be able to use this type more efficiently, it is recommended that you + understand the general mechanism of the Qt Quick Layouts module. Refer to + \l{Qt Quick Layouts Overview} for more information. + It is available as a convenience for developers, as it offers a cleaner API. Items in a RowLayout support these attached properties: @@ -96,7 +100,9 @@ Read more about attached properties \l{QML Object Attributes}{here}. \sa ColumnLayout \sa GridLayout + \sa StackLayout \sa Row + \sa {Qt Quick Layouts Overview} */ /*! @@ -107,6 +113,10 @@ \ingroup layouts \brief Identical to \l GridLayout, but having only one column. + To be able to use this type more efficiently, it is recommended that you + understand the general mechanism of the Qt Quick Layouts module. Refer to + \l{Qt Quick Layouts Overview} for more information. + It is available as a convenience for developers, as it offers a cleaner API. Items in a ColumnLayout support these attached properties: @@ -148,7 +158,9 @@ \sa RowLayout \sa GridLayout + \sa StackLayout \sa Column + \sa {Qt Quick Layouts Overview} */ @@ -160,7 +172,9 @@ \ingroup layouts \brief Provides a way of dynamically arranging items in a grid. - + To be able to use this type more efficiently, it is recommended that you + understand the general mechanism of the Qt Quick Layouts module. Refer to + \l{Qt Quick Layouts Overview} for more information. If the GridLayout is resized, all items in the layout will be rearranged. It is similar to the widget-based QGridLayout. All visible children of the GridLayout element will belong to @@ -212,7 +226,9 @@ \sa RowLayout \sa ColumnLayout + \sa StackLayout \sa Grid + \sa {Qt Quick Layouts Overview} */ diff --git a/src/quicklayouts/qquickstacklayout.cpp b/src/quicklayouts/qquickstacklayout.cpp index 19d0033e8b..434f387b3d 100644 --- a/src/quicklayouts/qquickstacklayout.cpp +++ b/src/quicklayouts/qquickstacklayout.cpp @@ -52,6 +52,10 @@ \brief The StackLayout class provides a stack of items where only one item is visible at a time. + To be able to use this type more efficiently, it is recommended that you + understand the general mechanism of the Qt Quick Layouts module. Refer to + \l{Qt Quick Layouts Overview} for more information. + The current visible item can be modified by setting the \l currentIndex property. The index corresponds to the order of the StackLayout's children. @@ -98,6 +102,7 @@ \sa GridLayout \sa RowLayout \sa {QtQuick.Controls::StackView}{StackView} + \sa {Qt Quick Layouts Overview} */ QT_BEGIN_NAMESPACE |