qt5base-lts/examples/widgets/symbianvibration/xqvibra.h
David Boddie 4686b7af03 Doc: Added missing license headers for documentation and examples.
Change-Id: I696f6ce2ee9b6055c549e615de952773d171f3e7
Reviewed-on: http://codereview.qt.nokia.com/408
Reviewed-by: Qt Sanity Bot <qt_sanity_bot@ovi.com>
Reviewed-by: David Boddie
2011-07-20 15:12:53 +02:00

102 lines
3.1 KiB
C++

/****************************************************************************
**
** Copyright (C) 2011 Nokia Corporation and/or its subsidiary(-ies).
** All rights reserved.
** Contact: Nokia Corporation (qt-info@nokia.com)
**
** This file is part of the QtCore module of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:BSD$
** You may use this file under the terms of the BSD license as follows:
**
** "Redistribution and use in source and binary forms, with or without
** modification, are permitted provided that the following conditions are
** met:
** * Redistributions of source code must retain the above copyright
** notice, this list of conditions and the following disclaimer.
** * Redistributions in binary form must reproduce the above copyright
** notice, this list of conditions and the following disclaimer in
** the documentation and/or other materials provided with the
** distribution.
** * Neither the name of Nokia Corporation and its Subsidiary(-ies) nor
** the names of its contributors may be used to endorse or promote
** products derived from this software without specific prior written
** permission.
**
** THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
** "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
** LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
** A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
** OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
** SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
** LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
** DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
** THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
** (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
** OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE."
** $QT_END_LICENSE$
**
****************************************************************************/
#ifndef XQVIBRA_H
#define XQVIBRA_H
// INCLUDES
#include <QObject>
// FORWARD DECLARATIONS
class XQVibraPrivate;
// CLASS DECLARATION
//! [0]
class XQVibra : public QObject
{
Q_OBJECT
public:
static const int InfiniteDuration = 0;
static const int MaxIntensity = 100;
static const int MinIntensity = -100;
enum Error {
NoError = 0,
OutOfMemoryError,
ArgumentError,
VibraInUseError,
HardwareError,
TimeOutError,
VibraLockedError,
AccessDeniedError,
UnknownError = -1
};
enum Status {
StatusNotAllowed = 0,
StatusOff,
StatusOn
};
XQVibra(QObject *parent = 0);
~XQVibra();
XQVibra::Status currentStatus() const;
XQVibra::Error error() const;
Q_SIGNALS:
void statusChanged(XQVibra::Status status);
public Q_SLOTS:
bool start(int duration = InfiniteDuration);
bool stop();
bool setIntensity(int intensity);
private:
friend class XQVibraPrivate;
XQVibraPrivate *d;
};
//! [0]
#endif // XQVIBRA_H
// End of file