summaryrefslogtreecommitdiffstats
path: root/doc/src/qtsensorgestures-plugins.qdoc
diff options
context:
space:
mode:
authorLorn Potter <lorn.potter@nokia.com>2011-10-17 14:43:35 +1000
committerQt by Nokia <qt-info@nokia.com>2011-11-01 00:28:04 +0100
commit8684d1e799d379a913535b527b301f31cd566a01 (patch)
treef1b2e18a0dabab988f22b2a5961decab0f4a82d9 /doc/src/qtsensorgestures-plugins.qdoc
parent76702b40d4a505d71ddb8f8ebea71706a4e8d412 (diff)
add QSensorGestures API. Long live QSensorGestures!
Change-Id: Iada4e8888aad8b7b2180cc0bfb8576a766f75b24 Sanity-Review: Qt Sanity Bot <qt_sanity_bot@ovi.com> Reviewed-by: Lincoln Ramsay <lincoln.ramsay@nokia.com>
Diffstat (limited to 'doc/src/qtsensorgestures-plugins.qdoc')
-rw-r--r--doc/src/qtsensorgestures-plugins.qdoc59
1 files changed, 59 insertions, 0 deletions
diff --git a/doc/src/qtsensorgestures-plugins.qdoc b/doc/src/qtsensorgestures-plugins.qdoc
new file mode 100644
index 00000000..e73be5b9
--- /dev/null
+++ b/doc/src/qtsensorgestures-plugins.qdoc
@@ -0,0 +1,59 @@
+/****************************************************************************
+**
+** Copyright (C) 2011 Nokia Corporation and/or its subsidiary(-ies).
+** All rights reserved.
+** Contact: Nokia Corporation (qt-info@nokia.com)
+**
+** This file is part of the documentation of the Qt Toolkit.
+**
+** $QT_BEGIN_LICENSE:FDL$
+** GNU Free Documentation License
+** 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.
+**
+** Other Usage
+** Alternatively, this file may be used in accordance with the terms
+** and conditions contained in a signed written agreement between you
+** and Nokia.
+**
+**
+**
+**
+** $QT_END_LICENSE$
+**
+****************************************************************************/
+
+/*!
+\group sensorgesture_plugins_topics
+\title QtSensorGestures Plugins
+\brief Information about the QtSensorGestures recognizer plugins.
+
+The QtSensorGestures recognizer plugins are the way to create your own
+sensor gestures.
+
+\tableofcontents
+
+\section1 Overview
+
+ The steps to creating a sensor gesture plugin are as follows:
+\list
+\o Sub-class from QSensorGesturePluginInterface
+\o Sub-class from QSensorGestureRecognizer and implement gesture recognizer logic using QtSensors.
+\o Create an instance of that recognizer in the derived QSensorGesturePluginInterface class, and call
+ QSensorGestureManager::registerSensorGestureRecognizer(sRec); in your registerRecognizers()
+function. QSensorGestureManager will retain ownership of the recognizer object.
+\endlist
+
+\snippet snippets/sensorgestures/plugin.cpp Plugin
+
+
+\section1 Recognizer Classes
+If you are making sensorgestures available through the QtSensorGestures API, these are the
+sensor gesture classes to use.
+
+\annotatedlist sensorgestures_recognizer
+
+
+*/