aboutsummaryrefslogtreecommitdiffstats
path: root/src/quickcontrols/doc/src/qtquickcontrols-containers.qdoc
blob: 08d91f294f1558332b1275bba86b1f880429d788 (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
// Copyright (C) 2017 The Qt Company Ltd.
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only

/*!
    \page qtquickcontrols-containers.html
    \title Container Controls
    \ingroup qtquickcontrols-guidelines
    \brief Guidelines for container controls

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

    \annotatedlist qtquickcontrols-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 qtquickcontrols-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 qtquickcontrols-frame.png

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

    \section1 GroupBox Control

    \image qtquickcontrols-groupbox.png

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

    \section1 Page Control

    \image qtquickcontrols-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 qtquickcontrols-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 ScrollView Control

    \image qtquickcontrols-scrollview-wireframe.png

    \l ScrollView provides scrolling for user-defined content.

    \section1 StackView Control

    \image qtquickcontrols-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 qtquickcontrols-swipeview-wireframe.png

    \l SwipeView organizes content pages into a swipable strip.

    \section1 TabBar Control

    \image qtquickcontrols-tabbar-wireframe.png

    \l TabBar organizes content pages into tabs.

    \section1 ToolBar Control

    \image qtquickcontrols-toolbar.png

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