diff options
author | J-P Nurmi <jpnurmi@theqtcompany.com> | 2015-10-15 18:16:01 +0200 |
---|---|---|
committer | J-P Nurmi <jpnurmi@theqtcompany.com> | 2015-10-19 16:52:53 +0000 |
commit | a7fafb16931792be3d57ee41b1afc46a1350c5f8 (patch) | |
tree | c8542151302c3523b7867c612ef3f612a95e01c6 /src/templates | |
parent | 3ab62aed45e32120ba10ec972b92b5dcc79e527d (diff) |
Docs: Containers group
Change-Id: I5eb80f21edb50413b33a96b934466964e56462aa
Reviewed-by: Mitch Curtis <mitch.curtis@theqtcompany.com>
Diffstat (limited to 'src/templates')
-rw-r--r-- | src/templates/qquickapplicationwindow.cpp | 6 | ||||
-rw-r--r-- | src/templates/qquickcontainer.cpp | 3 | ||||
-rw-r--r-- | src/templates/qquickframe.cpp | 17 | ||||
-rw-r--r-- | src/templates/qquickgroupbox.cpp | 20 | ||||
-rw-r--r-- | src/templates/qquickstackview.cpp | 3 | ||||
-rw-r--r-- | src/templates/qquickswipeview.cpp | 3 | ||||
-rw-r--r-- | src/templates/qquicktabbar.cpp | 3 | ||||
-rw-r--r-- | src/templates/qquicktoolbar.cpp | 8 |
8 files changed, 27 insertions, 36 deletions
diff --git a/src/templates/qquickapplicationwindow.cpp b/src/templates/qquickapplicationwindow.cpp index cb56bddf..b668d0e1 100644 --- a/src/templates/qquickapplicationwindow.cpp +++ b/src/templates/qquickapplicationwindow.cpp @@ -46,13 +46,17 @@ QT_BEGIN_NAMESPACE \inherits Window \instantiates QQuickApplicationWindow \inqmlmodule Qt.labs.controls - \ingroup application + \ingroup qtlabscontrols-containers \brief Provides a top-level application window. ApplicationWindow is a \l Window which makes it convenient to add a \l header and \l footer item to the window. + \image qtlabscontrols-applicationwindow-wireframe.png + \note By default, an ApplicationWindow is not visible. + + \sa Containers */ class QQuickApplicationWindowPrivate : public QQuickItemChangeListener diff --git a/src/templates/qquickcontainer.cpp b/src/templates/qquickcontainer.cpp index f4653027..aeba8ecd 100644 --- a/src/templates/qquickcontainer.cpp +++ b/src/templates/qquickcontainer.cpp @@ -44,9 +44,12 @@ QT_BEGIN_NAMESPACE \inherits Control \instantiates QQuickContainer \inqmlmodule Qt.labs.controls + \ingroup qtlabscontrols-containers \brief A container control base type. Container is the base type of container-like user interface controls. + + \sa Containers */ QQuickContainerPrivate::QQuickContainerPrivate() : contentModel(Q_NULLPTR), currentIndex(-1) diff --git a/src/templates/qquickframe.cpp b/src/templates/qquickframe.cpp index 7dafa8c5..04837b79 100644 --- a/src/templates/qquickframe.cpp +++ b/src/templates/qquickframe.cpp @@ -44,7 +44,7 @@ QT_BEGIN_NAMESPACE \inherits Control \instantiates QQuickFrame \inqmlmodule Qt.labs.controls - \ingroup containers + \ingroup qtlabscontrols-containers \brief A frame control. Frame is used to layout a logical group of controls together, within a @@ -56,20 +56,11 @@ QT_BEGIN_NAMESPACE implicit size of its contained item. This makes it particularly suitable for use together with layouts. - ### TODO: screenshot + \image qtlabscontrols-frame.png - \code - Frame { - ColumnLayout { - anchors.fill: parent - CheckBox { text: qsTr("E-mail") } - CheckBox { text: qsTr("Calendar") } - CheckBox { text: qsTr("Contacts") } - } - } - \endcode + \snippet qtlabscontrols-frame.qml 1 - \sa {Customizing Frame} + \sa {Customizing Frame}, Containers */ QQuickFramePrivate::QQuickFramePrivate() : contentWidth(0), contentHeight(0), frame(Q_NULLPTR) diff --git a/src/templates/qquickgroupbox.cpp b/src/templates/qquickgroupbox.cpp index 30cede12..21f81b15 100644 --- a/src/templates/qquickgroupbox.cpp +++ b/src/templates/qquickgroupbox.cpp @@ -44,7 +44,7 @@ QT_BEGIN_NAMESPACE \inherits Frame \instantiates QQuickGroupBox \inqmlmodule Qt.labs.controls - \ingroup containers + \ingroup qtlabscontrols-containers \brief A group box control. GroupBox is used to layout a logical group of controls together, within @@ -56,21 +56,11 @@ QT_BEGIN_NAMESPACE implicit size of its contained item. This makes it particularly suitable for use together with layouts. - ### TODO: screenshot - - \code - GroupBox { - title: qsTr("Synchronize") - ColumnLayout { - anchors.fill: parent - CheckBox { text: qsTr("E-mail") } - CheckBox { text: qsTr("Calendar") } - CheckBox { text: qsTr("Contacts") } - } - } - \endcode + \image qtlabscontrols-groupbox.png - \sa {Customizing GroupBox} + \snippet qtlabscontrols-groupbox.qml 1 + + \sa {Customizing GroupBox}, Containers */ class QQuickGroupBoxPrivate : public QQuickFramePrivate diff --git a/src/templates/qquickstackview.cpp b/src/templates/qquickstackview.cpp index 8fbff8f7..19ca9916 100644 --- a/src/templates/qquickstackview.cpp +++ b/src/templates/qquickstackview.cpp @@ -49,6 +49,7 @@ QT_BEGIN_NAMESPACE \instantiates QQuickStackView \inqmlmodule Qt.labs.controls \ingroup qtlabscontrols-navigation + \ingroup qtlabscontrols-containers \brief Provides a stack-based navigation model. \image qtlabscontrols-stackview-wireframe.png @@ -256,7 +257,7 @@ QT_BEGIN_NAMESPACE } \endqml - \sa {Customizing StackView}, Navigation + \sa {Customizing StackView}, Navigation, Containers */ QQuickStackView::QQuickStackView(QQuickItem *parent) : diff --git a/src/templates/qquickswipeview.cpp b/src/templates/qquickswipeview.cpp index bbe51f52..ec949a03 100644 --- a/src/templates/qquickswipeview.cpp +++ b/src/templates/qquickswipeview.cpp @@ -46,6 +46,7 @@ QT_BEGIN_NAMESPACE \instantiates QQuickSwipeView \inqmlmodule Qt.labs.controls \ingroup qtlabscontrols-navigation + \ingroup qtlabscontrols-containers \brief A swipe view control. SwipeView provides a swipe-based navigation model. @@ -66,7 +67,7 @@ QT_BEGIN_NAMESPACE \l {Container::moveItem()}{move}, and \l {Container::removeItem()}{remove} pages dynamically at run time. - \sa TabBar, PageIndicator, {Customizing SwipeView}, Navigation + \sa TabBar, PageIndicator, {Customizing SwipeView}, Navigation, Containers */ class QQuickSwipeViewPrivate : public QQuickContainerPrivate diff --git a/src/templates/qquicktabbar.cpp b/src/templates/qquicktabbar.cpp index 5eaf9f83..f859ae3c 100644 --- a/src/templates/qquicktabbar.cpp +++ b/src/templates/qquicktabbar.cpp @@ -46,6 +46,7 @@ QT_BEGIN_NAMESPACE \instantiates QQuickTabBar \inqmlmodule Qt.labs.controls \ingroup qtlabscontrols-navigation + \ingroup qtlabscontrols-containers \brief A tab bar control. TabBar provides a tab-based navigation model. @@ -58,7 +59,7 @@ QT_BEGIN_NAMESPACE \snippet qtlabscontrols-tabbar.qml 1 - \sa TabButton, {Customizing TabBar}, Navigation + \sa TabButton, {Customizing TabBar}, Navigation, Containers */ class QQuickTabBarPrivate : public QQuickContainerPrivate diff --git a/src/templates/qquicktoolbar.cpp b/src/templates/qquicktoolbar.cpp index 256a6856..a1c06317 100644 --- a/src/templates/qquicktoolbar.cpp +++ b/src/templates/qquicktoolbar.cpp @@ -43,7 +43,7 @@ QT_BEGIN_NAMESPACE \inherits Frame \instantiates QQuickToolBar \inqmlmodule Qt.labs.controls - \ingroup containers + \ingroup qtlabscontrols-containers \brief A tool bar control. ToolBar is a container of application-wide and context sensitive @@ -57,7 +57,7 @@ QT_BEGIN_NAMESPACE implicit size of its contained item. This makes it particularly suitable for use together with layouts. - ### TODO: screenshot + \image qtlabscontrols-toolbar.png \code ApplicationWindow { @@ -67,7 +67,7 @@ QT_BEGIN_NAMESPACE RowLayout { anchors.fill: parent ToolButton { - text: qsTr("< %1").arg(Qt.application.name) + text: qsTr("\u25C0 %1").arg(Qt.application.name) enabled: stack.depth > 1 onClicked: stack.pop() } @@ -86,7 +86,7 @@ QT_BEGIN_NAMESPACE } \endcode - \sa ApplicationWindow, ToolButton, {Customizing ToolBar} + \sa ApplicationWindow, ToolButton, {Customizing ToolBar}, Containers */ QQuickToolBar::QQuickToolBar(QQuickItem *parent) : |