aboutsummaryrefslogtreecommitdiffstats
path: root/plugins/controls/ListItemSwitch.qml
blob: 35c30053be5292b247dd30f0ec02331f33135a80 (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
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
/****************************************************************************
**
** Copyright (C) 2019 Luxoft Sweden AB
** Copyright (C) 2018 Pelagicore AG
** Contact: https://www.qt.io/licensing/
**
** This file is part of the Neptune 3 UI.
**
** $QT_BEGIN_LICENSE:GPL-QTAS$
** Commercial License Usage
** Licensees holding valid commercial Qt Automotive Suite 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 https://www.qt.io/terms-conditions.
** For further information use the contact form at https://www.qt.io/contact-us.
**
** GNU General Public License Usage
** Alternatively, this file may be used under the terms of the GNU
** General Public License version 3 or (at your option) any later version
** approved by the KDE Free Qt Foundation. The licenses are as published by
** the Free Software Foundation and appearing in the file LICENSE.GPL3
** included in the packaging of this file. Please review the following
** information to ensure the GNU General Public License requirements will
** be met: https://www.gnu.org/licenses/gpl-3.0.html.
**
** $QT_END_LICENSE$
**
** SPDX-License-Identifier: GPL-3.0
**
****************************************************************************/

import QtQuick 2.10
import QtQuick.Controls 2.3

import shared.Style 1.0

/*!
    \qmltype ListItemSwitch
    \inqmlmodule controls
    \inherits ListItemBasic
    \since 5.11
    \brief The list item with progress bar component of Neptune 3.

    The ListItemSwitch provides a type of a list item with a Switch at the right side.

    See \l{Neptune 3 UI Components and Interfaces} to see more available components in
    Neptune 3 UI.

    \section2 Example Usage

    The following example uses \l{ListItemSwitch}:

    \qml
    import QtQuick 2.10
    import shared.controls 1.0

    Item {
        id: root
        ListView {
            model: 3
            delegate: ListItemSwitch {
               Layout.fillWidth: true
               icon.name: "ic-update"
               text: "Downloading the application"
               onSwitchClicked {
                   console.log("switch clicked");
               }
            }
        }
    }
    \endqml
*/

ListItemBasic {
    id: root

    /*!
        \qmlproperty bool ListItemSwitch::switchOn

        This property holds whether the switch is on or off.

        This property's default is false.
    */
    property bool switchOn: false

    /*!
        \qmlproperty real ListItemSwitch::position

        This property holds the logical position of the thumb indicator.

        This property's default is 0.0.
    */
    property real position: 0.0

    /*!
        \qmlsignal ListItemSwitch::switchToggled

        This signal is emitted when the switch is toogled by the user.
    */
    signal switchToggled()

    /*!
        \qmlsignal ListItemSwitch::switchClicked

        This signal is emitted when the switch is clicked by the user.
    */
    signal switchClicked()

    rightSpacerUsed: true

    accessoryDelegateComponent1: Switch {
        id: switchDelegate
        objectName: "listItemSwitch"
        checked: root.switchOn
        onPositionChanged: root.position = position
        onToggled: {
            root.switchToggled()
            root.switchOn = checked
        }
        onClicked: root.switchClicked()

        Connections {
            target: root
            onClicked: switchDelegate.toggle()
        }
    }
}