Feature #1606 Add a new entry to ColorLayerImageView to select the fitting mode betwe...

[creaMaracasVisu.git] / lib / maracasVisuLib / src / interface / wxWindows / widgets / creaPanelButtonContainer / creaPanelButtonContainer.h

diff --git a/lib/maracasVisuLib/src/interface/wxWindows/widgets/creaPanelButtonContainer/creaPanelButtonContainer.h b/lib/maracasVisuLib/src/interface/wxWindows/widgets/creaPanelButtonContainer/creaPanelButtonContainer.h
index 1872527620bd966a9da942477778a0bd6032151d..dffcdeb675ad933285a9f32987eef62c0c8441b7 100644 (file)
--- a/lib/maracasVisuLib/src/interface/wxWindows/widgets/creaPanelButtonContainer/creaPanelButtonContainer.h
+++ b/lib/maracasVisuLib/src/interface/wxWindows/widgets/creaPanelButtonContainer/creaPanelButtonContainer.h
@@ -2,7 +2,7 @@
  * @file PanelButtonContainer
  * @brief This contains the ButtonContainerSettings class.
  * @author Diego CACERES (diego.caceres[AT]creatis.insa-lyon.fr)
- * @date  2011-05-24
+ * @date  2011-06-02
  */
 
 #ifndef PANELBUTTONCONTAINER_H_
@@ -30,13 +30,14 @@ namespace creaPanelButtonContainer
        {
                public:
                        //typedef definition.
-                       /*!     typedef creaButtonContainer::model::TFunctor TFunctor;
-                        *      @brief Defines the TFunctor type.
+                       // ----------------------------------------------------------------------------------
+                       /*!     typedef creaPanelButtonContainer::ButtonContainerSettings ButtonContainerSettings;
+                        *      @brief Defines the ButtonContainerSettings type.
                         */
                        typedef creaPanelButtonContainer::ButtonContainerSettings
                            ButtonContainerSettings;
-                       /*!     typedef creaButtonContainer::model::TFunctor TFunctor;
-                        *      @brief Defines the TFunctor type.
+                       /*!     typedef creaButtonContainer::view::ButtonContainerPanel ButtonContainerPanel;
+                        *      @brief Defines the ButtonContainerPanel type.
                         */
                        typedef creaButtonContainer::view::ButtonContainerPanel
                            ButtonContainerPanel;
@@ -46,8 +47,8 @@ namespace creaPanelButtonContainer
                        // ----------------------------------------------------------------------------------
                        /*! @fn PanelButtonContainer( wxWindow* parent, ButtonContainerSettings* bcSettings );
                         *      @brief This is the parameterized constructor.
-                        *      @param parent
-                        *      @param bcSettings
+                        *      @param parent The wxWindow pointer to parent
+                        *      @param bcSettings //The buttonContainerSettings
                         */
                        PanelButtonContainer( wxWindow* parent,
                            ButtonContainerSettings* bcSettings );
@@ -59,17 +60,17 @@ namespace creaPanelButtonContainer
                        ~PanelButtonContainer( );
                        // ----------------------------------------------------------------------------------
                        /*! @fn void UpdatePanel( const std::string &buttonName );
-                        *  @brief This method Updates the m_ButtonPanel for a panel
+                        *  @brief This method Updates the m_ButtonPanel to a panel
                         *  of the clicked button in creaButtonContainer.
                         *      @param buttonName
                         */
                        void
                        UpdatePanel( const std::string &buttonName );
                        // ----------------------------------------------------------------------------------
-                       /*! @fn
+                       /*! @fn void GenericButtonEvent( const std::string &buttonName );
                         *      @brief This method is the function that calls the panels contained in the buttons
                         *      (in creaButtonContainer is the function contained in the functors to be called back.
-                        *      @param buttonName
+                        *      @param buttonName The name of the button
                         */
                        void
                        GenericButtonEvent( const std::string &buttonName );
@@ -81,6 +82,7 @@ namespace creaPanelButtonContainer
                        ButtonContainerPanel* m_ButtonContainerPanel; //!<This is the panel with de buttons (creaButtonContainer)
                        wxAuiManager* m_AuiManager; //!<The AUI Manager for the panels.
                        wxPanel* m_ButtonPanel; //!<This is the panel used to contain the panels of the buttons. (it changes with the buttonAction)
+               DECLARE_EVENT_TABLE() //!<Event Table declaration.
        };
 }//ecapseman