Documenting
[situare] / src / engine / engine.h
index f6c4cc3..71bfc7a 100644 (file)
@@ -33,9 +33,7 @@
 
 class QTimer;
 
-#ifdef Q_WS_MAEMO_5
 class Application;
-#endif
 class FacebookAuthentication;
 class FacebookCredentials;
 class GeocodingService;
@@ -45,6 +43,7 @@ class MainWindow;
 class MapEngine;
 class MCE;
 class NetworkAccessManager;
+class Route;
 class RoutingService;
 class SituareService;
 class User;
@@ -227,13 +226,6 @@ private slots:
     void enableAutomaticLocationUpdate(bool enabled, int updateIntervalMsecs = 0);
 
     /**
-    * @brief Slot for enabling power saving.
-    *
-    * @param enabled true if enabled, false otherwise
-    */
-    void enablePowerSave(bool enabled);
-
-    /**
     * @brief Slot to intercept signal when user's/friend's image is downloaded
     *
     * @param user Instance of user/friend
@@ -250,6 +242,21 @@ private slots:
     void requestAutomaticUpdateIfMoved(GeoCoordinate position);
 
     /**
+    * @brief Route is parsed and is ready for further processing.
+    *
+    * @param route Route item containing parsed route details
+    */
+    void routeParsed(Route &route);
+
+    /**
+    * @brief Routes to geo coordinates.
+    *
+    * Uses map center coordinates as start point.
+    * @param endPointCoordinates end point geo coordinates
+    */
+    void routeTo(const GeoCoordinate &endPointCoordinates);
+
+    /**
     * @brief Slot for setting auto centering state.
     *
     * Calls gps to send last known position
@@ -272,12 +279,28 @@ private slots:
     void setGPS(bool enabled);
 
     /**
+    * @brief Slot for setting power saving state.
+    *
+    * @param enabled true if enabled, false otherwise
+    */
+    void setPowerSaving(bool enabled);
+
+    /**
     * @brief Automatic update interval timer timeout.
     *
     * Requests update location if user has moved.
     */
     void startAutomaticUpdate();
 
+    /**
+    * @brief Called when topmost window is changed
+    *
+    * Does set power saving state.
+    *
+    * @param isMainWindow True if MainWindow is the topmost one
+    */
+    void topmostWindowChanged(bool isMainWindow);
+
 /*******************************************************************************
  * SIGNALS
  ******************************************************************************/
@@ -342,11 +365,11 @@ private:
     bool m_automaticUpdateRequest;      ///< Flag for automatic update request
     bool m_userMoved;                   ///< Flag for user move
 
-#ifdef Q_WS_MAEMO_5
-    Application *m_app;                              ///< Pointer to Application
-#endif
+    QTimer *m_automaticUpdateIntervalTimer; ///< Automatic update interval timer
+
     FacebookAuthentication *m_facebookAuthenticator; ///< Instance for facebook authenticator
     GeocodingService *m_geocodingService;            ///< Instance of the geocoding service
+    GeoCoordinate m_lastUpdatedGPSPosition;          ///< Last updated GPS position
     GPSPosition *m_gps;                              ///< Instance of the gps position
     MainWindow *m_ui;                                ///< Instance of the MainWindow UI
     MapEngine *m_mapEngine;                          ///< MapEngine
@@ -354,10 +377,6 @@ private:
     RoutingService *m_routingService;  ///< Instance of the routing service
     SituareService *m_situareService;  ///< Instance of the situare server communication service
     MCE *m_mce;                        ///< Instance of the MCE
-
-    QTimer *m_automaticUpdateIntervalTimer; ///< Automatic update interval timer
-    GeoCoordinate m_lastUpdatedGPSPosition; ///< Last updated GPS position
-
 };
 
 #endif // ENGINE_H