1 /****************************************************************************
2 **
3 ** Copyright (C) 2015 The Qt Company Ltd.
4 ** Contact: http://www.qt.io/licensing/
5 **
6 ** This file is part of the QtCore module of the Qt Toolkit.
7 **
8 ** $QT_BEGIN_LICENSE:BSD$
9 ** You may use this file under the terms of the BSD license as follows:
10 **
11 ** "Redistribution and use in source and binary forms, with or without
12 ** modification, are permitted provided that the following conditions are
13 ** met:
14 **   * Redistributions of source code must retain the above copyright
15 **     notice, this list of conditions and the following disclaimer.
16 **   * Redistributions in binary form must reproduce the above copyright
17 **     notice, this list of conditions and the following disclaimer in
18 **     the documentation and/or other materials provided with the
19 **     distribution.
20 **   * Neither the name of The Qt Company Ltd nor the names of its
21 **     contributors may be used to endorse or promote products derived
22 **     from this software without specific prior written permission.
23 **
24 **
25 ** THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
26 ** "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
27 ** LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
28 ** A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
29 ** OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
30 ** SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
31 ** LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
32 ** DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
33 ** THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
34 ** (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
35 ** OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE."
36 **
37 ** $QT_END_LICENSE$
38 **
39 ****************************************************************************/
40 
41 #ifndef XQVIBRA_H
42 #define XQVIBRA_H
43 
44 // INCLUDES
45 #include <QObject>
46 
47 // FORWARD DECLARATIONS
48 class XQVibraPrivate;
49 
50 // CLASS DECLARATION
51 //! [0]
52 class XQVibra : public QObject
53 {
54     Q_OBJECT
55 
56 public:
57     static const int InfiniteDuration = 0;
58     static const int MaxIntensity = 100;
59     static const int MinIntensity = -100;
60 
61     enum Error {
62         NoError = 0,
63         OutOfMemoryError,
64         ArgumentError,
65         VibraInUseError,
66         HardwareError,
67         TimeOutError,
68         VibraLockedError,
69         AccessDeniedError,
70         UnknownError = -1
71     };
72 
73     enum Status {
74         StatusNotAllowed = 0,
75         StatusOff,
76         StatusOn
77     };
78 
79     XQVibra(QObject *parent = 0);
80     ~XQVibra();
81 
82     XQVibra::Status currentStatus() const;
83     XQVibra::Error error() const;
84 
85 Q_SIGNALS:
86     void statusChanged(XQVibra::Status status);
87 
88 public Q_SLOTS:
89     bool start(int duration = InfiniteDuration);
90     bool stop();
91     bool setIntensity(int intensity);
92 
93 private:
94     friend class XQVibraPrivate;
95     XQVibraPrivate *d;
96 };
97 //! [0]
98 
99 #endif // XQVIBRA_H
100 
101 // End of file
102