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