Qt
Internal/Contributor docs for the Qt SDK. Note: These are NOT official API docs; those are found at https://doc.qt.io/
Loading...
Searching...
No Matches
qtquickcontrols-containers.qdoc
Go to the documentation of this file.
1// Copyright (C) 2017 The Qt Company Ltd.
2// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only
3
4/*!
5 \page qtquickcontrols-containers.html
6 \title Container Controls
7 \ingroup qtquickcontrols-guidelines
8 \brief Guidelines for container controls
9
10 Qt Quick Controls offers a selection of container-like controls.
11
12 \annotatedlist qtquickcontrols-containers
13
14 Each type of container can be used to group a set of controls together.
15 The following sections offer guidelines for choosing the appropriate type
16 of container, depending on the use case.
17
18 \section1 ApplicationWindow Control
19
20 \image qtquickcontrols-applicationwindow-wireframe.png
21 {Window layout with Menu bar, Header, Content area, and Footer}
22
23 \l ApplicationWindow creates the root window of an application, and makes
24 it easy to add an optional header and footer to that window.
25
26 \section1 Frame Control
27
28 \image qtquickcontrols-frame.png
29 {Frame containing check boxes labeled E-mail, Calendar, Contacts}
30
31 \l Frame is used to layout a logical group of controls together, within
32 a visual frame.
33
34 \section1 GroupBox Control
35
36 \image qtquickcontrols-groupbox.png
37 {Group box with title and border containing checkboxes}
38
39 \l GroupBox is used to layout a logical group of controls together,
40 within a titled visual frame.
41
42 \section1 Page Control
43
44 \image qtquickcontrols-page-wireframe.webp
45 {Page wireframe with header, content area, and footer}
46
47 \l Page provides page-specific header and footer items.
48 It is perfectly possible to use ApplicationWindow for setting the header
49 and the footer, but if you have a header and footer which varies per
50 screen, then it is better to use \l Page.
51
52 \section1 Pane Control
53
54 \image qtquickcontrols-pane.png
55 {Pane containing items with background}
56
57 \l Pane provides a background color that matches with the application
58 style and theme. Pane does not provide a layout of its own, but requires
59 you to position its contents, for instance by using a \l RowLayout or
60 a \l ColumnLayout.
61
62 \section1 ScrollView Control
63
64 \image qtquickcontrols-scrollview-wireframe.webp
65 {ScrollView layout showing scrollable content area with scroll bars}
66
67 \l ScrollView provides scrolling for user-defined content.
68
69 \section1 StackView Control
70
71 \image qtquickcontrols-stackview-wireframe.webp
72 {Stack view diagram showing stacked pages with top page visible}
73
74 \l StackView organizes content pages into a stack using a last-in-first-out
75 principle: the last item to be "pushed" onto the stack is the first one to
76 be removed, and the top-most item is always the one that is visible.
77
78 \section1 SwipeView Control
79
80 \image qtquickcontrols-swipeview-wireframe.webp
81 {Swipe view diagram showing pages arranged in swipable strip}
82
83 \l SwipeView organizes content pages into a swipable strip.
84
85 \section1 TabBar Control
86
87 \image qtquickcontrols-tabbar-wireframe.webp
88 {Tab bar diagram showing multiple tabs for organizing content}
89
90 \l TabBar organizes content pages into tabs.
91
92 \section1 ToolBar Control
93
94 \image qtquickcontrols-toolbar.png
95 {Toolbar containing tool buttons}
96
97 \l ToolBar is a container of application-wide and context-sensitive
98 actions and controls.
99*/