Change copyrights from Nokia to Digia
[qt:qtfeedback.git] / src / imports / feedback / qdeclarativefeedbackeffect_p.h
1 /****************************************************************************
2 **
3 ** Copyright (C) 2012 Digia Plc and/or its subsidiary(-ies).
4 ** Contact: http://www.qt-project.org/legal
5 **
6 ** This file is part of the QtFeedback module of the Qt Toolkit.
7 **
8 ** $QT_BEGIN_LICENSE:LGPL$
9 ** Commercial License Usage
10 ** Licensees holding valid commercial Qt licenses may use this file in
11 ** accordance with the commercial license agreement provided with the
12 ** Software or, alternatively, in accordance with the terms contained in
13 ** a written agreement between you and Digia.  For licensing terms and
14 ** conditions see http://qt.digia.com/licensing.  For further information
15 ** use the contact form at http://qt.digia.com/contact-us.
16 **
17 ** GNU Lesser General Public License Usage
18 ** Alternatively, this file may be used under the terms of the GNU Lesser
19 ** General Public License version 2.1 as published by the Free Software
20 ** Foundation and appearing in the file LICENSE.LGPL included in the
21 ** packaging of this file.  Please review the following information to
22 ** ensure the GNU Lesser General Public License version 2.1 requirements
23 ** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
24 **
25 ** In addition, as a special exception, Digia gives you certain additional
26 ** rights.  These rights are described in the Digia Qt LGPL Exception
27 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
28 **
29 ** GNU General Public License Usage
30 ** Alternatively, this file may be used under the terms of the GNU
31 ** General Public License version 3.0 as published by the Free Software
32 ** Foundation and appearing in the file LICENSE.GPL included in the
33 ** packaging of this file.  Please review the following information to
34 ** ensure the GNU General Public License version 3.0 requirements will be
35 ** met: http://www.gnu.org/copyleft/gpl.html.
36 **
37 **
38 ** $QT_END_LICENSE$
39 **
40 ****************************************************************************/
41
42 //
43 //  W A R N I N G
44 //  -------------
45 //
46 // This file is not part of the Qt API.  It exists for the convenience
47 // of Qt Feedback framework.  This header file may change from version
48 // to version without notice, or even be removed.
49 //
50 // We mean it.
51 //
52 //
53
54 #ifndef QDECLARATIVEFEEDBACKEFFECT_P_H
55 #define QDECLARATIVEFEEDBACKEFFECT_P_H
56
57 #include <QtQml/qqml.h>
58 #include <qfeedbackeffect.h>
59
60 QT_USE_NAMESPACE
61
62 class QDeclarativeFeedbackEffect : public QObject
63 {
64     Q_OBJECT
65
66     Q_PROPERTY(bool running READ isRunning WRITE setRunning NOTIFY runningChanged)
67     Q_PROPERTY(bool paused READ isPaused WRITE setPaused NOTIFY pausedChanged)
68     Q_PROPERTY(int duration READ duration WRITE setDuration NOTIFY durationChanged)
69     Q_PROPERTY(State state READ state WRITE setState NOTIFY stateChanged)
70     Q_PROPERTY(ErrorType error READ error NOTIFY errorChanged)
71
72     Q_ENUMS(Duration)
73     Q_ENUMS(State)
74     Q_ENUMS(ErrorType)
75
76 public:
77     enum Duration {
78         Infinite = QFeedbackEffect::Infinite
79     };
80
81     enum State {
82         Stopped = QFeedbackEffect::Stopped,
83         Paused = QFeedbackEffect::Paused,
84         Running = QFeedbackEffect::Running,
85         Loading = QFeedbackEffect::Loading
86     };
87
88     enum ErrorType {
89         UnknownError = QFeedbackEffect::UnknownError,
90         DeviceBusy = QFeedbackEffect::DeviceBusy
91     };
92
93     QDeclarativeFeedbackEffect(QObject *parent = 0);
94     void setFeedbackEffect(QFeedbackEffect* effect);
95     QFeedbackEffect* feedbackEffect();
96
97     bool isRunning() const;
98     bool isPaused() const;
99     void setRunning(bool running);
100     void setPaused(bool paused);
101     virtual State state() const;
102     virtual int duration() const;
103     virtual void setState(State newState);
104     virtual void setDuration(int newDuration);
105     ErrorType error() const;
106
107 signals:
108     void runningChanged();
109     void pausedChanged();
110     void durationChanged();
111     void stateChanged();
112     void errorChanged();
113
114 public slots:
115     void updateState();
116     void start();
117     void stop();
118     void pause();
119
120 private slots:
121     void _error(QFeedbackEffect::ErrorType err);
122
123 private:
124     bool m_running;
125     bool m_paused;
126     QFeedbackEffect* m_effect;
127     ErrorType m_error;
128 };
129
130 QML_DECLARE_TYPE(QDeclarativeFeedbackEffect)
131
132 #endif // QDECLARATIVEFEEDBACKEFFECT_P_H