blob: 93083a18a952252123e94a79cb1de0771238661f (
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
|
<?xml version="1.0" encoding="UTF-8"?>
<db:article xmlns:db="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:its="http://www.w3.org/2005/11/its" version="5.2" xml:lang="en">
<db:info>
<db:title>QML Documentation Example</db:title>
<db:productname>Test</db:productname>
<db:titleabbrev>A test project for QDoc build artifacts</db:titleabbrev>
<db:abstract>
<db:para>Example for documenting QML types.</db:para>
</db:abstract>
</db:info>
<db:programlisting language="qml" its:translate="no">// Copyright (C) 2016 The Qt Company Ltd.
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR BSD-3-Clause
import QtQuick 1.0
/*!
\qmltype ToggleSwitch
\inqmlmodule UIComponents
\brief A component that can be turned on or off.
A toggle switch has two states: an \c on and an \c off state. The \c off
state is when the \l on property is set to \c false.
The ToggleSwitch component is part of the \l {UI Components} module.
This documentation is part of the \l{componentset}{UIComponents} example.
*/
Item {
id: toggleswitch
width: background.width; height: background.height
/*!
Indicates the state of the switch. If \c false, then the switch is in
the \c off state.
\omit
The \qmlproperty &lt;type&gt; &lt;propertyname&gt; is not necessary as QDoc
will associate this property to the ToggleSwitch
QDoc will not publish the documentation within omit and endomit.
\endomit
*/
property bool on: false
/*!
A method to toggle the switch. If the switch is \c on, the toggling it
will turn it \c off. Toggling a switch in the \c off position will
turn it \c on.
*/
function toggle() {
if (toggleswitch.state == &quot;on&quot;)
toggleswitch.state = &quot;off&quot;;
else
toggleswitch.state = &quot;on&quot;;
}
/*!
\internal
An internal function to synchronize the switch's internals. This
function is not for public access. The \internal command will
prevent QDoc from publishing this comment in the public API.
*/
function releaseSwitch() {
if (knob.x == 1) {
if (toggleswitch.state == &quot;off&quot;) return;
}
if (knob.x == 78) {
if (toggleswitch.state == &quot;on&quot;) return;
}
toggle();
}
Rectangle {
id: background
width: 130; height: 48
radius: 48
color: &quot;lightsteelblue&quot;
MouseArea { anchors.fill: parent; onClicked: toggle() }
}
Rectangle {
id: knob
width: 48; height: 48
radius: width
color: &quot;lightblue&quot;
MouseArea {
anchors.fill: parent
drag.target: knob; drag.axis: Drag.XAxis; drag.minimumX: 1; drag.maximumX: 78
onClicked: toggle()
onReleased: releaseSwitch()
}
}
states: [
State {
name: &quot;on&quot;
PropertyChanges { target: knob; x: 78 }
PropertyChanges { target: toggleswitch; on: true }
},
State {
name: &quot;off&quot;
PropertyChanges { target: knob; x: 1 }
PropertyChanges { target: toggleswitch; on: false }
}
]
transitions: Transition {
NumberAnimation { properties: &quot;x&quot;; easing.type: Easing.InOutQuad; duration: 200 }
}
}
</db:programlisting>
</db:article>
|
