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