aboutsummaryrefslogtreecommitdiffstats
path: root/src/imports/controls/doc/src/qtquickcontrols2-navigation.qdoc
blob: f157fb85b63d50f78ffd3cf3b262ebd32f29c3c0 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
/****************************************************************************
**
** Copyright (C) 2017 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 qtquickcontrols2-navigation.html
    \title Navigation Controls
    \ingroup qtquickcontrols2-guidelines
    \brief Guidelines for navigation controls

    Qt Quick Controls 2 offers a selection of navigation models.

    \annotatedlist qtquickcontrols2-navigation

    The following sections offer guidelines for choosing the appropriate type
    of navigation model, depending on the use case.

    \section1 StackView Control

    \image qtquickcontrols2-stackview-wireframe.png

    \l StackView provides a stack-based navigation model which can be used
    with a set of interlinked pages. StackView works according to a last-in
    first-out principle: the page pushed last on the stack is the one visible.
    Popping a page removes the last page and makes the previous one visible.

    \section1 SwipeView Control

    \image qtquickcontrols2-swipeview-wireframe.png

    \l SwipeView provides a navigation model that simplifies horizontal paged
    scrolling. The page indicator on the bottom shows which is the presently
    active page.

    \section1 TabBar

    \image qtquickcontrols2-tabbar-wireframe.png

    \l TabBar is a bar with icons or text that allows the user to switch
    between different subtasks, views, or modes.

    \section1 TabButton Control

    \image qtquickcontrols2-tabbutton.png

    \l TabButton is a button with a layout suitable for a TabBar control.
*/