diff options
Diffstat (limited to 'src/sensors/doc/src/qtsensorgestures-cpp.qdoc')
-rw-r--r-- | src/sensors/doc/src/qtsensorgestures-cpp.qdoc | 60 |
1 files changed, 60 insertions, 0 deletions
diff --git a/src/sensors/doc/src/qtsensorgestures-cpp.qdoc b/src/sensors/doc/src/qtsensorgestures-cpp.qdoc new file mode 100644 index 00000000..e78ce4d6 --- /dev/null +++ b/src/sensors/doc/src/qtsensorgestures-cpp.qdoc @@ -0,0 +1,60 @@ +/**************************************************************************** +** +** 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$ +** +****************************************************************************/ + +/*! +\page qtsensorgestures-cpp.html +\title Sensor Gestures C++ Overview +\brief Information about the QtSensorGestures C++ API + +\tableofcontents + +\section1 Using QtSensorGestures + +With the Sensor Gestures classes, you are able to easily utilize device gesturing using +sensors such as the accelerometer and proximity. + +A list of currently supported sensor gestures and their descriptions can be found here: +\l {Qt Sensor Gestures} + +Using QtSensorGestures is easy. There are two main classes you will need to use. + +QSensorGestureManager can be used for determining what sensor gestures are available, and +QSensorGesture for connecting the sensor gesture signals. + +\snippet sensorgestures/creating.cpp Receiving sensor gesture signals + +More information about the sensor gesture recognizers can be found in +\l{QtSensorGestures Plugins}. + +\section1 Main Classes + +The primary classes that make up the QtSensorGestures API. + +\annotatedlist sensorgestures_main + +*/ + |