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

   1  /*
   2     Situare - A location system for Facebook
   3     Copyright (C) 2010  Ixonos Plc. Authors:
   4
   5         Kaj Wallin - kaj.wallin@ixonos.com
   6         Henri Lampela - henri.lampela@ixonos.com
   7         Jussi Laitinen - jussi.laitinen@ixonos.com
   8
   9     Situare is free software; you can redistribute it and/or
  10     modify it under the terms of the GNU General Public License
  11     version 2 as published by the Free Software Foundation.
  12
  13     Situare is distributed in the hope that it will be useful,
  14     but WITHOUT ANY WARRANTY; without even the implied warranty of
  15     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16     GNU General Public License for more details.
  17
  18     You should have received a copy of the GNU General Public License
  19     along with Situare; if not, write to the Free Software
  20     Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301,
  21     USA.
  22  */
  23
  24
  25 #ifndef ENGINE_H
  26 #define ENGINE_H
  27
  28 #include <QWidget>
  29 #include <QtDebug>
  30 #include "facebookservice/facebookauthentication.h"
  31 #include "situareservice/situareservice.h"
  32 #include "ui/mainwindow.h"
  33
  34 class GPSPositionInterface;
  35
  36 /**
  37 * @brief Engine class for Situare Application
  38 *
  39 * This class handles all the underlaying login of the Situare
  40 * application.
  41 *
  42 * @class SituareEngine engine.h "engine/engine.h"
  43 */
  44 class SituareEngine : public QObject
  45 {
  46     Q_OBJECT
  47 public:
  48     /**
  49     * @brief Constructor
  50     *
  51     * @param parent
  52     */
  53     SituareEngine(QMainWindow *parent = 0);
  54
  55     /**
  56     * @brief Destructor
  57     */
  58     ~SituareEngine();
  59
  60 /*******************************************************************************
  61  * MEMBER FUNCTIONS AND SLOTS
  62  ******************************************************************************/
  63 public slots:
  64
  65     void receiveOwnLocation(QPointF ownLocation);
  66
  67     /**
  68     * @brief Slot to intercept error signal from ImageFetcher and SituareService
  69     *
  70     * @param error Error message
  71     */
  72     void error(const QString &error);
  73
  74     /**
  75     * @brief Slot to intercept signal from successful login
  76     */
  77     void loginOk();
  78
  79     /**
  80     * @brief Calls reverseGeo from SituareService to translate coordinates to street address
  81     *
  82     */
  83     void requestAddress();
  84
  85     /**
  86     * @brief Calls updateLocation from SituareService to send the location update to
  87     *        Situare server.
  88     *
  89     * @param status Status message
  90     * @param publish Publish on Facebook
  91     */
  92     void requestUpdateLocation(const QString &status, bool publish);
  93
  94     /**
  95     * @brief Slot to refresh user data
  96     */
  97     void refreshUserData();
  98
  99     /**
 100     * @brief Slot to intercept signal from successful location update
 101     *
 102     */
 103     void updateWasSuccessful();
 104
 105     /**
 106     * @brief Slot to intercept signal when new user data is available.
 107     *        Splits User and friendsList data and emits them as two different signals.
 108     *
 109     * @param user instance of User
 110     * @param friendsList list of User instances (friends)
 111     */
 112     void userDataChanged(User *user, QList<User *> &friendsList);
 113
 114     /**
 115     * @brief Slot for auto centering enabling.
 116     *
 117     * Calls gps to send last known position
 118     * @param enabled true if auto centering was enabled, false otherwise
 119     */
 120     void enableAutoCentering(bool enabled);
 121
 122     /**
 123     * @brief Slot for gps enabling.
 124     *
 125     * @param enabled true if gps should be enabled, false otherwise
 126     */
 127     void enableGPS(bool enabled);
 128
 129     /**
 130     * @brief Slot to intercept signal when user has cancelled login process
 131     */
 132     void loginProcessCancelled();
 133
 134 /*******************************************************************************
 135  * SIGNALS
 136  ******************************************************************************/
 137 signals:
 138
 139     /**
 140     * @brief Signals when new user data is ready
 141     *
 142     * @param user Instance of User
 143     */
 144     void userLocationReady(User *user);
 145
 146     /**
 147     * @brief Signals when new friends data is ready
 148     *
 149     * @param friendList List of User instances (friends)
 150     */
 151     void friendsLocationsReady(QList<User *> &friendList);
 152     void requestOwnLocation();
 153
 154 /*******************************************************************************
 155  * DATA MEMBERS
 156  ******************************************************************************/
 157 private:
 158     bool m_autoCenteringEnabled;    ///< Auto centering enabled
 159     bool m_gpsEnabled;              ///< GPS enabled
 160     FacebookAuthentication *m_facebookAuthenticator; ///< Instance for facebook authenticator
 161     GPSPositionInterface *m_gps;   ///< Instance of the gps position
 162     MainWindow *m_ui; ///< Instance of the MainWindow UI
 163     SituareService *m_situareService; ///< Instance of the situare server communication service
 164 };
 165
 166 #endif // ENGINE_H