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