2108 Bug Volume Rendering widget options are not stable

[creaMaracasVisu.git] / lib / maracasVisuLib / src / interface / wxWindows / widgets / creaPanelButtonContainer / buttonContainerSettings.h

diff --git a/lib/maracasVisuLib/src/interface/wxWindows/widgets/creaPanelButtonContainer/buttonContainerSettings.h b/lib/maracasVisuLib/src/interface/wxWindows/widgets/creaPanelButtonContainer/buttonContainerSettings.h
index fa94fd1d2342afb5d266d2643d07de944b847918..ef4819635b46eef281d65ff30cbd3c55e728fff5 100644 (file)
--- a/lib/maracasVisuLib/src/interface/wxWindows/widgets/creaPanelButtonContainer/buttonContainerSettings.h
+++ b/lib/maracasVisuLib/src/interface/wxWindows/widgets/creaPanelButtonContainer/buttonContainerSettings.h
@@ -1,16 +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 buttonContainerSettings.h
  * @brief This contains the ButtonContainerSettings class.
  * @author Diego CACERES (diego.caceres[AT]creatis.insa-lyon.fr)
- * @date  2011-05-24
+ * @date  2011-06-02
  */
 
 #ifndef BUTTONCONTAINERSETTINGS_H_
 #define BUTTONCONTAINERSETTINGS_H_
 
+#include <wx/panel.h>
+
 #include <list>
 #include <map>
-#include <wx/panel.h>
 #include <vector>
 #include <iostream>
 
@@ -30,6 +56,12 @@ namespace creaPanelButtonContainer
        {
                public:
                        //typedef definition.
+                       // ----------------------------------------------------------------------------------
+                       /*!     @typedef std::string* StringType;
+                        *      @brief Defines the StringType type.
+                        */
+                       typedef std::string StringType;
+                       // ----------------------------------------------------------------------------------
                        /*!     typedef creaButtonContainer::model::TFunctor TFunctor;
                         *      @brief Defines the TFunctor type.
                         */
@@ -124,7 +156,7 @@ namespace creaPanelButtonContainer
                        // ----------------------------------------------------------------------------------
                        /*! @fn ButtonGroupSettings* GetButtonGroupSettings( TFunctor* functor );
                         *      @brief this method return the settings the generic settings for creaButtonContainer.
-                        * @param functor
+                        * @param functor The function to be called in the action button.
                         * @exception std::bad_alloc
                         * @return
                         */
@@ -149,11 +181,11 @@ namespace creaPanelButtonContainer
                         const std::string &iconpath, const std::string &buttonDescription,
                         PanelButton panel );
                         * @brief This method adds a new button into a group of buttons.
-                        * @param groupName
-                        * @param buttonName
-                        * @param iconpath
-                        * @param buttonDescription
-                        * @param panel
+                        * @param groupName The button groupName
+                        * @param buttonName The buttonName
+                        * @param iconpath The path of the icon
+                        * @param buttonDescription The button tooltip
+                        * @param panel The panel to be called when the button is clicked
                         * @exception std::bad_alloc
                         */
                        void
@@ -163,7 +195,7 @@ namespace creaPanelButtonContainer
                        // ----------------------------------------------------------------------------------
                        /*! @fn void AddButton( BCPSettingsStruct* info );
                         * @brief This method adds a new button into a group of buttons.
-                        * @param info
+                        * @param info The pointer to BCPSettingsStruct.
                         * @exception std::bad_alloc
                         */
                        void
@@ -171,7 +203,7 @@ namespace creaPanelButtonContainer
                        // ----------------------------------------------------------------------------------
                        /*! @fn void AddButtons( BCStructVectorType infoList );
                         * @brief This method adds new buttons into the container.
-                        * @param infoList
+                        * @param infoList The BCStructVectorType
                         * @exception std::bad_alloc
                         */
                        void