summaryrefslogtreecommitdiffstats
path: root/src/gui/kernel/qgesturerecognizer.h
blob: ca8972bb09101771e6f86ed0affa3ad389edb956 (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
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
/****************************************************************************
**
** Copyright (C) 2009 Nokia Corporation and/or its subsidiary(-ies).
** Contact: Qt Software Information (qt-info@nokia.com)
**
** This file is part of the $MODULE$ of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:LGPL$
** Commercial Usage
** Licensees holding valid Qt Commercial licenses may use this file in
** accordance with the Qt Commercial License Agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and Nokia.
**
** GNU Lesser General Public License Usage
** Alternatively, this file may be used under the terms of the GNU Lesser
** General Public License version 2.1 as published by the Free Software
** Foundation and appearing in the file LICENSE.LGPL included in the
** packaging of this file.  Please review the following information to
** ensure the GNU Lesser General Public License version 2.1 requirements
** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
**
** In addition, as a special exception, Nokia gives you certain
** additional rights. These rights are described in the Nokia Qt LGPL
** Exception version 1.0, included in the file LGPL_EXCEPTION.txt in this
** package.
**
** GNU General Public License Usage
** Alternatively, this file may be used under the terms of the GNU
** General Public License version 3.0 as published by the Free Software
** Foundation and appearing in the file LICENSE.GPL included in the
** packaging of this file.  Please review the following information to
** ensure the GNU General Public License version 3.0 requirements will be
** met: http://www.gnu.org/copyleft/gpl.html.
**
** If you are unsure which license is appropriate for your use, please
** contact the sales department at qt-sales@nokia.com.
** $QT_END_LICENSE$
**
****************************************************************************/

#ifndef QGESTURERECOGNIZER_H
#define QGESTURERECOGNIZER_H

#include "qgesture.h"
#include "qevent.h"
#include "qlist.h"
#include "qset.h"

QT_BEGIN_NAMESPACE

/*!
    \class QGestureRecognizer

    \brief The base class for implementing custom gestures.

    This is a base class, to create a custom gesture type, you should
    subclass it and implement pure virtual functions.

    Usually gesture recognizer implements state machine, storing its
    state internally in the recognizer object. The recognizer receives
    input events through the QGestureRecognizer::recognize() virtual
    function and decides whether the parsed event should change the
    state of the recognizer - i.e. if the event starts or ends a
    gesture or if it isn't related to gesture at all.
*/

/*! \fn Qt::GestureType gestureType() const

    Returns the name of the gesture that is handled by the recognizer.
*/

/*! \fn Result recognize(const QList<QEvent*> &events)

    This is a pure virtual function that need to be implemented in
    subclasses.

    Parses input \a events and returns the result, saying if the event
    sequence is a gesture or not.
*/

/*! \fn QGesture* makeEvent() const

    Creates a new gesture object that will be send to the widget. This
    function is called when the gesture recognizer returned a
    QGestureRecognizer::GestureStarted or
    QGestureRecognizer::GestureFinished state.

    Created gesture object is owned by the caller.
 */

/*! \fn void reset()

    Resets the internal state of the gesture recognizer.
*/

/*! \fn void triggered(QGestureRecognizer::Result result)

    The gesture recognizer might emit the signal when the gesture
    state changes asynchronously, i.e. without any event being
    received.
*/

class Q_GUI_EXPORT QGestureRecognizer : public QObject
{
    Q_OBJECT
public:
    enum Result
    {
        NotGesture,
        GestureStarted,
        GestureFinished,
        MaybeGesture
    };

    inline QGestureRecognizer() { }
    //### remove this ctor
    inline QGestureRecognizer(const char *type) : type_(QLatin1String(type)) { }
    inline QGestureRecognizer(const Qt::GestureType &type) : type_(type) { }
    inline Qt::GestureType gestureType() const { return type_; }

    virtual Result recognize(const QList<QEvent*> &events) = 0;
    virtual QGesture* makeEvent() const = 0;
    virtual void reset() = 0;

signals:
    void triggered(QGestureRecognizer::Result result);

protected:
    Qt::GestureType type_;
};

QT_END_NAMESPACE

#endif // QGESTURERECOGNIZER_P_H