creaButtonContainer & creaPanelButtonContainer: Updates in doxygen documentation...

[creaMaracasVisu.git] / lib / maracasVisuLib / src / interface / wxWindows / widgets / creaButtonContainer / model / containerSettings.h

diff --git a/lib/maracasVisuLib/src/interface/wxWindows/widgets/creaButtonContainer/model/containerSettings.h b/lib/maracasVisuLib/src/interface/wxWindows/widgets/creaButtonContainer/model/containerSettings.h
index e180dc12d5fa4fb0dd2bd4c6aeae75b62e7123ac..8be486179452cd03c315f2ea756ea1679e0dc907 100644 (file)
--- a/lib/maracasVisuLib/src/interface/wxWindows/widgets/creaButtonContainer/model/containerSettings.h
+++ b/lib/maracasVisuLib/src/interface/wxWindows/widgets/creaButtonContainer/model/containerSettings.h
@@ -2,20 +2,16 @@
  * @file containerSettings.h
  * @brief Contains the ContainerSettings class
  * @author Diego CACERES (diego.caceres[AT]creatis.insa-lyon.fr)
- * @date  2011-05-24
+ * @date  2011-06-02
  */
 
 #ifndef BUTTONGROUPSETTINGS_H_
 #define BUTTONGROUPSETTINGS_H_
 
-#include <list>
-#include <map>
 #include <vector>
-#include <iostream>
-#include <exception>
+
 #include "structBCSettings.h"
 #include "system.h"
-#include "functor.h"
 
 /*!    @namespace <creaButtonContainer>
  *     @brief Contains the creaButtonContainer library included in creaMaracasVisu.
@@ -102,12 +98,13 @@ namespace creaButtonContainer
                                 * @exception std::bad_alloc
                                 */
                                void
-                               AddButton( const std::string & groupName, const std::string buttonName,
-                                   const std::string iconpath, const std::string buttonDescription,
+                               AddButton( const StringType & groupName, const StringType &buttonName,
+                                   const StringType &iconpath, const StringType &buttonDescription,
                                    FunctionEventType event );
                                // ----------------------------------------------------------------------------------
                                /*! @fn void AddButton( BCSettingsStruct* info );
-                                *      @brief This method adds a new button to the container.
+                                *      @brief This method adds a new button to the container using the
+                                *      BCSettingsStruct structure.
                                 *      @exception std::bad_alloc
                                 *      @param info
                                 */
@@ -123,8 +120,8 @@ namespace creaButtonContainer
                                AddButtons( BCStructVectorType infoList );
                                // ----------------------------------------------------------------------------------
                        private:
-                               ButtonGroupMap m_ButtonGroupContainer; //! <std::map< std::string, ButtonList > View pointer.
-                               KeyMapList m_GroupNameList; //! <ButtonContainerPanel View pointer.
+                               ButtonGroupMap m_ButtonGroupContainer; //! <The container with the group of buttons.
+                               KeyMapList m_GroupNameList; //! <The container with the name of the groups of buttons.
                };
        }
 }