vcs.maemo.org Git - situare/blob - src/engine/mce.h

   1 /*
   2    Situare - A location system for Facebook
   3    Copyright (C) 2010  Ixonos Plc. Authors:
   4
   5        Jussi Laitinen - jussi.laitinen@ixonos.com
   6
   7    Situare is free software; you can redistribute it and/or
   8    modify it under the terms of the GNU General Public License
   9    version 2 as published by the Free Software Foundation.
  10
  11    Situare is distributed in the hope that it will be useful,
  12    but WITHOUT ANY WARRANTY; without even the implied warranty of
  13    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14    GNU General Public License for more details.
  15
  16    You should have received a copy of the GNU General Public License
  17    along with Situare; if not, write to the Free Software
  18    Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301,
  19    USA.
  20 */
  21
  22 #ifndef MCE_H
  23 #define MCE_H
  24
  25 #include <QObject>
  26
  27 class MCEPrivate;
  28
  29 /**
  30 * @brief MCE class.
  31 *
  32 * Mode Control Entity (MCE) controls phone and listens changes in phone state.
  33 */
  34 class MCE : public QObject
  35 {
  36     Q_OBJECT
  37
  38 public:
  39     /**
  40     * @brief Friend class for MCEPrivate.
  41     */
  42     friend class MCEPrivate;
  43
  44     /**
  45     * @brief Constructor.
  46     *
  47     * @param parent QObject
  48     */
  49     MCE(QObject *parent = 0);
  50
  51 /*******************************************************************************
  52  * MEMBER FUNCTIONS AND SLOTS
  53  ******************************************************************************/
  54 public:
  55     /**
  56     * @brief Is the display on.
  57     *
  58     * @return true if on, false if off.
  59     */
  60     bool isDisplayOn();
  61
  62     /**
  63     * @brief Vibrates the phone for short time.
  64     */
  65     void vibrationFeedback();
  66
  67 /*******************************************************************************
  68  * SIGNALS
  69  ******************************************************************************/
  70 signals:
  71     /**
  72     * @brief Signal for the display off.
  73     *
  74     * @param off true if off, false if on
  75     */
  76     void displayOff(bool off);
  77
  78 /*******************************************************************************
  79  * DATA MEMBERS
  80  ******************************************************************************/
  81 private:
  82     MCEPrivate *m_mcePrivate;   ///< Instance of MCEPrivate
  83 };
  84
  85 #endif // MCE_H