2345 creaMaracasVisu Feature Test Phase Normal Ruler01XY

[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 7a84073a14b563757e8685d014e7ab9401df151a..4d6ddb97dfea1b76d7d2753820f9545a3d25ae53 100644 (file)
--- a/lib/maracasVisuLib/src/interface/wxWindows/widgets/creaButtonContainer/model/containerSettings.h
+++ b/lib/maracasVisuLib/src/interface/wxWindows/widgets/creaButtonContainer/model/containerSettings.h
@@ -1,20 +1,42 @@
+/*# ---------------------------------------------------------------------
+#
+# Copyright (c) CREATIS (Centre de Recherche en Acquisition et Traitement de l'Image
+#                        pour la Sant�)
+# Authors : Eduardo Davila, Frederic Cervenansky, Claire Mouton
+# Previous Authors : Laurent Guigues, Jean-Pierre Roux
+# CreaTools website : www.creatis.insa-lyon.fr/site/fr/creatools_accueil
+#
+#  This software is governed by the CeCILL-B license under French law and
+#  abiding by the rules of distribution of free software. You can  use,
+#  modify and/ or redistribute the software under the terms of the CeCILL-B
+#  license as circulated by CEA, CNRS and INRIA at the following URL
+#  http://www.cecill.info/licences/Licence_CeCILL-B_V1-en.html
+#  or in the file LICENSE.txt.
+#
+#  As a counterpart to the access to the source code and  rights to copy,
+#  modify and redistribute granted by the license, users are provided only
+#  with a limited warranty  and the software's author,  the holder of the
+#  economic rights,  and the successive licensors  have only  limited
+#  liability.
+#
+#  The fact that you are presently reading this means that you have had
+#  knowledge of the CeCILL-B license and that you accept its terms.
+# ------------------------------------------------------------------------ */
+
 /*!
  * @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 "structBCSettings.h"
 #include "system.h"
-#include "functor.h"
 
 /*!    @namespace <creaButtonContainer>
  *     @brief Contains the creaButtonContainer library included in creaMaracasVisu.
@@ -101,12 +123,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
                                 */
@@ -122,8 +145,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.
                };
        }
 }