creaButtonContainer: new structure to make easy the button settings

[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 c65c693691b5f10212f15abf13188b67eb37c62d..a074b53c38c8bda5cb887a69d725f3fd63e73ed2 100644 (file)
--- a/lib/maracasVisuLib/src/interface/wxWindows/widgets/creaButtonContainer/view/buttonContainerPanel.h
+++ b/lib/maracasVisuLib/src/interface/wxWindows/widgets/creaButtonContainer/view/buttonContainerPanel.h
@@ -2,7 +2,7 @@
  * @file buttonContainerController.h
  * @brief This contains the ButtonContainerController class
  * @author Diego CACERES (diego.caceres[AT]creatis.insa-lyon.fr)
- * @date  2011-05-19
+ * @date  2011-05-24
  */
 
 #ifndef BUTTONCONTAINERPANEL_H
@@ -46,11 +46,11 @@ 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 buttonContainerPanel.h "buttonContainerPanel.h"
+                *  @brief This class is the container of the creaButtonContainer.
+                *  @details This class derives from wxScrolledWindow and manages the view of the buttonContainer.
+                *  @bug The scrolled it doesn't work! (to be changed soon)
+                *  @see <a href="http://docs.wxwidgets.org/stable/wx_wxscrolledwindow.html">wxScrolledWindow</a>
                 */
                class ButtonContainerPanel : public wxScrolledWindow
                {
@@ -121,20 +121,21 @@ namespace creaButtonContainer
                                ~ButtonContainerPanel( );
                                // ----------------------------------------------------------------------------------
                                /*! @fn SetGroupContainer( ButtonGroupList groupContainer );
-                                * @brief This function sets the settings to the container.
+                                * @brief This method sets the settings to the container.
                                 * @param groupContainer
                                 */
                                void
                                SetGroupContainer( ButtonGroupList groupContainer );
                                // ----------------------------------------------------------------------------------
                                /*! @fn PanelInit( );
-                                *      This function initializes the panel.
+                                *      This method initializes the panel.
+                                *      @exception std::bad_alloc
                                 */
                                void
                                PanelInit( );
                                // ----------------------------------------------------------------------------------
                                /*! @fn FitSizer( );
-                                * This function fits and organizes the sizer.
+                                * This method fits and organizes the sizer.
                                 */
                                void
                                FitSizer( );