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