Added/Fixed commentation blocks to meed DoD requirements
[situare] / 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
8    Situare is free software; you can redistribute it and/or
9    modify it under the terms of the GNU General Public License
10    version 2 as published by the Free Software Foundation.
11
12    Situare is distributed in the hope that it will be useful,
13    but WITHOUT ANY WARRANTY; without even the implied warranty of
14    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15    GNU General Public License for more details.
16
17    You should have received a copy of the GNU General Public License
18    along with Situare; if not, write to the Free Software
19    Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301,
20    USA.
21 */
22
23
24 #ifndef MAINWINDOW_H
25 #define MAINWINDOW_H
26
27 #include <QtGui/QMainWindow>
28 #include <QWidget>
29 #include <QDebug>
30 #include <QObject>
31 #include "facebookservice/facebookauthentication.h"
32 #include "situareservice/situareservice.h"
33 #include <QNetworkAccessManager>
34 #include "listviewscreen.h"
35 #include "mapviewscreen.h"
36 #include "updatelocation/updatelocationdialog.h"
37 #include "ui/mainwindow.h"
38
39 class QLabel;
40 class QStackedWidget;
41
42 /**
43 * @brief Main Window Class
44 *
45 * @class MainWindow mainwindow.h "src/ui/mainwindow.h"
46 */
47 class MainWindow : public QMainWindow
48 {
49     Q_OBJECT
50
51 public:
52     /**
53     * @brief Constructor
54     *
55     * @param parent Parent
56     */
57     MainWindow(QWidget *parent = 0);
58
59     /**
60     * @brief Destructor
61     */
62     ~MainWindow();
63
64 /*******************************************************************************
65  * MEMBER FUNCTIONS AND SLOTS
66  ******************************************************************************/
67 public slots:
68     /**
69     * @brief Public slot, which open settings dialog
70     */
71      void openSettingsDialog();
72
73     /**
74     * @brief Public slot, which initiates toListViewAct action to switch view
75     */
76     void toListView();
77     /**
78     * @brief Public slot, which initiates toMapViewAct action to switch view
79     */
80     void toMapView();
81
82 private:
83     /**
84     * @brief Private method to create the Menu items
85     */
86     void createMenus();
87
88     /**
89     * @brief Private method to create List and Map views as a stacked widget
90     */
91     void createViews();
92
93     /**
94     * @brief Method used to switch active view.
95     *
96     * @param nextIndex 0 for listview, 1 for mapview
97     */
98     void switchView(int);
99
100 private slots:
101
102     /**
103     * @brief Private slot, which starts UpdateLocationDialog
104     *
105     */
106     void openLocationUpdateDialog();
107
108 /*******************************************************************************
109  * SIGNALS
110  ******************************************************************************/
111
112 signals:
113
114     /**
115     * @brief Signal for requesting reverseGeo from SituareEngine
116     *
117     */
118     void requestReverseGeo();
119
120     /**
121     * @brief Signals, when address data is ready
122     *
123     * @param address Street address
124     */
125     void reverseGeoReady(const QString &address);
126
127     /**
128     * @brief Signal for requestLocationUpdate from SituareEngine
129     *
130     * @param status Status message
131     * @param publish Publish on Facebook
132     */
133     void statusUpdate(const QString &status, const bool &publish);
134
135 /*******************************************************************************
136  * DATA MEMBERS
137  ******************************************************************************/
138
139 private:
140     ListViewScreen *m_listViewScreen; ///< Instance of the list view
141     UpdateLocationDialog *m_locationDialog; ///< Message dialog
142     MapViewScreen *m_mapViewScreen; ///< Instance of the map view
143     QStackedWidget *m_situareViews; ///< Stacked widget that hold both view widgets
144     QAction *m_toListViewAct; ///< Action to trigger switch to list view
145     QAction *m_toMapViewAct; ///< Action to trigger switch to map view
146     QAction *m_toSettingsAct; ///< Action to trigger switch to settings dialog
147     QMenu *m_viewMenu; ///< Object that hold the view menu items
148 };
149
150 #endif // MAINWINDOW_H