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     /**
  66     * @brief Slot to receive location of crosshair
  67     *
  68     * @param ownLocation (Latitude and Longitude)
  69     */
  70     void receiveOwnLocation(QPointF ownLocation);
  71
  72     /**
  73     * @brief Slot to intercept error signal from ImageFetcher and SituareService
  74     *
  75     * @param error Error message
  76     */
  77     void error(const QString &error);
  78
  79     /**
  80     * @brief Slot to intercept signal from successful login
  81     */
  82     void loginOk();
  83
  84     /**
  85     * @brief Calls reverseGeo from SituareService to translate coordinates to street address
  86     *
  87     */
  88     void requestAddress();
  89
  90     /**
  91     * @brief Calls updateLocation from SituareService to send the location update to
  92     *        Situare server.
  93     *
  94     * @param status Status message
  95     * @param publish Publish on Facebook
  96     */
  97     void requestUpdateLocation(const QString &status, bool publish);
  98
  99     /**
 100     * @brief Slot to refresh user data
 101     */
 102     void refreshUserData();
 103
 104     /**
 105     * @brief Slot to intercept signal from successful location update
 106     *
 107     */
 108     void updateWasSuccessful();
 109
 110     /**
 111     * @brief Slot to intercept signal when new user data is available.
 112     *        Splits User and friendsList data and emits them as two different signals.
 113     *
 114     * @param user instance of User
 115     * @param friendsList list of User instances (friends)
 116     */
 117     void userDataChanged(User *user, QList<User *> &friendsList);
 118
 119     /**
 120     * @brief Slot for auto centering enabling.
 121     *
 122     * Calls gps to send last known position
 123     * @param enabled true if auto centering was enabled, false otherwise
 124     */
 125     void enableAutoCentering(bool enabled);
 126
 127     /**
 128     * @brief Slot for gps enabling.
 129     *
 130     * @param enabled true if gps should be enabled, false otherwise
 131     */
 132     void enableGPS(bool enabled);
 133
 134     /**
 135     * @brief Slot to intercept signal when user has cancelled login process
 136     */
 137     void loginProcessCancelled();
 138
 139 /*******************************************************************************
 140  * SIGNALS
 141  ******************************************************************************/
 142 signals:
 143     /**
 144     * @brief Signals when new user data is ready
 145     *
 146     * @param user Instance of User
 147     */
 148     void userLocationReady(User *user);
 149
 150     /**
 151     * @brief Signals when new friends data is ready
 152     *
 153     * @param friendList List of User instances (friends)
 154     */
 155     void friendsLocationsReady(QList<User *> &friendList);
 156
 157     /**
 158     * @brief Signal causes mapengine to send updated location of crosshair.
 159     *
 160     */
 161     void requestOwnLocation();
 162
 163 /*******************************************************************************
 164  * DATA MEMBERS
 165  ******************************************************************************/
 166 private:
 167     bool m_autoCenteringEnabled;    ///< Auto centering enabled
 168     bool m_gpsEnabled;              ///< GPS enabled
 169     FacebookAuthentication *m_facebookAuthenticator; ///< Instance for facebook authenticator
 170     GPSPositionInterface *m_gps;   ///< Instance of the gps position
 171     MainWindow *m_ui; ///< Instance of the MainWindow UI
 172     SituareService *m_situareService; ///< Instance of the situare server communication service
 173     QPointF m_latestLocation; ///< Placeholder for user's latest asked location
 174 };
 175
 176 #endif // ENGINE_H