Changed the names of panel opening slots and signals into "more" appropriate ones
[situare] / src / ui / tabbedpanel.h
index 58dbb17..aaeb990 100644 (file)
@@ -102,11 +102,13 @@ public slots:
     void closePanel();
 
     /**
-     * @brief Slot that shows the tab (and opens it if closed) with the desired widget
+     * @brief Slot that opens the panel
+     *
+     * If widget pointer is provided the corresponding tab is also set active
      *
      * @param widget Widget
      */
-    void showPanel(QWidget *widget);
+    void openPanel(QWidget *widget = 0);
 
     /**
      * @brief Slot to redraw the panel after window resize event
@@ -129,7 +131,7 @@ private slots:
     void setCurrentIndex(int index);
 
     /**
-     * @brief Internal slot used to track statemachine state
+     * @brief Internal slot used to set the panel state
      */
     void stateChanged();
 
@@ -161,7 +163,7 @@ signals:
     void panelOpened();
 
     /**
-     * @brief Signal that is sent to state machine when panel state must be changed
+     * @brief Signal that is sent when the panel state must be changed
      *
      * @sa openPanel
      * @sa closePanel
@@ -172,7 +174,7 @@ signals:
  * DATA MEMBERS
  ******************************************************************************/
 private:
-    bool m_isOpen;      ///< Boolean used to track the current state of the statemachine
+    bool m_open;                                    ///< Current state of the panel
 
     QPropertyAnimation *m_panelAnimation;           ///< Animation for panel state changes