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
 241     /**
 242      * @brief Build location search panel and connect signals
 243      */
 244     void buildLocationSearchPanel();
 245
 246     /**
 247      * @brief Build map and connect slots
 248      */
 249     void buildMap();
 250
 251     /**
 252      * @brief Build map scale and connect slots
 253      */
 254     void buildMapScale();
 255
 256     /**
 257      * @brief Build OSM license and connect slots
 258      */
 259     void buildOsmLicense();
 260
 261     /**
 262      * @brief Build application panels
 263      */
 264     void buildPanels();
 265
 266     /**
 267      * @brief Build routing panel and connect slots
 268      */
 269     void buildRoutingPanel();
 270
 271     /**
 272      * @brief Build user info panel and connect slots
 273      */
 274     void buildUserInfoPanel();
 275
 276     /**
 277      * @brief Build webview and connect slots
 278      */
 279     void buildWebView();
 280
 281     /**
 282      * @brief Build zoom button panel and connect slots
 283      */
 284     void buildZoomButtonPanel();
 285
 286     /**
 287      * @brief Private method to create the Menu items
 288      */
 289     void createMenus();
 290
 291     /**
 292      * @brief Grab or release HW increase and decrease buttons.
 293      *
 294      * @param grab Use true for grabbing and false for releasing the keys
 295      */
 296     void grabZoomKeys(bool grab);
 297
 298     /**
 299      * @brief Queues dialog/information box
 300      *
 301      * @param dialog Dialog to be added into queue
 302      */
 303     void queueDialog(QDialog *dialog);
 304
 305     /**
 306      * @brief Shows queued error information box
 307      *
 308      */
 309     void showErrorInformationBox();
 310
 311     /**
 312      * @brief Shows queued information box
 313      *
 314      * @fn showInformationBox
 315      */
 316     void showInformationBox();
 317
 318 private slots:
 319     /**
 320      * @brief Slot for automatic update dialog finished.
 321      *
 322      * @result result code
 323      */
 324     void automaticUpdateDialogFinished(int result);
 325
 326     /**
 327      * @brief Slot to intercept signal when dialog/information note is processed
 328      *
 329      * @param status Status of the dialog
 330      */
 331     void dialogFinished(int status);
 332
 333     /**
 334      * @brief Slot for drawing the fullscreen toggle button
 335      *
 336      * @param size Size of the screen
 337      */
 338     void drawFullScreenButton(const QSize &size);
 339
 340     /**
 341      * @brief Slot for drawing the map distance scale
 342      *
 343      * @param size Size of the screen
 344      */
 345     void drawMapScale(const QSize &size);
 346
 347     /**
 348      * @brief Slot for drawing the Open Street Map license text
 349      *
 350      * @param size Size of the screen
 351      */
 352     void drawOsmLicense(const QSize &size);
 353
 354     /**
 355      * @brief Slot to intercept signal when error dialog/information note is processed
 356      *
 357      * @param status Status of the dialog
 358      */
 359     void errorDialogFinished(int status);
 360
 361     /**
 362      * @brief Slot for gps timeout.
 363      *
 364      * Called when request timeout occurs.
 365      */
 366     void gpsTimeout();
 367
 368     /**
 369      * @brief Slot to load cookies from settings
 370      */
 371     void loadCookies();
 372
 373     /**
 374      * @brief Slot to intercept signal when webview has finished loading webpage
 375      *
 376      * @param done Status of the loading
 377      */
 378     void loadDone(bool done);
 379
 380     /**
 381     * @brief Called when map center point horizontal shifting is changed
 382     *
 383     * @param shifting New shifting value
 384     */
 385     void mapCenterHorizontalShiftingChanged(int shifting);
 386
 387     /**
 388      * @brief Move the crosshair
 389      */
 390     void moveCrosshair();
 391
 392     /**
 393      * @brief Slot to save cookies to settings
 394      */
 395     void saveCookies();
 396
 397     /**
 398      * @brief Slot for settings dialog accepted.
 399      */
 400     void settingsDialogAccepted();
 401
 402     /**
 403      * @brief Start location search (open search dialog)
 404      */
 405     void startLocationSearch();
 406
 407     /**
 408      * @brief Toggle between fullscreen and normal window mode
 409      */
 410     void toggleFullScreen();
 411
 412     /**
 413      * @brief Slot to intercept signal from webview's networkaccessmanager
 414      *
 415      * @param reply Network reply (contains errors)
 416      */
 417     void webViewRequestFinished(QNetworkReply* reply);
 418
 419 /*******************************************************************************
 420  * SIGNALS
 421  ******************************************************************************/
 422 signals:
 423     /**
 424      * @brief Automatic centering setting changed by user
 425      *
 426      * @param enabled True if automatic centering is enabled, otherwise false
 427      */
 428     void autoCenteringTriggered(bool enabled);
 429
 430     /**
 431      * @brief Signal that indicates when user has cancelled login process
 432      *
 433      */
 434     void cancelLoginProcess();
 435
 436     /**
 437      * @brief Signal for centering to coordinates.
 438      *
 439      * @param coordinates geo coordinates to center to.
 440      */
 441     void centerToCoordinates(const GeoCoordinate &coordinates);
 442
 443     /**
 444      * @brief View should be centered to new location
 445      *
 446      * @param coordinate Scene coordinates of the new center point
 447      */
 448     void centerToSceneCoordinates(const SceneCoordinate &coordinate);
 449
 450     /**
 451     * @brief Emitted when route is cleared
 452     */
 453     void clearRoute();
 454
 455     /**
 456     * @brief Signal when direction and distance from current map center point to current GPS
 457     *        location is changed
 458     *
 459     * @param direction Direction in degrees
 460     * @param distance Distance in meters
 461     * @param draw Should the indicator triangle be drawn or not
 462     */
 463     void directionIndicatorValuesUpdate(qreal direction, qreal distance, bool draw);
 464
 465     /**
 466      * @brief Signal for enabling automatic location update.
 467      *
 468      * @param enabled true if enabled, false otherwise
 469      * @param updateIntervalMsecs update interval in milliseconds
 470      */
 471     void enableAutomaticLocationUpdate(bool enabled, int updateIntervalMsecs = 0);
 472
 473     /**
 474      * @brief Signals error
 475      *
 476      * @param context error context
 477      * @param error error code
 478      */
 479     void error(const int context, const int error);
 480
 481     /**
 482      * @brief Signal for requesting username from settings
 483      *
 484      */
 485     void fetchUsernameFromSettings();
 486
 487     /**
 488      * @brief Signals when friend's profile image is ready
 489      *
 490      * @param user Friend
 491      */
 492     void friendImageReady(User *user);
 493
 494     /**
 495      * @brief GPS setting changed
 496      *
 497      * @param enabled True if GPS is enabled, otherwise false
 498      */
 499     void gpsTriggered(bool enabled);
 500
 501     /**
 502      * @brief Signal for friend location ready.
 503      *
 504      * @param friendsList
 505      */
 506     void friendsLocationsReady(QList<User *> &friendsList);
 507
 508     /**
 509     * @brief Emited when location request is parsed and is ready for further processing
 510     *
 511     * @param result List of Location items
 512     */
 513     void locationDataParsed(const QList<Location> &result);
 514
 515     /**
 516      * @brief Signal is emitted when location item is clicked on map.
 517      *
 518      * @param userIDs list of friends user IDs in the group
 519      */
 520     void locationItemClicked(const QList<QString> &userIDs);
 521
 522     /**
 523      * @brief Signal is emitted when location item is clicked in list.
 524      *
 525      * @param swBound south-west bound in GeoCoorinate
 526      * @param neBound north-east bound in GeoCoordinate
 527      */
 528     void locationItemClicked(const GeoCoordinate &swBound, const GeoCoordinate &neBound);
 529
 530     /**
 531      * @brief Signals when Login/Logout action is pressed
 532      *
 533      */
 534     void loginActionPressed();
 535
 536     /**
 537      * @brief MapView has been resized
 538      *
 539      * @param size view size
 540      */
 541     void mapViewResized(const QSize &size);
 542
 543     /**
 544      * @brief Forwarding signal from MapView to MapEngine
 545      *
 546      * @param coordinate New center point coordinate
 547      */
 548     void mapViewScrolled(const SceneCoordinate &coordinate);
 549
 550     /**
 551      * @brief Forwarding signal from MapEngine to MapView
 552      */
 553     void maxZoomLevelReached();
 554
 555     /**
 556      * @brief Forwarding signal from MapEngine to MapView
 557      */
 558     void minZoomLevelReached();
 559
 560     /**
 561      * @brief Forwarding signal from MapEngine to MapScale
 562      */
 563     void newMapResolution(qreal scale);
 564
 565     /**
 566      * @brief Signal for refreshing user data.
 567      *
 568      */
 569     void refreshUserData();
 570
 571     /**
 572      * @brief Signal for requesting reverseGeo from SituareEngine
 573      *
 574      */
 575     void requestReverseGeo();
 576
 577     /**
 578      * @brief Signals, when address data is ready
 579      *
 580      * @param address Street address
 581      */
 582     void reverseGeoReady(const QString &address);
 583
 584     /**
 585     * @brief Emited when route is parsed and is ready for further processing
 586     *
 587     * @param route Route item containing parsed route details
 588     */
 589     void routeParsed(Route &route);
 590
 591     /**
 592     * @brief Signal for routing to geo coordinates.
 593     *
 594     * @param coordinates destination geo coordinates
 595     */
 596     void routeTo(const GeoCoordinate &coordinates);
 597
 598     /**
 599     * @brief Request routing to current cursor position
 600     */
 601     void routeToCursor();
 602
 603     /**
 604      * @brief Signal to save username to settings
 605      *
 606      * @param username Username
 607      */
 608     void saveUsername(const QString &username);
 609
 610     /**
 611      * @brief Signal for location search
 612      *
 613      * @param location QString location
 614      */
 615     void searchForLocation(QString location);
 616
 617     /**
 618      * @brief Signal for requestLocationUpdate from SituareEngine
 619      *
 620      * @param status Status message
 621      * @param publish Publish on Facebook
 622      */
 623     void statusUpdate(const QString &status, const bool &publish);
 624
 625     /**
 626      * @brief Signals when webview's urlChanged signal is emitted
 627      *
 628      * @param url New url
 629      */
 630     void updateCredentials(const QUrl &url);
 631
 632     /**
 633      * @brief Signals when updateLocationDialog's data must be cleared
 634      *
 635      */
 636     void clearUpdateLocationDialogData();
 637
 638     /**
 639     * @brief Dragging mode triggered.
 640     */
 641     void draggingModeTriggered();
 642
 643     /**
 644      * @brief MapView has finished zooming
 645      */
 646     void viewZoomFinished();
 647
 648     /**
 649      * @brief Signal for use location ready.
 650      *
 651      * @param user User object
 652      */
 653     void userLocationReady(User *user);
 654
 655     /**
 656      * @brief Map zoom in request
 657      */
 658     void zoomIn();
 659
 660     /**
 661      * @brief Forwarding signal from MapEngine to MapView
 662      */
 663     void zoomLevelChanged(int zoomLevel);
 664
 665     /**
 666      * @brief Map zoom out request
 667      */
 668     void zoomOut();
 669
 670 /*******************************************************************************
 671  * DATA MEMBERS
 672  ******************************************************************************/
 673 private:
 674     bool m_errorShown;                      ///< Indicates if error dialog/note is shown
 675     bool m_loggedIn;                        ///< Indicates login state
 676     bool m_refresh;                         ///< Indicates when webpage is refreshed
 677
 678     int m_mapCenterHorizontalShifting;      ///< Amount of map center point horizontal shifting
 679     int m_progressIndicatorCount;           ///< Indicates the number of progress indicator calls
 680
 681     QAction *m_gpsToggleAct;                ///< Action to trigger gps toggle
 682     QAction *m_loginAct;                    ///< Action to Login/Logout
 683     QAction *m_toSettingsAct;               ///< Action to trigger switch to settings dialog
 684
 685     QLabel *m_crosshair;                    ///< Label for center point crosshair
 686     QLabel *m_osmLicense;                   ///< Label for Open Street Map license
 687
 688     QList<QDialog *> m_error_queue;         ///< QList type error dialog queue
 689     QList<QDialog *> m_queue;               ///< QList type dialog queue
 690
 691     QMenu *m_viewMenu;                      ///< Object that hold the view menu items
 692
 693     QMessageBox *m_automaticUpdateLocationDialog;   ///< Automatic update location dialog
 694
 695     QString m_email;                        ///< Placeholder for email
 696     QString m_password;                     ///< Placeholder for password
 697
 698     QWebView *m_webView;                    ///< Shows facebook login page
 699
 700     FriendListPanel *m_friendsListPanel;    ///< Instance of friends list panel
 701     FullScreenButton *m_fullScreenButton;   ///< Instance of the fullscreen toggle button
 702     IndicatorButtonPanel *m_indicatorButtonPanel;   ///< Instance of direction indicator button
 703     LocationSearchPanel *m_locationSearchPanel;     ///< Location search panel
 704     MapScale *m_mapScale;                   ///< Instance of the map scale
 705     MapView *m_mapView;                     ///< Instance of the map view
 706     NetworkCookieJar *m_cookieJar;          ///< Placeholder for QNetworkCookies
 707     RoutingPanel *m_routingPanel;           ///< Instance of routing panel
 708     TabbedPanel *m_tabbedPanel;             ///< Widget for tabbed panels
 709     UserInfoPanel *m_userInfoPanel;         ///< Instance of the user information panel
 710     ZoomButtonPanel *m_zoomButtonPanel;     ///< Instance of zoom button panel
 711 };
 712
 713 #endif // MAINWINDOW_H