creaButtonContainer: new structure to make easy the button settings

[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 d49ac59233d4a230d29cdd6da8411993643a0f28..6579b6332a435572d30d13648d70e676f38b10bd 100644 (file)
--- a/lib/maracasVisuLib/src/interface/wxWindows/widgets/creaPanelButtonContainer/creaPanelButtonContainer.h
+++ b/lib/maracasVisuLib/src/interface/wxWindows/widgets/creaPanelButtonContainer/creaPanelButtonContainer.h
@@ -1,11 +1,9 @@
-/***************************************************************
- * Name:      pCartoGUIManager.h
- * Purpose:   Defines Application Frame
- * Author:    Diego CACERES (diego.caceres[AT]creatis.insa-lyon.fr)
- * Modified:  2011-05-09
- * Copyright: Diego CACERES (http://www.creatis.insa-lyon.fr/~caceres/)
- * License:
- **************************************************************/
+/*!
+ * @file PanelButtonContainer
+ * @brief This contains the ButtonContainerSettings class.
+ * @author Diego CACERES (diego.caceres[AT]creatis.insa-lyon.fr)
+ * @date  2011-05-24
+ */
 
 #ifndef PANELBUTTONCONTAINER_H_
 #define PANELBUTTONCONTAINER_H_
@@ -19,30 +17,70 @@
 #include "buttonContainerSettings.h"
 #include "functor.h"
 
+/*!    @namespace <creaPanelButtonContainer>
+ *     @brief Contains the creaPanelButtonContainer library included in creaMaracasVisu.
+ */
 namespace creaPanelButtonContainer
 {
-
-       typedef creaPanelButtonContainer::ButtonContainerSettings
-           ButtonContainerSettings;
-       typedef creaButtonContainer::view::ButtonContainerPanel ButtonContainerPanel;
+       /*! @class PanelButtonContainer panelButtonContainer.h "panelButtonContainer.h"
+        *      @brief This class contains the PanelButtonContainer. It derives from wxPanel.
+        *  @see <a href="http://docs.wxwidgets.org/stable/wx_wxpanel.html">wxPanel</a>
+        */
        class PanelButtonContainer : public wxPanel
        {
                public:
+                       //typedef definition.
+                       /*!     typedef creaButtonContainer::model::TFunctor TFunctor;
+                        *      @brief Defines the TFunctor type.
+                        */
+                       typedef creaPanelButtonContainer::ButtonContainerSettings
+                           ButtonContainerSettings;
+                       /*!     typedef creaButtonContainer::model::TFunctor TFunctor;
+                        *      @brief Defines the TFunctor type.
+                        */
+                       typedef creaButtonContainer::view::ButtonContainerPanel
+                           ButtonContainerPanel;
+                       // ----------------------------------------------------------------------------------
+                       //end of typedef definition.
+               public:
+                       // ----------------------------------------------------------------------------------
+                       /*! @fn PanelButtonContainer( wxWindow* parent, ButtonContainerSettings* bcSettings );
+                        *      @brief This is the parameterized constructor.
+                        *      @param parent
+                        *      @param bcSettings
+                        */
                        PanelButtonContainer( wxWindow* parent,
                            ButtonContainerSettings* bcSettings );
+                       // ----------------------------------------------------------------------------------
+                       /*! @fn virtual PanelButtonContainer( );
+                        *      @brief This is the destructor.
+                        */
                        virtual
                        ~PanelButtonContainer( );
+                       // ----------------------------------------------------------------------------------
+                       /*! @fn void UpdatePanel( const std::string &buttonName );
+                        *  @brief This method Updates the m_ButtonPanel for a panel
+                        *  of the clicked button in creaButtonContainer.
+                        *      @param buttonName
+                        */
                        void
                        UpdatePanel( const std::string &buttonName );
+                       // ----------------------------------------------------------------------------------
+                       /*! @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
+                        */
                        void
                        GenericButtonEvent( const std::string &buttonName );
+                       // ----------------------------------------------------------------------------------
                private:
                        //Settings
-                       ButtonContainerSettings* m_ButtonContainerSettings;
+                       ButtonContainerSettings* m_ButtonContainerSettings; //!<This is the buttonContainer settings.
                        //Panel
-                       ButtonContainerPanel* m_ButtonContainerPanel;
-                       wxAuiManager* m_AuiManager;
-                       wxPanel* m_ButtonPanel;
+                       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)
        };
 }//ecapseman