Qt Reference Documentation

# xqvibra.h Example File

widgets/symbianvibration/xqvibra.h

     /****************************************************************************
     **
     ** Copyright (C) 2013 Digia Plc and/or its subsidiary(-ies).
     ** Contact: http://www.qt-project.org/legal
     **
     ** 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 Digia Plc 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
     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;
     };

     #endif // XQVIBRA_H

     // End of file