aboutsummaryrefslogtreecommitdiffstats
path: root/src/imports/controls/doc/src/qtquickcontrols2-containers.qdoc
blob: d19cff5a3e020811115c224e168c9f2207a90607 (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
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
/****************************************************************************
**
** 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 qtquickcontrols2-containers.html
    \title Container Controls
    \ingroup qtquickcontrols2-guidelines
    \brief Guidelines for container controls

    Qt Quick Controls 2 offers a selection of container-like controls.

    \annotatedlist qtquickcontrols2-containers

    Each type of container can be used to group a set of controls together.
    The following sections offer guidelines for choosing the appropriate type
    of container, depending on the use case.

    \section1 ApplicationWindow Control

    \image qtquickcontrols2-applicationwindow-wireframe.png

    \l ApplicationWindow creates the root window of an application, and makes
    it easy to add an optional header and footer to that window.

    \section1 Frame Control

    \image qtquickcontrols2-frame.png

    \l Frame is used to layout a logical group of controls together, within
    a visual frame.

    \section1 GroupBox Control

    \image qtquickcontrols2-groupbox.png

    \l GroupBox is used to layout a logical group of controls together,
    within a titled visual frame.

    \section1 Page Control

    \image qtquickcontrols2-page-wireframe.png

    \l Page provides page-specific header and footer items.
    It is perfectly possible to use ApplicationWindow for setting the header
    and the footer, but if you have a header and footer which varies per
    screen, then it is better to use \l Page.

    \section1 Pane Control

    \image qtquickcontrols2-pane.png

    \l Pane provides a background color that matches with the application
    style and theme. Pane does not provide a layout of its own, but requires
    you to position its contents, for instance by using a \l RowLayout or
    a \l ColumnLayout.

    \section1 StackView Control

    \image qtquickcontrols2-stackview-wireframe.png

    \l StackView organizes content pages into a stack using a last-in-first-out
    principle: the last item to be "pushed" onto the stack is the first one to
    be removed, and the top-most item is always the one that is visible.

    \section1 SwipeView Control

    \image qtquickcontrols2-swipeview-wireframe.png

    \l SwipeView organizes content pages into a swipable strip.

    \section1 TabBar Control

    \image qtquickcontrols2-tabbar-wireframe.png

    \l TabBar organizes content pages into tabs.

    \section1 ToolBar Control

    \image qtquickcontrols2-toolbar.png

    \l ToolBar is a container of application-wide and context-sensitive
    actions and controls.
*/