git.maemo.org Git - situare/blob - src/ui/mainwindow.h

   1 /*
   2    Situare - A location system for Facebook
   3    Copyright (C) 2010  Ixonos Plc. Authors:
   4
   5       Henri Lampela - henri.lampela@ixonos.com
   6       Kaj Wallin - kaj.wallin@ixonos.com
   7       Sami Rämö - sami.ramo@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 #ifndef MAINWINDOW_H
  25 #define MAINWINDOW_H
  26
  27 #include <QtGui/QMainWindow>
  28 #include <QUrl>
  29
  30 #include "network/networkcookiejar.h"
  31 #include "panelsidebar.h"
  32
  33 class QGraphicsScene;
  34 class QLabel;
  35 class QWebView;
  36
  37 class FacebookAuthentication;
  38 class FriendListPanel;
  39 class MapScene;
  40 class MapView;
  41 class SituareService;
  42 class User;
  43 class UserInfoPanel;
  44 class ZoomButtonPanel;
  45 class SettingsDialog;
  46 class QToolButton;
  47
  48 /**
  49 * @brief Main Window Class
  50 */
  51 class MainWindow : public QMainWindow
  52 {
  53     Q_OBJECT
  54
  55 public:
  56     /**
  57     * @brief Constructor
  58     *
  59     * @param parent Parent
  60     */
  61     MainWindow(QWidget *parent = 0);
  62
  63     /**
  64     * @brief Destructor
  65     *
  66     */
  67     ~MainWindow();
  68
  69 /*******************************************************************************
  70  * BASE CLASS INHERITED AND REIMPLEMENTED MEMBER FUNCTIONS
  71  ******************************************************************************/
  72 private:
  73     /**
  74       * @brief HW increase and decrease key presses are grabbed and used for zooming the map.
  75       */
  76     void keyPressEvent(QKeyEvent* event);
  77
  78 /*******************************************************************************
  79  * MEMBER FUNCTIONS AND SLOTS
  80  ******************************************************************************/
  81 public:
  82     /**
  83     * @brief Clears cookie jar
  84     *
  85     */
  86     void clearCookieJar();
  87
  88     /**
  89     * @brief
  90     *
  91     * @param logged
  92     */
  93     void loggedIn(bool logged);
  94
  95     /**
  96     * @brief Enable / disable auto centering button.
  97     *
  98     * @param enabled true if shoud be enabled, false otherwise
  99     */
 100     void setAutoCenteringButtonEnabled(bool enabled);
 101
 102     /**
 103     * @brief Enable / disable GPS button.
 104     *
 105     * Does set visibilities for manual location cursor and auto centering menu button.
 106     *
 107     * @param enabled true if enabled, false otherwise
 108     */
 109     void setGPSButtonEnabled(bool enabled);
 110
 111     /**
 112       * @brief Set scene for MapView
 113       *
 114       * @param scene Scene to be set
 115       */
 116     void setMapViewScene(QGraphicsScene *scene);
 117
 118     /**
 119     * @brief Show Maemo information box with message.
 120     *
 121     * @param message Information message
 122     * @param modal Modal = true, non-modal false
 123     */
 124     void showMaemoInformationBox(const QString &message, bool modal=false);
 125
 126     /**
 127     * @brief Gets the username from member variable for saving purposes
 128     *
 129     * @return QString Username
 130     */
 131     const QString username();
 132
 133 public slots:
 134     /**
 135     * @brief Slot to intercept signal when login has failed (loginFailure signal)
 136     *
 137     */
 138     void loginFailed();
 139
 140     /**
 141     * @brief Slot to intercept signal when login with cookies is requested
 142     *
 143     */
 144     void loginUsingCookies();
 145
 146     /**
 147     * @brief Public slot, which open settings dialog
 148     */
 149     void openSettingsDialog();
 150
 151     /**
 152     * @brief Sets username to member variable for login dialog
 153     *
 154     * @param username Username to be set
 155     */
 156     void setUsername(const QString &username);
 157
 158     /**
 159     * @brief Public slot to intercept signal when old cerdentials are invalid or credentials
 160     *        doesn't exist yet
 161     *
 162     * @param url Login page url
 163     */
 164     void startLoginProcess(const QUrl &url);
 165
 166     /**
 167     * @brief Toggle progress indicator.
 168     *
 169     * @param state true if progress indicator should be shown, false otherwise
 170     */
 171     void toggleProgressIndicator(bool state);
 172
 173     /**
 174     * @brief Shows / hides Situare related UI items
 175     *
 176     * @param show
 177     */
 178     void updateItemVisibility(bool show);
 179
 180 private:
 181     /**
 182       * @brief Build fullscreen toggle button and connect slots
 183       */
 184     void buildFullScreenButton();
 185
 186     /**
 187       * @brief Build friend list panel and connect slots
 188       */
 189     void buildFriendListPanel();
 190
 191     /**
 192       * @brief Build manual location setting cross hair and connect slots
 193       */
 194     void buildManualLocationCrosshair();
 195
 196     /**
 197       * @brief Build map and connect slots
 198       */
 199     void buildMap();
 200
 201     /**
 202       * @brief Build OSM license and connect slots
 203       */
 204     void buildOsmLicense();
 205
 206     /**
 207       * @brief Build user info panel and connect slots
 208       */
 209     void buildUserInfoPanel();
 210
 211     /**
 212     * @brief Build webview and connect slots
 213     *
 214     */
 215     void buildWebView();
 216
 217     /**
 218       * @brief Build zoom button panel and connect slots
 219       */
 220     void buildZoomButtonPanel();
 221
 222     /**
 223     * @brief Private method to create the Menu items
 224     */
 225     void createMenus();
 226
 227     /**
 228       * @brief Grab or release HW increase and decrease buttons.
 229       *
 230       * @param grab Use true for grabbing and false for releasing the keys
 231       */
 232     void grabZoomKeys(bool grab);
 233
 234     /**
 235       * @brief Set own location crosshair visibility
 236       *
 237       * @param visible
 238       */
 239     void setOwnLocationCrosshairVisibility(bool visible);
 240
 241 private slots:
 242     /**
 243     * @brief Slot for drawing the fullscreen toggle button
 244     *
 245     * @param size Size of the screen
 246     */
 247     void drawFullScreenButton(const QSize &size);
 248
 249     /**
 250     * @brief Slot for drawing the Open Street Map license text
 251     *
 252     * @param size Size of the screen
 253     */
 254     void drawOsmLicense(const QSize &size);
 255
 256     /**
 257     * @brief Slot for drawing the own location crosshair
 258     *
 259     * @param width Width of the viewport
 260     * @param height Height of the viewport
 261     */
 262     void drawOwnLocationCrosshair(int width, int height);
 263
 264     /**
 265     * @brief Slot for gps timeout.
 266     *
 267     * Called when request timeout occurs.
 268     */
 269     void gpsTimeout();
 270
 271     /**
 272     * @brief Slot to load cookies from settings
 273     *
 274     */
 275     void loadCookies();
 276
 277     /**
 278     * @brief Slot to intercept signal when webview has finished loading webpage
 279     *
 280     * @param done Status of the loading
 281     */
 282     void loadDone(bool done);
 283
 284     /**
 285     * @brief Slot to save cookies to settings
 286     *
 287     */
 288     void saveCookies();
 289
 290     /**
 291     * @brief Set correnct view port size to datamembers
 292     *
 293     * @param width Width of the viewport
 294     * @param height Height of the viewport
 295     */
 296     void setViewPortSize(const int width, const int height);
 297
 298     /**
 299     * @brief Toggle between fullscreen and normal window mode
 300     */
 301     void toggleFullScreen();
 302
 303 /*******************************************************************************
 304  * SIGNALS
 305  ******************************************************************************/
 306 signals:
 307     /**
 308     * @brief Automatic centering setting changed by user
 309     *
 310     * @param enabled True if automatic centering is enabled, otherwise false
 311     */
 312     void autoCenteringTriggered(bool enabled);
 313
 314     /**
 315     * @brief Signal that indicates when user has cancelled login process
 316     *
 317     */
 318     void cancelLoginProcess();
 319
 320     /**
 321     * @brief View should be centered to new location
 322     *
 323     * @param sceneCoordinate Scene coordinates of the new center point
 324     */
 325     void centerToSceneCoordinates(QPoint sceneCoordinate);
 326
 327     /**
 328     * @brief Signal for enabling automatic location update.
 329     *
 330     * @param enabled true if enabled, false otherwise
 331     * @param updateIntervalMsecs update interval in milliseconds
 332     */
 333     void enableAutomaticLocationUpdate(bool enabled, int updateIntervalMsecs);
 334
 335     /**
 336     * @brief Signal for requesting username from settings
 337     *
 338     */
 339     void fetchUsernameFromSettings();
 340
 341     /**
 342     * @brief Signal for finding user.
 343     *
 344     * @param coordinates user geo coordinates
 345     */
 346     void findUser(const QPointF &coordinates);
 347
 348     /**
 349     * @brief GPS setting changed
 350     *
 351     * @param enabled True if GPS is enabled, otherwise false
 352     */
 353     void gpsTriggered(bool enabled);
 354
 355     /**
 356     * @brief Signal for finding friend.
 357     *
 358     * @param coordinates friend's geo coordinates
 359     */
 360     void findFriend(const QPointF &coordinates);
 361
 362     /**
 363     * @brief Signal for friend location ready.
 364     *
 365     * @param friendsList
 366     */
 367     void friendsLocationsReady(QList<User *> &friendsList);
 368
 369     /**
 370     * @brief Signal is emitted when location item is clicked.
 371     *
 372     * @param userIDs list of friends user IDs in the group
 373     */
 374     void locationItemClicked(const QList<QString> &userIDs);
 375
 376     /**
 377     * @brief Signals when Login/Logout action is pressed
 378     *
 379     */
 380     void loginActionPressed();
 381
 382     /**
 383     * @brief MapView has been resized
 384     *
 385     * @param size view size
 386     */
 387     void mapViewResized(const QSize &size);
 388
 389     /**
 390       * @brief Forwarding signal from MapView to MapEngine
 391       *
 392       * @param sceneCoordinate
 393       */
 394     void mapViewScrolled(QPoint sceneCoordinate);
 395
 396     /**
 397       * @brief Forwarding signal from MapEngine to MapView
 398       */
 399     void maxZoomLevelReached();
 400
 401     /**
 402     * @brief Signal that informs that user's message/location failed to update on Situare server
 403     *        This signal is originally sended from SituareService with name error
 404     *        Signal is renamed on MainWindow
 405     */
 406     void messageSendingFailed(const QString &error);
 407
 408     /**
 409       * @brief Forwarding signal from MapEngine to MapView
 410       */
 411     void minZoomLevelReached();
 412
 413     /**
 414     * @brief Signal that used to inform user that his message/location update tp Situare server
 415     *        was failed.
 416     *        This signal is originally sended from UserInfo
 417     */
 418     void notificateUpdateFailing(const QString &message);
 419
 420     /**
 421     * @brief Signal for refreshing user data.
 422     *
 423     */
 424     void refreshUserData();
 425
 426     /**
 427     * @brief Signal for requesting reverseGeo from SituareEngine
 428     *
 429     */
 430     void requestReverseGeo();
 431
 432     /**
 433     * @brief Signals, when address data is ready
 434     *
 435     * @param address Street address
 436     */
 437     void reverseGeoReady(const QString &address);
 438
 439     /**
 440     * @brief Signal to save username to settings
 441     *
 442     * @param username Username
 443     */
 444     void saveUsername(const QString &username);
 445
 446     /**
 447     * @brief Signal for requestLocationUpdate from SituareEngine
 448     *
 449     * @param status Status message
 450     * @param publish Publish on Facebook
 451     */
 452     void statusUpdate(const QString &status, const bool &publish);
 453
 454     /**
 455     * @brief Signals when webview's urlChanged signal is emitted
 456     *
 457     * @param url New url
 458     */
 459     void updateCredentials(const QUrl &url);
 460
 461     /**
 462     * @brief Signals when updateLocation request finished successfully
 463     *
 464     */
 465     void updateWasSuccessful();
 466
 467     /**
 468     * @brief MapView has finished zooming
 469     */
 470     void viewZoomFinished();
 471
 472     /**
 473     * @brief Signal for use location ready.
 474     *
 475     * @param user User object
 476     */
 477     void userLocationReady(User *user);
 478
 479     /**
 480     * @brief Map zoom in request
 481     */
 482     void zoomIn();
 483
 484     /**
 485       * @brief Forwarding signal from MapEngine to MapView
 486       */
 487     void zoomLevelChanged(int zoomLevel);
 488
 489     /**
 490     * @brief Map zoom out request
 491     */
 492     void zoomOut();
 493
 494 /*******************************************************************************
 495  * DATA MEMBERS
 496  ******************************************************************************/
 497 private:
 498     bool m_drawOwnLocationCrosshair;        ///< Flag for making ownLocationCrosshair visible or not
 499     bool m_loggedIn;                        ///< Indicates login state
 500     bool m_refresh;                         ///< Indicates when webpage is refreshed
 501
 502     int m_viewPortHeight;                   ///< Height of view port
 503     int m_viewPortWidth;                    ///< Width of view port
 504
 505     QAction *m_autoCenteringAct;            ///< Action to auto center map using gps position
 506     QAction *m_gpsToggleAct;                ///< Action to trigger gps toggle
 507     QAction *m_loginAct;                    ///< Action to Login/Logout
 508     QAction *m_toSettingsAct;               ///< Action to trigger switch to settings dialog
 509
 510     QLabel *m_osmLicense;                   ///< Label for Open Street Map license
 511     QLabel *m_ownLocationCrosshair;         ///< Label that show ownLocationCrosshair
 512
 513     QMenu *m_viewMenu;                      ///< Object that hold the view menu items
 514
 515     QString m_email;                        ///< Placeholder for email
 516     QString m_password;                     ///< Placeholder for password
 517
 518     QToolButton *m_fullScreenButton;        ///< Instance of the fullscreen toggle button
 519
 520     QWebView *m_webView;                    ///< Shows facebook login page
 521
 522     FriendListPanel *m_friendsListPanel;    ///< Instance of friends list panel
 523     MapView *m_mapView;                     ///< Instance of the map view
 524     NetworkCookieJar *m_cookieJar;          ///< Placeholder for QNetworkCookies
 525     PanelSideBar *m_userPanelSidebar;       ///< User panel side bar
 526     PanelSideBar *m_friendsListPanelSidebar;///< Friends panel side bar
 527     UserInfoPanel *m_userPanel;             ///< Instance of the user information panel
 528     ZoomButtonPanel *m_zoomButtonPanel;     ///< Instance of zoom button panel
 529
 530     SettingsDialog *m_settingsDialog;       ///< Settings dialog
 531 };
 532
 533 #endif // MAINWINDOW_H