aboutsummaryrefslogtreecommitdiffstats
path: root/src/templates
diff options
context:
space:
mode:
authorJ-P Nurmi <jpnurmi@theqtcompany.com>2015-10-15 17:14:58 +0200
committerJ-P Nurmi <jpnurmi@theqtcompany.com>2015-10-19 16:52:48 +0000
commit3ab62aed45e32120ba10ec972b92b5dcc79e527d (patch)
treeeed0fd7e4bc77d1919614fc27eab30637b0f3ea4 /src/templates
parent0cf9d77f849a2b10e8eaa696e1254e5c3c50d5f5 (diff)
Docs: Navigation group
Change-Id: Id866d226fc651a39fffd887600b4bf54d2b7ac6e Reviewed-by: Mitch Curtis <mitch.curtis@theqtcompany.com>
Diffstat (limited to 'src/templates')
-rw-r--r--src/templates/qquickstackview.cpp5
-rw-r--r--src/templates/qquickswipeview.cpp4
-rw-r--r--src/templates/qquicktabbar.cpp46
-rw-r--r--src/templates/qquicktabbutton.cpp16
4 files changed, 19 insertions, 52 deletions
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) :