Added some debug traces

[situare] / src / ui / mainwindow.h

diff --git a/src/ui/mainwindow.h b/src/ui/mainwindow.h
index 7f40d92..602f7fb 100644 (file)
--- a/src/ui/mainwindow.h
+++ b/src/ui/mainwindow.h
@@ -1,33 +1,41 @@
 /*
-    Situare - A location system for Facebook
-    Copyright (C) 2010  Ixonos Plc. Authors:
+   Situare - A location system for Facebook
+   Copyright (C) 2010  Ixonos Plc. Authors:
 
-       Henri Lampela - henri.lampela@ixonos.com
-       Kaj Wallin - kaj.wallin@ixonos.com
+      Henri Lampela - henri.lampela@ixonos.com
+      Kaj Wallin - kaj.wallin@ixonos.com
 
-    Situare is free software; you can redistribute it and/or
-    modify it under the terms of the GNU General Public License
-    version 2 as published by the Free Software Foundation.
+   Situare is free software; you can redistribute it and/or
+   modify it under the terms of the GNU General Public License
+   version 2 as published by the Free Software Foundation.
 
-    Situare is distributed in the hope that it will be useful,
-    but WITHOUT ANY WARRANTY; without even the implied warranty of
-    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-    GNU General Public License for more details.
+   Situare is distributed in the hope that it will be useful,
+   but WITHOUT ANY WARRANTY; without even the implied warranty of
+   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+   GNU General Public License for more details.
+
+   You should have received a copy of the GNU General Public License
+   along with Situare; if not, write to the Free Software
+   Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301,
+   USA.
+*/
 
-    You should have received a copy of the GNU General Public License
-    along with Situare; if not, write to the Free Software
-    Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301,
-    USA.
- */
 
 #ifndef MAINWINDOW_H
 #define MAINWINDOW_H
 
 #include <QtGui/QMainWindow>
+#include <QWidget>
+#include <QDebug>
 
-class QMenu;
-class QAction;
+class QLabel;
+class QStackedWidget;
 
+/**
+* @Main Window Class
+*
+* @class MainWindow mainwindow.h "src/ui/mainwindow.h"
+*/
 class MainWindow : public QMainWindow
 {
     Q_OBJECT
@@ -36,12 +44,63 @@ public:
     MainWindow(QWidget *parent = 0);
     ~MainWindow();
 
+    /**
+    * @brief Widget Stack object for the List and Map Views
+    *
+    * @var situareViews
+    */
+    QStackedWidget *situareViews;
+
 private:
-    void createMenus();
+    /**
+    * @brief Private method to create List and Map views as a stacked widget
+    *
+    * @fn createViews
+    */
+    void createViews();
 
+    /**
+    * @brief Private method to create the Menu items
+    *
+    * @fn createMenus
+    */
+    void createMenus();
     QMenu *viewMenu;
+
+    /**
+    * @brief Action item for changing view to List View
+    *
+    * @var toListViewAct
+    */
     QAction *toListViewAct;
+    /**
+    * @brief Action item for changing view to Map View
+    *
+    * @var toMapViewAct
+    */
     QAction *toMapViewAct;
+
+    /**
+    * @brief DUMMY LABEL, REMOVE WHEN BOTH VIEWS ARE COMPLETE
+    *
+    * @var infoLabel
+    * @todo REMOVE THIS
+    */
+    QLabel *infoLabel;
+
+public slots:
+    /**
+    * @brief Private slot, which initiates toListViewAct action
+    *
+    * @fn toListView
+    */
+    void toListView();
+    /**
+    * @brief Private slot, which initiates toMapViewAct action
+    *
+    * @fn toMapView
+    */
+    void toMapView();
 };
 
 #endif // MAINWINDOW_H