summaryrefslogtreecommitdiffstats
path: root/examples/sensors/sensorgestures/doc
diff options
context:
space:
mode:
authorGeir Vattekar <geir.vattekar@digia.com>2012-10-04 13:48:23 +0200
committerThe Qt Project <gerrit-noreply@qt-project.org>2012-10-12 15:16:15 +0200
commit9d4d08421acb628e0115b140e54656fc779d13db (patch)
treeeb87c8fbbe0722f70fa536227fa7a311febdea81 /examples/sensors/sensorgestures/doc
parent8f624bb5d19edb47fc4803a5eb0d6343de5bbae9 (diff)
Doc: Modularized the Qt Sensor Docs
Change-Id: Ie8636ec443f43b1f238342e0f6f7d321e13dce09 Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
Diffstat (limited to 'examples/sensors/sensorgestures/doc')
-rw-r--r--examples/sensors/sensorgestures/doc/images/sensorgesturecpp.pngbin0 -> 33013 bytes
-rw-r--r--examples/sensors/sensorgestures/doc/src/sensorgestures.qdoc67
2 files changed, 67 insertions, 0 deletions
diff --git a/examples/sensors/sensorgestures/doc/images/sensorgesturecpp.png b/examples/sensors/sensorgestures/doc/images/sensorgesturecpp.png
new file mode 100644
index 00000000..4d453cf2
--- /dev/null
+++ b/examples/sensors/sensorgestures/doc/images/sensorgesturecpp.png
Binary files differ
diff --git a/examples/sensors/sensorgestures/doc/src/sensorgestures.qdoc b/examples/sensors/sensorgestures/doc/src/sensorgestures.qdoc
new file mode 100644
index 00000000..a5c96cb5
--- /dev/null
+++ b/examples/sensors/sensorgestures/doc/src/sensorgestures.qdoc
@@ -0,0 +1,67 @@
+/****************************************************************************
+**
+** Copyright (C) 2012 Digia Plc and/or its subsidiary(-ies).
+** Contact: http://www.qt-project.org/legal
+**
+** This file is part of the documentation of the Qt Toolkit.
+**
+** $QT_BEGIN_LICENSE:FDL$
+** Commercial License Usage
+** Licensees holding valid commercial Qt 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 Digia. For licensing terms and
+** conditions see http://qt.digia.com/licensing. For further information
+** use the contact form at http://qt.digia.com/contact-us.
+**
+** GNU Free Documentation License Usage
+** Alternatively, this file may be used under the terms of the GNU Free
+** Documentation License version 1.3 as published by the Free Software
+** Foundation and appearing in the file included in the packaging of
+** this file. Please review the following information to ensure
+** the GNU Free Documentation License version 1.3 requirements
+** will be met: http://www.gnu.org/copyleft/fdl.html.
+** $QT_END_LICENSE$
+**
+****************************************************************************/
+
+/*!
+ \example sensorgestures
+ \title Qt Sensors - C++ Sensor Gestures Example
+ \ingroup qtsensors-examples
+ \brief The sensor gesture example demonstrates the steps for creating a C++ application
+ that uses sensor gestures and the included shake sensor.
+ \image sensorgesturecpp.png
+
+ QSensorGestures class defines one predefined signal, \c { void detected(const QString &) }
+
+ As well, Sensor Gesture Recognizers may implement any number of their own custom signals.
+
+ Our shake recognizer defines one custom signal, \c {void shake()}, as well as the predefined
+ detected signal.
+
+ \section1 SensorGestures Class Implementation
+
+ In order to know about custom signals that may be available, we need to ask the QSensorGestureManager about them,
+
+ Using the QSensorGesture::gestureIds() function, the manager will return a QStringList of known and valid gesture Ids.
+ \snippet sensorgestures/mainwindow.cpp 0
+
+ We can then use this to create a QSensorGesture object that we can use to connect signals to,
+ and start the detection process. A QSensorGesture object will take a list of one or more
+ recognizer ids in it's constructor.
+
+ \snippet sensorgestures/mainwindow.cpp 1
+
+ and later stop the detection process.
+
+ \snippet sensorgestures/mainwindow.cpp 2
+
+ The QSensorGesture object will contain all the signals of the valid requested recognizers found on the system.
+
+ You can discover which of the requested recognizer ID's that were not found by using QSensorGesture::invalidIds();
+
+ By using QSensorGesture::gestureSignals(), you can get a QStringList of usable signals.
+
+
+*/