Added LocationSearchPanel (which is currently a copy of RoutingPanel)

[situare] / src / ui / routingpanel.h

diff --git a/src/ui/routingpanel.h b/src/ui/routingpanel.h
index 2f486d2..9bd7b99 100644 (file)
--- a/src/ui/routingpanel.h
+++ b/src/ui/routingpanel.h
@@ -3,6 +3,7 @@
     Copyright (C) 2010  Ixonos Plc. Authors:
 
         Jussi Laitinen - jussi.laitinen@ixonos.com
+        Sami Rämö - sami.ramo@ixonos.com
 
     Situare is free software; you can redistribute it and/or
     modify it under the terms of the GNU General Public License
@@ -38,6 +39,7 @@ class RouteWaypointListView;
  * @brief Class for sliding routing panel
  *
  * @author Jussi Laitinen - jussi.laitinen (at) ixonos.com
+ * @author Sami Rämö - sami.ramo (at) ixonos.com
  */
 class RoutingPanel : public PanelBase
 {
@@ -68,8 +70,14 @@ protected:
  * MEMBER FUNCTIONS AND SLOTS
  ******************************************************************************/
 private:
+    /**
+    * @brief Switch to search results view mode
+    */
     void showResultsView();
 
+    /**
+    * @brief Switch to routing instructions view mode
+    */
     void showRoutingView();
 
 private slots:
@@ -87,6 +95,9 @@ private slots:
     */
     void populateLocationListView(const QList<Location> &locations);
 
+    /**
+    * @brief Handler for route button toggling actions
+    */
     void routeButtonToggled(bool checked);
 
     /**
@@ -96,6 +107,9 @@ private slots:
     */
     void routeToSelectedLocation();
 
+    /**
+    * @brief Handler for search button toggling actions
+    */
     void searchLocationButtonToggled(bool checked);
 
     /**
@@ -160,17 +174,17 @@ signals:
  * DATA MEMBERS
  ******************************************************************************/
 private:
-    QLabel *m_resultsLabel;            ///< Location list label
+    QLabel *m_resultsLabel;                 ///< Location list label
 
-    QStackedLayout *m_views;
+    QStackedLayout *m_views;                ///< Views
 
-    QWidget *m_resultsView;
-    QWidget *m_routingView;
+    QWidget *m_resultsView;                 ///< Search results view widget
+    QWidget *m_routingView;                 ///< Routing instructions view widget
 
     ImageButton *m_routeButton;             ///< Route to location button
     ImageButton *m_searchLocationButton;    ///< Search location button
-    LocationListView *m_locationListView;   ///< Location list view
-    RouteWaypointListView *m_routeWaypointListView; ///< Route waypoint list view
+    LocationListView *m_locationListView;   ///< Search results list view
+    RouteWaypointListView *m_routeWaypointListView;     ///< Route instructions list view
 };
 
 #endif // ROUTINGPANEL_H