summaryrefslogtreecommitdiff
path: root/src/sensors/doc/src/qtsensorgestures-cpp.qdoc
blob: d7c5ebfc87d210dcfc876da2b755b327dfa71547 (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
// Copyright (C) 2017 The Qt Company Ltd.
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only

/*!
\page qtsensorgestures-cpp.html
\title Sensor Gestures C++ Overview
\brief Explains how to use 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 \c QtSensorGestures is easy. There are two main classes you will need to use:

\list
   \li QSensorGestureManager: can be used for determining which sensor gestures are available.
   \li QSensorGesture : for connecting the sensor gesture signals.
\endlist

\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

The primary classes that make up the \c QtSensorGesturesRecognizers API:

\annotatedlist sensorgestures_recognizer

Details of the \c QSensorGesturePlugins available

\annotatedlist sensorgesture_plugins_topics

*/