source: trunk/doc/src/declarative/example-slideswitch.qdoc

Last change on this file was 846, checked in by Dmitry A. Kuminov, 14 years ago

trunk: Merged in qt 4.7.2 sources from branches/vendor/nokia/qt.

File size: 5.0 KB
Line 
1/****************************************************************************
2**
3** Copyright (C) 2011 Nokia Corporation and/or its subsidiary(-ies).
4** All rights reserved.
5** Contact: Nokia Corporation ([email protected])
6**
7** This file is part of the documentation of the Qt Toolkit.
8**
9** $QT_BEGIN_LICENSE:FDL$
10** Commercial Usage
11** Licensees holding valid Qt Commercial licenses may use this file in
12** accordance with the Qt Commercial License Agreement provided with the
13** Software or, alternatively, in accordance with the terms contained in a
14** written agreement between you and Nokia.
15**
16** GNU Free Documentation License
17** Alternatively, this file may be used under the terms of the GNU Free
18** Documentation License version 1.3 as published by the Free Software
19** Foundation and appearing in the file included in the packaging of this
20** file.
21**
22** If you have questions regarding the use of this file, please contact
23** Nokia at [email protected].
24** $QT_END_LICENSE$
25**
26****************************************************************************/
27
28/*!
29\page qdeclarativeexampletoggleswitch.html
30\title QML Example - Toggle Switch
31
32This example shows how to create a reusable switch component in QML.
33
34The code for this example can be found in the \c $QTDIR/examples/declarative/ui-components/slideswitch directory.
35
36\section1 Overview
37
38The elements that composed the switch are:
39
40\list
41\o a \c on property (the interface to interact with the switch),
42\o two images (the background image and the knob),
43\o two mouse regions for user interation (on the background image and on the knob),
44\o two states (a \e on state and a \e off state),
45\o two functions or slots to react to the user interation (\c toggle() and \c dorelease()),
46\o and a transition that describe how to go from one state to the other.
47\endlist
48
49\section1 Switch.qml
50\snippet examples/declarative/ui-components/slideswitch/content/Switch.qml 0