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