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         Jussi Laitinen - jussi.laitinen@ixonos.com
   8         Sami Rämö - sami.ramo@ixonos.com
   9         Ville Tiensuu - ville.tiensuu@ixonos.com
  10         Katri Kaikkonen - katri.kaikkonen@ixonos.com
  11
  12     Situare is free software; you can redistribute it and/or
  13     modify it under the terms of the GNU General Public License
  14     version 2 as published by the Free Software Foundation.
  15
  16     Situare is distributed in the hope that it will be useful,
  17     but WITHOUT ANY WARRANTY; without even the implied warranty of
  18     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  19     GNU General Public License for more details.
  20
  21     You should have received a copy of the GNU General Public License
  22     along with Situare; if not, write to the Free Software
  23     Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301,
  24     USA.
  25 */
  26
  27 #ifndef MAINWINDOW_H
  28 #define MAINWINDOW_H
  29
  30 #include <QtGui/QMainWindow>
  31 #include <QUrl>
  32
  33 #include "network/networkcookiejar.h"
  34
  35 class QGraphicsScene;
  36 class QLabel;
  37 class QMessageBox;
  38 class QNetworkReply;
  39 class QToolButton;
  40 class QWebView;
  41
  42 class FacebookAuthentication;
  43 class FullScreenButton;
  44 class FriendListPanel;
  45 class IndicatorButtonPanel;
  46 class GeoCoordinate;
  47 class MapScale;
  48 class MapScene;
  49 class MapView;
  50 class RoutingPanel;
  51 class TabbedPanel;
  52 class SettingsDialog;
  53 class SceneCoordinate;
  54 class SituareService;
  55 class User;
  56 class UserInfoPanel;
  57 class ZoomButtonPanel;
  58 class Location;
  59
  60 /**
  61 * @brief Main Window Class
  62 */
  63 class MainWindow : public QMainWindow
  64 {
  65     Q_OBJECT
  66
  67 public:
  68     /**
  69      * @brief Constructor
  70      *
  71      * @param parent Parent
  72      */
  73     MainWindow(QWidget *parent = 0);
  74
  75     /**
  76      * @brief Destructor
  77      *
  78      */
  79     ~MainWindow();
  80
  81 /*******************************************************************************
  82  * BASE CLASS INHERITED AND REIMPLEMENTED MEMBER FUNCTIONS
  83  ******************************************************************************/
  84 private:
  85     /**
  86      * @brief HW increase and decrease key presses are grabbed and used for zooming the map.
  87      */
  88     void keyPressEvent(QKeyEvent* event);
  89
  90 /*******************************************************************************
  91  * MEMBER FUNCTIONS AND SLOTS
  92  ******************************************************************************/
  93 public:
  94     /**
  95      * @brief Clears cookie jar
  96      *
  97      */
  98     void clearCookieJar();
  99
 100     /**
 101      * @brief
 102      *
 103      * @param logged
 104      */
 105     void loggedIn(bool logged);
 106
 107     /**
 108      * @brief Gets the login state (logged in/logged out)
 109      *
 110      * @return bool Login state
 111      */
 112     bool loginState();
 113
 114     /**
 115      * @brief Reads automatic location update settings.
 116      */
 117     void readAutomaticLocationUpdateSettings();
 118
 119     /**
 120      * @brief Enable / disable GPS button.
 121      *
 122      * Does set visibilities for manual location cursor and auto centering menu button.
 123      *
 124      * @param enabled true if enabled, false otherwise
 125      */
 126     void setGPSButtonEnabled(bool enabled);
 127
 128     /**
 129      * @brief Enable / disable direction indicator button.
 130      *
 131      * @param enabled true if shoud be enabled, false otherwise
 132      */
 133     void setIndicatorButtonEnabled(bool enabled);
 134
 135     /**
 136      * @brief Set scene for MapView
 137      *
 138      * @param scene Scene to be set
 139      */
 140     void setMapViewScene(QGraphicsScene *scene);
 141
 142     /**
 143      * Shows dialog with enable automatic location update question.
 144      *
 145      * @param text text to show in dialog
 146      */
 147     void showEnableAutomaticUpdateLocationDialog(const QString &text);
 148
 149     /**
 150      * @brief Gets the username from member variable for saving purposes
 151      *
 152      * @return QString Username
 153      */
 154     const QString username();
 155
 156 public slots:
 157     /**
 158      * @brief Build direction indicator button panel and connect signals
 159      */
 160     void buildIndicatorButtonPanel();
 161
 162     /**
 163      * @brief Builds information box with message.
 164      *
 165      * @param message Information message
 166      * @param modal Modal = true, non-modal false
 167      */
 168     void buildInformationBox(const QString &message, bool modal=false);
 169
 170     /**
 171      * @brief Slot for failed login
 172      */
 173     void loginFailed();
 174
 175     /**
 176      * @brief Slot to intercept signal when login with cookies is requested
 177      */
 178     void loginUsingCookies();
 179
 180     /**
 181      * @brief Public slot, which open settings dialog
 182      */
 183     void openSettingsDialog();
 184
 185     /**
 186      * @brief Set own location crosshair visibility
 187      *
 188      * @param visible
 189      */
 190     void setOwnLocationCrosshairVisibility(bool visible);
 191
 192     /**
 193      * @brief Sets username to member variable for login dialog
 194      *
 195      * @param username Username to be set
 196      */
 197     void setUsername(const QString &username);
 198
 199     /**
 200      * @brief Method to show panels
 201      */
 202     void showPanels();
 203
 204     /**
 205      * @brief Public slot to intercept signal when old cerdentials are invalid or credentials
 206      *        doesn't exist yet
 207      *
 208      */
 209     void startLoginProcess();
 210
 211     /**
 212      * @brief Toggle progress indicator.
 213      *
 214      * @param state true if progress indicator should be shown, false otherwise
 215      */
 216     void toggleProgressIndicator(bool state);
 217
 218     /**
 219      * @brief Shows / hides Situare related UI items
 220      *
 221      */
 222     void updateItemVisibility();
 223
 224 private:
 225     /**
 226      * @brief Build fullscreen toggle button and connect slots
 227      */
 228     void buildFullScreenButton();
 229
 230     /**
 231      * @brief Build friend list panel and connect slots
 232      */
 233     void buildFriendListPanel();
 234
 235     /**
 236      * @brief Build manual location setting cross hair and connect slots
 237      */
 238     void buildManualLocationCrosshair();
 239
 240     /**
 241      * @brief Build map and connect slots
 242      */
 243     void buildMap();
 244
 245     /**
 246      * @brief Build map scale and connect slots
 247      */
 248     void buildMapScale();
 249
 250     /**
 251      * @brief Build OSM license and connect slots
 252      */
 253     void buildOsmLicense();
 254
 255     /**
 256      * @brief Build application panels
 257      */
 258     void buildPanels();
 259
 260     /**
 261      * @brief Build routing panel and connect slots
 262      */
 263     void buildRoutingPanel();
 264
 265     /**
 266      * @brief Build user info panel and connect slots
 267      */
 268     void buildUserInfoPanel();
 269
 270     /**
 271      * @brief Build webview and connect slots
 272      */
 273     void buildWebView();
 274
 275     /**
 276      * @brief Build zoom button panel and connect slots
 277      */
 278     void buildZoomButtonPanel();
 279
 280     /**
 281      * @brief Private method to create the Menu items
 282      */
 283     void createMenus();
 284
 285     /**
 286      * @brief Grab or release HW increase and decrease buttons.
 287      *
 288      * @param grab Use true for grabbing and false for releasing the keys
 289      */
 290     void grabZoomKeys(bool grab);
 291
 292     /**
 293      * @brief Queues dialog/information box
 294      *
 295      * @param dialog Dialog to be added into queue
 296      */
 297     void queueDialog(QDialog *dialog);
 298
 299     /**
 300      * @brief Shows queued error information box
 301      *
 302      */
 303     void showErrorInformationBox();
 304
 305     /**
 306      * @brief Shows queued information box
 307      *
 308      * @fn showInformationBox
 309      */
 310     void showInformationBox();
 311
 312 private slots:
 313     /**
 314      * @brief Slot for automatic update dialog finished.
 315      *
 316      * @result result code
 317      */
 318     void automaticUpdateDialogFinished(int result);
 319
 320     /**
 321      * @brief Slot to intercept signal when dialog/information note is processed
 322      *
 323      * @param status Status of the dialog
 324      */
 325     void dialogFinished(int status);
 326
 327     /**
 328      * @brief Slot for drawing the fullscreen toggle button
 329      *
 330      * @param size Size of the screen
 331      */
 332     void drawFullScreenButton(const QSize &size);
 333
 334     /**
 335      * @brief Slot for drawing the map distance scale
 336      *
 337      * @param size Size of the screen
 338      */
 339     void drawMapScale(const QSize &size);
 340
 341     /**
 342      * @brief Slot for drawing the Open Street Map license text
 343      *
 344      * @param size Size of the screen
 345      */
 346     void drawOsmLicense(const QSize &size);
 347
 348     /**
 349      * @brief Slot for drawing the own location crosshair
 350      *
 351      * @param size Size of the screen
 352      */
 353     void drawOwnLocationCrosshair(const QSize &size);
 354
 355     /**
 356      * @brief Slot to intercept signal when error dialog/information note is processed
 357      *
 358      * @param status Status of the dialog
 359      */
 360     void errorDialogFinished(int status);
 361
 362     /**
 363      * @brief Slot for gps timeout.
 364      *
 365      * Called when request timeout occurs.
 366      */
 367     void gpsTimeout();
 368
 369     /**
 370      * @brief Slot to load cookies from settings
 371      */
 372     void loadCookies();
 373
 374     /**
 375      * @brief Slot to intercept signal when webview has finished loading webpage
 376      *
 377      * @param done Status of the loading
 378      */
 379     void loadDone(bool done);
 380
 381     /**
 382      * @brief Slot to save cookies to settings
 383      */
 384     void saveCookies();
 385
 386     /**
 387      * @brief Slot for settings dialog accepted.
 388      */
 389     void settingsDialogAccepted();
 390
 391     /**
 392      * @brief Set correnct view port size to datamembers
 393      *
 394      * @param size Size of the screen
 395      */
 396     void setViewPortSize(const QSize &size);
 397
 398     /**
 399      * @brief Start location search (open search dialog)
 400      */
 401     void startLocationSearch();
 402
 403     /**
 404      * @brief Toggle between fullscreen and normal window mode
 405      */
 406     void toggleFullScreen();
 407
 408     /**
 409      * @brief Slot to intercept signal from webview's networkaccessmanager
 410      *
 411      * @param reply Network reply (contains errors)
 412      */
 413     void webViewRequestFinished(QNetworkReply* reply);
 414
 415 /*******************************************************************************
 416  * SIGNALS
 417  ******************************************************************************/
 418 signals:
 419     /**
 420      * @brief Automatic centering setting changed by user
 421      *
 422      * @param enabled True if automatic centering is enabled, otherwise false
 423      */
 424     void autoCenteringTriggered(bool enabled);
 425
 426     /**
 427      * @brief Signal that indicates when user has cancelled login process
 428      *
 429      */
 430     void cancelLoginProcess();
 431
 432     /**
 433      * @brief View should be centered to new location
 434      *
 435      * @param coordinate Scene coordinates of the new center point
 436      */
 437     void centerToSceneCoordinates(const SceneCoordinate &coordinate);
 438
 439     /**
 440     * @brief Signal when direction and distance from current map center point to current GPS
 441     *        location is changed
 442     *
 443     * @param direction Direction in degrees
 444     * @param distance Distance in meters
 445     * @param draw Should the indicator triangle be drawn or not
 446     */
 447     void directionIndicatorValuesUpdate(qreal direction, qreal distance, bool draw);
 448
 449     /**
 450      * @brief Signal for enabling automatic location update.
 451      *
 452      * @param enabled true if enabled, false otherwise
 453      * @param updateIntervalMsecs update interval in milliseconds
 454      */
 455     void enableAutomaticLocationUpdate(bool enabled, int updateIntervalMsecs = 0);
 456
 457     /**
 458      * @brief Signals error
 459      *
 460      * @param context error context
 461      * @param error error code
 462      */
 463     void error(const int context, const int error);
 464
 465     /**
 466      * @brief Signal for requesting username from settings
 467      *
 468      */
 469     void fetchUsernameFromSettings();
 470
 471     /**
 472      * @brief Signal for finding user.
 473      *
 474      * @param coordinates user geo coordinates
 475      */
 476     void findUser(const GeoCoordinate &coordinates);
 477
 478     /**
 479      * @brief Signals when friend's profile image is ready
 480      *
 481      * @param user Friend
 482      */
 483     void friendImageReady(User *user);
 484
 485     /**
 486      * @brief GPS setting changed
 487      *
 488      * @param enabled True if GPS is enabled, otherwise false
 489      */
 490     void gpsTriggered(bool enabled);
 491
 492     /**
 493      * @brief Signal for finding friend.
 494      *
 495      * @param coordinates friend's geo coordinates
 496      */
 497     void findFriend(const GeoCoordinate &coordinates);
 498
 499     /**
 500      * @brief Signal for friend location ready.
 501      *
 502      * @param friendsList
 503      */
 504     void friendsLocationsReady(QList<User *> &friendsList);
 505
 506     /**
 507     * @brief Emited when location request is parsed and is ready for further processing
 508     *
 509     * @param result List of Location items
 510     */
 511     void locationDataParsed(const QList<Location> &result);
 512
 513     /**
 514      * @brief Signal is emitted when location item is clicked on map.
 515      *
 516      * @param userIDs list of friends user IDs in the group
 517      */
 518     void locationItemClicked(const QList<QString> &userIDs);
 519
 520     /**
 521      * @brief Signal is emitted when location item is clicked in list.
 522      *
 523      * @param swBound south-west bound in GeoCoorinate
 524      * @param neBound north-east bound in GeoCoordinate
 525      */
 526     void locationItemClicked(const GeoCoordinate &swBound, const GeoCoordinate &neBound);
 527
 528     /**
 529      * @brief Signals when Login/Logout action is pressed
 530      *
 531      */
 532     void loginActionPressed();
 533
 534     /**
 535      * @brief MapView has been resized
 536      *
 537      * @param size view size
 538      */
 539     void mapViewResized(const QSize &size);
 540
 541     /**
 542      * @brief Forwarding signal from MapView to MapEngine
 543      *
 544      * @param coordinate
 545      */
 546     void mapViewScrolled(const SceneCoordinate &coordinate);
 547
 548     /**
 549      * @brief Forwarding signal from MapEngine to MapView
 550      */
 551     void maxZoomLevelReached();
 552
 553     /**
 554      * @brief Forwarding signal from MapEngine to MapView
 555      */
 556     void minZoomLevelReached();
 557
 558     /**
 559      * @brief Forwarding signal from MapEngine to MapScale
 560      */
 561     void newMapResolution(qreal scale);
 562
 563     /**
 564      * @brief Signal for refreshing user data.
 565      *
 566      */
 567     void refreshUserData();
 568
 569     /**
 570      * @brief Signal for requesting reverseGeo from SituareEngine
 571      *
 572      */
 573     void requestReverseGeo();
 574
 575     /**
 576      * @brief Signals, when address data is ready
 577      *
 578      * @param address Street address
 579      */
 580     void reverseGeoReady(const QString &address);
 581
 582     /**
 583     * @brief Signal for routing to geo coordinates.
 584     *
 585     * @param coordinates destination geo coordinates
 586     */
 587     void routeTo(const GeoCoordinate &coordinates);
 588
 589     /**
 590      * @brief Signal to save username to settings
 591      *
 592      * @param username Username
 593      */
 594     void saveUsername(const QString &username);
 595
 596     /**
 597      * @brief Signal for location search
 598      *
 599      * @param location QString location
 600      */
 601     void searchForLocation(QString location);
 602
 603     /**
 604      * @brief Signal for requestLocationUpdate from SituareEngine
 605      *
 606      * @param status Status message
 607      * @param publish Publish on Facebook
 608      */
 609     void statusUpdate(const QString &status, const bool &publish);
 610
 611     /**
 612      * @brief Signals when webview's urlChanged signal is emitted
 613      *
 614      * @param url New url
 615      */
 616     void updateCredentials(const QUrl &url);
 617
 618     /**
 619      * @brief Signals when updateLocationDialog's data must be cleared
 620      *
 621      */
 622     void clearUpdateLocationDialogData();
 623
 624     /**
 625     * @brief Dragging mode triggered.
 626     */
 627     void draggingModeTriggered();
 628
 629     /**
 630      * @brief MapView has finished zooming
 631      */
 632     void viewZoomFinished();
 633
 634     /**
 635      * @brief Signal for use location ready.
 636      *
 637      * @param user User object
 638      */
 639     void userLocationReady(User *user);
 640
 641     /**
 642      * @brief Map zoom in request
 643      */
 644     void zoomIn();
 645
 646     /**
 647      * @brief Forwarding signal from MapEngine to MapView
 648      */
 649     void zoomLevelChanged(int zoomLevel);
 650
 651     /**
 652      * @brief Map zoom out request
 653      */
 654     void zoomOut();
 655
 656 /*******************************************************************************
 657  * DATA MEMBERS
 658  ******************************************************************************/
 659 private:
 660     bool m_errorShown;                      ///< Indicates if error dialog/note is shown
 661     bool m_loggedIn;                        ///< Indicates login state
 662     bool m_refresh;                         ///< Indicates when webpage is refreshed
 663
 664     int m_progressIndicatorCount;           ///< Indicates the number of progress indicator calls
 665
 666     QAction *m_gpsToggleAct;                ///< Action to trigger gps toggle
 667     QAction *m_loginAct;                    ///< Action to Login/Logout
 668     QAction *m_toSettingsAct;               ///< Action to trigger switch to settings dialog
 669     QAction *m_searchLocationAct;           /// @todo this is temporary, remove when not needed!
 670
 671     QLabel *m_osmLicense;                   ///< Label for Open Street Map license
 672     QLabel *m_ownLocationCrosshair;         ///< Label that show ownLocationCrosshair
 673
 674     QList<QDialog *> m_error_queue;         ///< QList type error dialog queue
 675     QList<QDialog *> m_queue;               ///< QList type dialog queue
 676
 677     QMenu *m_viewMenu;                      ///< Object that hold the view menu items
 678
 679     QMessageBox *m_automaticUpdateLocationDialog;   ///< Automatic update location dialog
 680
 681     QSize m_viewPortSize;                 ///< Size of the viewport
 682
 683     QString m_email;                        ///< Placeholder for email
 684     QString m_password;                     ///< Placeholder for password
 685
 686     QWebView *m_webView;                    ///< Shows facebook login page
 687
 688     FriendListPanel *m_friendsListPanel;    ///< Instance of friends list panel
 689     FullScreenButton *m_fullScreenButton;   ///< Instance of the fullscreen toggle button
 690     IndicatorButtonPanel *m_indicatorButtonPanel;     ///< Instance of direction indicator button
 691     MapScale *m_mapScale;                   ///< Instance of the map scale
 692     MapView *m_mapView;                     ///< Instance of the map view
 693     NetworkCookieJar *m_cookieJar;          ///< Placeholder for QNetworkCookies
 694     RoutingPanel *m_routingPanel;           ///< Instance of routing panel
 695     TabbedPanel *m_tabbedPanel;             ///< Widget for tabbed panels
 696     UserInfoPanel *m_userInfoPanel;         ///< Instance of the user information panel
 697     ZoomButtonPanel *m_zoomButtonPanel;     ///< Instance of zoom button panel
 698 };
 699
 700 #endif // MAINWINDOW_H