| 1 | /**************************************************************************** |
| 2 | ** |
| 3 | ** Copyright (C) 2017 The Qt Company Ltd. |
| 4 | ** Contact: http://www.qt.io/licensing/ |
| 5 | ** |
| 6 | ** This file is part of the Qt Quick Templates 2 module of the Qt Toolkit. |
| 7 | ** |
| 8 | ** $QT_BEGIN_LICENSE:LGPL3$ |
| 9 | ** Commercial License Usage |
| 10 | ** Licensees holding valid commercial Qt licenses may use this file in |
| 11 | ** accordance with the commercial license agreement provided with the |
| 12 | ** Software or, alternatively, in accordance with the terms contained in |
| 13 | ** a written agreement between you and The Qt Company. For licensing terms |
| 14 | ** and conditions see http://www.qt.io/terms-conditions. For further |
| 15 | ** information use the contact form at http://www.qt.io/contact-us. |
| 16 | ** |
| 17 | ** GNU Lesser General Public License Usage |
| 18 | ** Alternatively, this file may be used under the terms of the GNU Lesser |
| 19 | ** General Public License version 3 as published by the Free Software |
| 20 | ** Foundation and appearing in the file LICENSE.LGPLv3 included in the |
| 21 | ** packaging of this file. Please review the following information to |
| 22 | ** ensure the GNU Lesser General Public License version 3 requirements |
| 23 | ** will be met: https://www.gnu.org/licenses/lgpl.html. |
| 24 | ** |
| 25 | ** GNU General Public License Usage |
| 26 | ** Alternatively, this file may be used under the terms of the GNU |
| 27 | ** General Public License version 2.0 or later as published by the Free |
| 28 | ** Software Foundation and appearing in the file LICENSE.GPL included in |
| 29 | ** the packaging of this file. Please review the following information to |
| 30 | ** ensure the GNU General Public License version 2.0 requirements will be |
| 31 | ** met: http://www.gnu.org/licenses/gpl-2.0.html. |
| 32 | ** |
| 33 | ** $QT_END_LICENSE$ |
| 34 | ** |
| 35 | ****************************************************************************/ |
| 36 | |
| 37 | #include "qquickradiodelegate_p.h" |
| 38 | #include "qquickabstractbutton_p_p.h" |
| 39 | |
| 40 | #include <QtGui/qpa/qplatformtheme.h> |
| 41 | |
| 42 | QT_BEGIN_NAMESPACE |
| 43 | |
| 44 | /*! |
| 45 | \qmltype RadioDelegate |
| 46 | \inherits ItemDelegate |
| 47 | //! \instantiates QQuickRadioDelegate |
| 48 | \inqmlmodule QtQuick.Controls |
| 49 | \since 5.7 |
| 50 | \ingroup qtquickcontrols2-delegates |
| 51 | \brief Exclusive item delegate with a radio indicator that can be toggled on or off. |
| 52 | |
| 53 | \image qtquickcontrols2-radiodelegate.gif |
| 54 | |
| 55 | RadioDelegate presents an item delegate that can be toggled on (checked) or |
| 56 | off (unchecked). Radio delegates are typically used to select one option |
| 57 | from a set of options. |
| 58 | |
| 59 | RadioDelegate inherits its API from \l ItemDelegate, which is inherited |
| 60 | from AbstractButton. For instance, you can set \l {AbstractButton::text}{text}, |
| 61 | and react to \l {AbstractButton::clicked}{clicks} using the AbstractButton |
| 62 | API. The state of the radio delegate can be set with the |
| 63 | \l {AbstractButton::}{checked} property. |
| 64 | |
| 65 | Radio delegates are \l {AbstractButton::autoExclusive}{auto-exclusive} |
| 66 | by default. Only one delegate can be checked at any time amongst radio |
| 67 | delegates that belong to the same parent item; checking another delegate |
| 68 | automatically unchecks the previously checked one. For radio delegates |
| 69 | that do not share a common parent, ButtonGroup can be used to manage |
| 70 | exclusivity. |
| 71 | |
| 72 | \l RadioButton is similar to RadioDelegate, except that it is typically |
| 73 | not used in views, but rather when there are only a few options, and often |
| 74 | with the requirement that each button is uniquely identifiable. |
| 75 | |
| 76 | \code |
| 77 | ButtonGroup { |
| 78 | id: buttonGroup |
| 79 | } |
| 80 | |
| 81 | ListView { |
| 82 | model: ["Option 1", "Option 2", "Option 3"] |
| 83 | delegate: RadioDelegate { |
| 84 | text: modelData |
| 85 | checked: index == 0 |
| 86 | ButtonGroup.group: buttonGroup |
| 87 | } |
| 88 | } |
| 89 | \endcode |
| 90 | |
| 91 | \sa {Customizing RadioDelegate}, {Delegate Controls}, RadioButton |
| 92 | */ |
| 93 | |
| 94 | QQuickRadioDelegate::QQuickRadioDelegate(QQuickItem *parent) |
| 95 | : QQuickItemDelegate(parent) |
| 96 | { |
| 97 | setCheckable(true); |
| 98 | setAutoExclusive(true); |
| 99 | } |
| 100 | |
| 101 | QFont QQuickRadioDelegate::defaultFont() const |
| 102 | { |
| 103 | return QQuickTheme::font(scope: QQuickTheme::ListView); |
| 104 | } |
| 105 | |
| 106 | QPalette QQuickRadioDelegate::defaultPalette() const |
| 107 | { |
| 108 | return QQuickTheme::palette(scope: QQuickTheme::ListView); |
| 109 | } |
| 110 | |
| 111 | #if QT_CONFIG(accessibility) |
| 112 | QAccessible::Role QQuickRadioDelegate::accessibleRole() const |
| 113 | { |
| 114 | return QAccessible::RadioButton; |
| 115 | } |
| 116 | #endif |
| 117 | |
| 118 | QT_END_NAMESPACE |
| 119 | |