creaButtonContainer: new structure to make easy the button settings

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

diff --git a/lib/maracasVisuLib/src/interface/wxWindows/widgets/creaButtonContainer/view/buttonManager.h b/lib/maracasVisuLib/src/interface/wxWindows/widgets/creaButtonContainer/view/buttonManager.h
index 8fe99e540419694ded3c36e892b1cd24f60adb82..d08cbdc63e3479fea4b1c607c79b02c782c6f437 100644 (file)
--- a/lib/maracasVisuLib/src/interface/wxWindows/widgets/creaButtonContainer/view/buttonManager.h
+++ b/lib/maracasVisuLib/src/interface/wxWindows/widgets/creaButtonContainer/view/buttonManager.h
@@ -2,7 +2,7 @@
  * @file buttonManager.h
  * @brief This contains the ButtonManager class.
  * @author Diego CACERES (diego.caceres[AT]creatis.insa-lyon.fr)
- * @date  2011-05-19
+ * @date  2011-05-24
  */
 
 #ifndef CARTOBUTTONCONTAINER_H
@@ -29,8 +29,7 @@ namespace creaButtonContainer
        {
                /*! @class ButtonManager buttonManager.h "buttonManager.h"
                 *      @brief This class contains the ButtonManager view.
-                *  @details This class describes a wxFlexGridSizer with the button manager, it derives from wxFlexGridSizer and it is the
-                *  controller in the MVC.
+                *  @details This class describes a wxFlexGridSizer with the button manager.
                 *  @see <a href="http://docs.wxwidgets.org/stable/wx_wxflexGridSizer.html">wxFlexGridSizer</a>
                 */
                class ButtonManager : public wxFlexGridSizer
@@ -56,7 +55,8 @@ namespace creaButtonContainer
                        public:
                                // ----------------------------------------------------------------------------------
                                /*! @fn ButtonManager( );
-                                * @brief This is the default construuctor.
+                                * @brief This is the default constructor.
+                                * @exception std::bad_alloc
                                 */
                                ButtonManager( );
                                // ----------------------------------------------------------------------------------
@@ -80,13 +80,14 @@ namespace creaButtonContainer
                                SetGroupName( wxStaticText* groupName );
                                // ----------------------------------------------------------------------------------
                                /*! @fn ShowButtonManager( );
-                                * @brief This function shows the ButtonManager
+                                * @brief This method shows the ButtonManager
                                 */
                                void
                                ShowButtonManager( );
                                // ----------------------------------------------------------------------------------
                                /*! @fn HideButtonManager( );
-                                * @brief This function hides the ButtonManager.
+                                * @brief This method hides the ButtonManager.
+                                * @exception std::bad_alloc
                                 */
                                void
                                HideButtonManager( );
@@ -94,7 +95,7 @@ namespace creaButtonContainer
                        private:
                                // ----------------------------------------------------------------------------------
                                /*! @fn SetButtonManager( ButtonContainer buttonContainer );
-                                * @brief This function set the buttons and it is private.
+                                * @brief This method set the buttons and it is private.
                                 * @param buttonContainer
                                 */
                                void