diff options
author | J-P Nurmi <jpnurmi@theqtcompany.com> | 2015-10-15 17:14:58 +0200 |
---|---|---|
committer | J-P Nurmi <jpnurmi@theqtcompany.com> | 2015-10-19 16:52:48 +0000 |
commit | 3ab62aed45e32120ba10ec972b92b5dcc79e527d (patch) | |
tree | eed0fd7e4bc77d1919614fc27eab30637b0f3ea4 /src | |
parent | 0cf9d77f849a2b10e8eaa696e1254e5c3c50d5f5 (diff) |
Docs: Navigation group
Change-Id: Id866d226fc651a39fffd887600b4bf54d2b7ac6e
Reviewed-by: Mitch Curtis <mitch.curtis@theqtcompany.com>
Diffstat (limited to 'src')
-rw-r--r-- | src/imports/controls/doc/images/qtlabscontrols-stackview-wireframe.png | bin | 0 -> 646 bytes | |||
-rw-r--r-- | src/imports/controls/doc/images/qtlabscontrols-tabbar-wireframe.png | bin | 0 -> 609 bytes | |||
-rw-r--r-- | src/imports/controls/doc/images/qtlabscontrols-tabbar.png | bin | 0 -> 3635 bytes | |||
-rw-r--r-- | src/imports/controls/doc/images/qtlabscontrols-tabbutton.png | bin | 0 -> 3727 bytes | |||
-rw-r--r-- | src/imports/controls/doc/src/qtlabscontrols-navigation.qdoc | 59 | ||||
-rw-r--r-- | src/templates/qquickstackview.cpp | 5 | ||||
-rw-r--r-- | src/templates/qquickswipeview.cpp | 4 | ||||
-rw-r--r-- | src/templates/qquicktabbar.cpp | 46 | ||||
-rw-r--r-- | src/templates/qquicktabbutton.cpp | 16 |
9 files changed, 78 insertions, 52 deletions
diff --git a/src/imports/controls/doc/images/qtlabscontrols-stackview-wireframe.png b/src/imports/controls/doc/images/qtlabscontrols-stackview-wireframe.png Binary files differnew file mode 100644 index 00000000..65704c25 --- /dev/null +++ b/src/imports/controls/doc/images/qtlabscontrols-stackview-wireframe.png diff --git a/src/imports/controls/doc/images/qtlabscontrols-tabbar-wireframe.png b/src/imports/controls/doc/images/qtlabscontrols-tabbar-wireframe.png Binary files differnew file mode 100644 index 00000000..443f6757 --- /dev/null +++ b/src/imports/controls/doc/images/qtlabscontrols-tabbar-wireframe.png diff --git a/src/imports/controls/doc/images/qtlabscontrols-tabbar.png b/src/imports/controls/doc/images/qtlabscontrols-tabbar.png Binary files differnew file mode 100644 index 00000000..e3f9d3cd --- /dev/null +++ b/src/imports/controls/doc/images/qtlabscontrols-tabbar.png diff --git a/src/imports/controls/doc/images/qtlabscontrols-tabbutton.png b/src/imports/controls/doc/images/qtlabscontrols-tabbutton.png Binary files differnew file mode 100644 index 00000000..1e2948f1 --- /dev/null +++ b/src/imports/controls/doc/images/qtlabscontrols-tabbutton.png diff --git a/src/imports/controls/doc/src/qtlabscontrols-navigation.qdoc b/src/imports/controls/doc/src/qtlabscontrols-navigation.qdoc new file mode 100644 index 00000000..639bb139 --- /dev/null +++ b/src/imports/controls/doc/src/qtlabscontrols-navigation.qdoc @@ -0,0 +1,59 @@ +/**************************************************************************** +** +** Copyright (C) 2015 The Qt Company Ltd. +** Contact: http://www.qt.io/licensing/ +** +** This file is part of the documentation of the Qt Toolkit. +** +** $QT_BEGIN_LICENSE:FDL$ +** Commercial License Usage +** Licensees holding valid commercial Qt licenses may use this file in +** accordance with the commercial license agreement provided with the +** Software or, alternatively, in accordance with the terms contained in +** a written agreement between you and The Qt Company. For licensing terms +** and conditions see http://www.qt.io/terms-conditions. For further +** information use the contact form at http://www.qt.io/contact-us. +** +** GNU Free Documentation License Usage +** Alternatively, this file may be used under the terms of the GNU Free +** Documentation License version 1.3 as published by the Free Software +** Foundation and appearing in the file included in the packaging of +** this file. Please review the following information to ensure +** the GNU Free Documentation License version 1.3 requirements +** will be met: http://www.gnu.org/copyleft/fdl.html. +** $QT_END_LICENSE$ +** +****************************************************************************/ + +/*! + \page qtlabscontrols-navigation.html + \title Navigation + + Qt Labs Controls offers a selection of navigation models. + + \annotatedlist qtlabscontrols-navigation + + The following sections offer guidelines for choosing the appropriate type + of navigation model, depending on the use case. + + \section1 StackView + + \image qtlabscontrols-stackview-wireframe.png + + \l {Qt.labs.controls::StackView}{StackView} provides a stack-based navigation + model. + + \section1 SwipeView + + \image qtlabscontrols-swipeview-wireframe.png + + \l {Qt.labs.controls::SwipeView}{SwipeView} provides a swipe-based navigation + model. + + \section1 TabBar and TabButton + + \image qtlabscontrols-tabbar-wireframe.png + + \l {Qt.labs.controls::TabBar}{TabBar} and \l {Qt.labs.controls::TabButton}{TabButton} + provide a tab-based navigation model. +*/ diff --git a/src/templates/qquickstackview.cpp b/src/templates/qquickstackview.cpp index 169e62cc..8fbff8f7 100644 --- a/src/templates/qquickstackview.cpp +++ b/src/templates/qquickstackview.cpp @@ -48,9 +48,11 @@ QT_BEGIN_NAMESPACE \inherits Control \instantiates QQuickStackView \inqmlmodule Qt.labs.controls - \ingroup navigation + \ingroup qtlabscontrols-navigation \brief Provides a stack-based navigation model. + \image qtlabscontrols-stackview-wireframe.png + StackView can be used with a set of inter-linked information pages. For example, an email application with separate views to list latest emails, view a specific email, and list/view the attachments. The email list view @@ -254,6 +256,7 @@ QT_BEGIN_NAMESPACE } \endqml + \sa {Customizing StackView}, Navigation */ QQuickStackView::QQuickStackView(QQuickItem *parent) : diff --git a/src/templates/qquickswipeview.cpp b/src/templates/qquickswipeview.cpp index 2163ba61..bbe51f52 100644 --- a/src/templates/qquickswipeview.cpp +++ b/src/templates/qquickswipeview.cpp @@ -45,7 +45,7 @@ QT_BEGIN_NAMESPACE \inherits Container \instantiates QQuickSwipeView \inqmlmodule Qt.labs.controls - \ingroup navigation + \ingroup qtlabscontrols-navigation \brief A swipe view control. SwipeView provides a swipe-based navigation model. @@ -66,7 +66,7 @@ QT_BEGIN_NAMESPACE \l {Container::moveItem()}{move}, and \l {Container::removeItem()}{remove} pages dynamically at run time. - \sa TabBar, PageIndicator, {Customizing SwipeView} + \sa TabBar, PageIndicator, {Customizing SwipeView}, Navigation */ class QQuickSwipeViewPrivate : public QQuickContainerPrivate diff --git a/src/templates/qquicktabbar.cpp b/src/templates/qquicktabbar.cpp index 8c958fc7..5eaf9f83 100644 --- a/src/templates/qquicktabbar.cpp +++ b/src/templates/qquicktabbar.cpp @@ -45,50 +45,20 @@ QT_BEGIN_NAMESPACE \inherits Container \instantiates QQuickTabBar \inqmlmodule Qt.labs.controls - \ingroup tabs + \ingroup qtlabscontrols-navigation \brief A tab bar control. - TabBar provides a tab-based navigation model. TabBar is populated with - TabButton controls, and can be used together with any layout or container - control that provides \c currentIndex -property, such as \l StackLayout - or \l SwipeView + TabBar provides a tab-based navigation model. - ### TODO: screenshot + \image qtlabscontrols-tabbar-wireframe.png - \code - ApplicationWindow { - visible:true + TabBar is populated with TabButton controls, and can be used together with + any layout or container control that provides \c currentIndex -property, + such as \l StackLayout or \l SwipeView - header: TabBar { - id: bar - TabButton { - text: qsTr("Home") - } - TabButton { - text: qsTr("Discover") - } - TabButton { - text: qsTr("Activity") - } - } - - StackLayout { - anchors.fill: parent - currentIndex: bar.currentIndex - Item { - id: homeTab - } - Item { - id: discoverTab - } - Item { - id: activityTab - } - } - } - \endcode + \snippet qtlabscontrols-tabbar.qml 1 - \sa TabButton, {Customizing TabBar} + \sa TabButton, {Customizing TabBar}, Navigation */ class QQuickTabBarPrivate : public QQuickContainerPrivate diff --git a/src/templates/qquicktabbutton.cpp b/src/templates/qquicktabbutton.cpp index baf6c04f..e1ee6a9e 100644 --- a/src/templates/qquicktabbutton.cpp +++ b/src/templates/qquicktabbutton.cpp @@ -43,22 +43,16 @@ QT_BEGIN_NAMESPACE \inherits AbstractButton \instantiates QQuickTabButton \inqmlmodule Qt.labs.controls - \ingroup tabs + \ingroup qtlabscontrols-navigation \brief A tab button control. - TabButton is used in conjunction with a \l TabBar. + \image qtlabscontrols-tabbutton.png - ### TODO: screenshot + TabButton is used in conjunction with a \l TabBar. - \code - TabBar { - TabButton { text: qsTr("Home") } - TabButton { text: qsTr("Discover") } - TabButton { text: qsTr("Activity") } - } - \endcode + \snippet qtlabscontrols-tabbutton.qml 1 - \sa TabBar, {Customizing TabButton} + \sa TabBar, {Customizing TabButton}, Navigation */ QQuickTabButton::QQuickTabButton(QQuickItem *parent) : |