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-delegates.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-delegates.html
6 \title Delegate Controls
7 \ingroup qtquickcontrols-guidelines
8 \brief Guidelines for delegate controls
9
10 Qt Quick Controls offers a selection of controls that are used as
11 delegates in views.
12
13 \annotatedlist qtquickcontrols-delegates
14
15 Each type of delegate has its own specific target use case. The following
16 sections offer guidelines for choosing the appropriate type of delegate,
17 depending on the use case.
18
19 \section1 CheckDelegate Control
20
21 \image qtquickcontrols-checkdelegate.gif
22 {Check delegate showing selection animation}
23
24 \l CheckDelegate presents a checkable control that can be toggled on
25 (checked) or off (unchecked). Check delegates are typically used to
26 select one or more options from a set of options.
27
28 \b {See also} \l {CheckBox Control}.
29
30 \section1 ItemDelegate Control
31
32 \image qtquickcontrols-itemdelegate.gif
33 {Item delegate showing press animation}
34
35 \l ItemDelegate presents a checkable control that can be pressed and
36 clicked by the user.
37
38 \section1 RadioDelegate Control
39
40 \image qtquickcontrols-radiodelegate.gif
41 {Radio delegate showing selection animation}
42
43 \l RadioDelegate presents a checkable control that can be toggled on
44 (checked) or off (unchecked). Radio delegates are typically used to select
45 one option from a set of options.
46
47 \b {See also} \l {RadioButton Control}.
48
49 \section1 SwipeDelegate Control
50
51 \image qtquickcontrols-swipedelegate.gif
52 {Swipe delegate revealing actions through swipe gesture}
53
54 \l SwipeDelegate presents a view item that can be swiped left or right to
55 expose more options or information.
56
57 \section1 SwitchDelegate Control
58
59 \image qtquickcontrols-switchdelegate.gif
60 {Switch delegate showing toggle animation}
61
62 \l SwitchDelegate presents a switchable delegate that can be toggled on or off.
63
64 \b {See also} \l {Switch Control}.
65
66 \section1 TableViewDelegate Control
67
68 \image qtquickcontrols-tableviewdelegate.png
69 {Table view delegate showing cell with content}
70
71 A \l TableViewDelegate is a delegate that can be assigned to the
72 \l [QML]{TableView::}{delegate} property of a TableView.
73
74 \b {See also} \l {TableView}
75
76 \section1 TreeViewDelegate Control
77
78 \image qtquickcontrols-treeviewdelegate.png
79 {Tree view delegate showing hierarchical items}
80
81 A \l TreeViewDelegate is a delegate that can be assigned to the delegate property
82 of a TreeView.
83
84 \b {See also} \l {TreeView}.
85
86 \section1 Related Information
87 \list
88 \li \l {Qt Quick Controls Guidelines}
89 \endlist
90*/