creaButtonContainer: doxygen 90%

[creaMaracasVisu.git] / lib / maracasVisuLib / src / interface / wxWindows / widgets / creaButtonContainer / view / buttonContainerPanel.h

diff --git a/lib/maracasVisuLib/src/interface/wxWindows/widgets/creaButtonContainer/view/buttonContainerPanel.h b/lib/maracasVisuLib/src/interface/wxWindows/widgets/creaButtonContainer/view/buttonContainerPanel.h
index 65f3db3ccb8f9198d15cd9c24b182dcc6c1e7a18..c65c693691b5f10212f15abf13188b67eb37c62d 100644 (file)
--- a/lib/maracasVisuLib/src/interface/wxWindows/widgets/creaButtonContainer/view/buttonContainerPanel.h
+++ b/lib/maracasVisuLib/src/interface/wxWindows/widgets/creaButtonContainer/view/buttonContainerPanel.h
@@ -46,79 +46,95 @@ namespace creaButtonContainer
         */
        namespace view
        {
+               /*! @class ButtonContainerController buttonContainerController.h "buttonContainerController.h"
+                *      @brief This class contains the ButtonContainerPanel controller.
+                *  @details This class describes the button events, it derives from wxEvtHandler and it is the
+                *  controller in the MVC.
+                *  @see <a href="http://docs.wxwidgets.org/stable/wx_wxscrolledWindow.html">wxScrolledWindow</a>
+                */
                class ButtonContainerPanel : public wxScrolledWindow
                {
                        public:
                                //typedef definition
-                               /*!     @typedef creaButtonContainer::model::TFunctor TFunctor;
-                                *      @brief Defines the TFunctor type.
+                               // ----------------------------------------------------------------------------------
+                               /*!     @typedef creaButtonContainer::view::ButtonGroup ButtonGroup;
+                                *      @brief Defines the ButtonGroup type.
                                 */
                                typedef creaButtonContainer::view::ButtonGroup ButtonGroup;
-                               /*!     @typedef creaButtonContainer::model::TFunctor TFunctor;
-                                *      @brief Defines the TFunctor type.
+                               // ----------------------------------------------------------------------------------
+                               /*!     @typedef creaButtonContainer::view::GroupManager GroupManager;
+                                *      @brief Defines the GroupManager type.
                                 */
                                typedef creaButtonContainer::view::GroupManager GroupManager;
-                               /*!     @typedef creaButtonContainer::model::TFunctor TFunctor;
-                                *      @brief Defines the TFunctor type.
+                               // ----------------------------------------------------------------------------------
+                               /*!     @typedef std::list< ButtonGroup* > ButtonGroupList;
+                                *      @brief Defines the ButtonGroupList type.
                                 */
                                typedef std::list< ButtonGroup* > ButtonGroupList;
-                               /*!     @typedef creaButtonContainer::model::TFunctor TFunctor;
-                                *      @brief Defines the TFunctor type.
+                               // ----------------------------------------------------------------------------------
+                               /*!     @typedef std::map< long, GroupManager* > GroupManagerList;
+                                *      @brief Defines the GroupManagerList type.
                                 */
                                typedef std::map< long, GroupManager* > GroupManagerList;
-                               /*!     @typedef creaButtonContainer::model::TFunctor TFunctor;
-                                *      @brief Defines the TFunctor type.
+                               // ----------------------------------------------------------------------------------
+                               /*!     @typedef wxFlexGridSizer Sizer;
+                                *      @brief Defines the Sizer type.
                                 */
                                typedef wxFlexGridSizer Sizer;
-                               /*!     @typedef creaButtonContainer::model::TFunctor TFunctor;
-                                *      @brief Defines the TFunctor type.
+                               // ----------------------------------------------------------------------------------
+                               /*!     @typedef std::list< long > KeyList;
+                                *      @brief Defines the KeyList type.
                                 */
                                typedef std::list< long > KeyList;
-                               /*!     @typedef creaButtonContainer::model::TFunctor TFunctor;
-                                *      @brief Defines the TFunctor type.
+                               // ----------------------------------------------------------------------------------
+                               /*!     @typedef creaButtonContainer::model::ContainerSettings ButtonGroupSettings;
+                                *      @brief Defines the ButtonGroupSettings type.
                                 */
                                typedef creaButtonContainer::model::ContainerSettings
                                    ButtonGroupSettings;
-                               /*!     @typedef creaButtonContainer::model::TFunctor TFunctor;
-                                *      @brief Defines the TFunctor type.
+                               // ----------------------------------------------------------------------------------
+                               /*!     @typedef creaButtonContainer::model::ButtonGroupFactory ButtonGroupFactory;
+                                *      @brief Defines the ButtonGroupFactory type.
                                 */
                                typedef creaButtonContainer::model::ButtonGroupFactory
                                    ButtonGroupFactory;
-                               /*!     @typedef creaButtonContainer::model::TFunctor TFunctor;
-                                *      @brief Defines the TFunctor type.
+                               // ----------------------------------------------------------------------------------
+                               /*!     creaButtonContainer::controller::ButtonContainerController BCController;
+                                *      @brief Defines the BCController type.
                                 */
                                typedef creaButtonContainer::controller::ButtonContainerController
                                    BCController;
+                               // ----------------------------------------------------------------------------------
                                //end of typedef definition
                        public:
                                /*! @fn ButtonContainerPanel( wxWindow* parent, ButtonGroupSettings* settings );
-                                *
-                                * @param parent
-                                * @param settings
+                                * @brief This is the parameterized constructor.
+                                * @param parent wxWindow pointer to parent.
+                                * @param settings ButtonGroupSettings Pointer to button container settings.
                                 */
                                ButtonContainerPanel( wxWindow* parent, ButtonGroupSettings* settings );
                                // ----------------------------------------------------------------------------------
                                /*! @fn ~ButtonContainerPanel( );
-                                *
+                                * @brief This is the destructor.
                                 */
                                virtual
                                ~ButtonContainerPanel( );
                                // ----------------------------------------------------------------------------------
                                /*! @fn SetGroupContainer( ButtonGroupList groupContainer );
-                                *
+                                * @brief This function sets the settings to the container.
                                 * @param groupContainer
                                 */
                                void
                                SetGroupContainer( ButtonGroupList groupContainer );
                                // ----------------------------------------------------------------------------------
                                /*! @fn PanelInit( );
-                                *
+                                *      This function initializes the panel.
                                 */
                                void
                                PanelInit( );
                                // ----------------------------------------------------------------------------------
                                /*! @fn FitSizer( );
-                                *
+                                * This function fits and organizes the sizer.
                                 */
                                void
                                FitSizer( );
@@ -126,10 +142,10 @@ namespace creaButtonContainer
                        public:
                                friend class creaButtonContainer::controller::ButtonContainerController;
                        private:
-                               GroupManagerList m_GroupManagerList;
-                               ButtonGroupList m_ButtonGroupList;
-                               BCController* m_ButtonCController;
-                               Sizer* m_Sizer;
+                               GroupManagerList m_GroupManagerList; //!<The container of managers.
+                               ButtonGroupList m_ButtonGroupList; //!<The list of button groups.
+                               BCController* m_ButtonCController; //!<Pontier to controller.
+                               Sizer* m_Sizer; //!<Pointer to wxSizer
                };
        }//ecapseman
 }//ecapseman