#2647 creaMaracasVisu Feature New Normal - Merge creaButtonContainer BRANCH

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

diff --git a/lib/maracasVisuLib/src/interface/wxWindows/widgets/creaButtonContainer/model/buttonGroupFactory.h b/lib/maracasVisuLib/src/interface/wxWindows/widgets/creaButtonContainer/model/buttonGroupFactory.h
index e9825bb1cc05493680c078d18a59b99c58368b96..bafea13a098ae10953c81e01dedcfe135b00a382 100644 (file)
--- a/lib/maracasVisuLib/src/interface/wxWindows/widgets/creaButtonContainer/model/buttonGroupFactory.h
+++ b/lib/maracasVisuLib/src/interface/wxWindows/widgets/creaButtonContainer/model/buttonGroupFactory.h
@@ -1,24 +1,44 @@
+/*# ---------------------------------------------------------------------
+ #
+ # 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 buttonGroupFactory.h
  * @brief Contains ButtonGroupFactory class
  * @author Diego CACERES (diego.caceres[AT]creatis.insa-lyon.fr)
- * @date  2011-05-19
+ * @date  2011-06-02
  */
 
 #ifndef BUTTONGROUPFACTORY_H
 #define BUTTONGROUPFACTORY_H
 
 #include <wx/window.h>
-#include <list>
-#include <map>
-#include <iostream>
-#include <exception>
 
 #include "system.h"
 #include "button.h"
 #include "buttonGroup.h"
 #include "containerSettings.h"
-#include "functor.h"
 
 /*!    @namespace <creaButtonContainer>
  *     @brief Contains the creaButtonContainer library included in creaMaracasVisu.
@@ -31,7 +51,6 @@ namespace creaButtonContainer
         */
        namespace model
        {
-
                /*! @class ButtonGroupFactory buttonGroupFactory.h "buttonGroupFactory.h"
                 *      @brief This class contains the ButtonGroup factory.
                 *  @details This class creates a container of group of buttons.
@@ -41,6 +60,7 @@ namespace creaButtonContainer
                {
                        public:
                                //typedef definition
+                               // ----------------------------------------------------------------------------------
                                /*!     @typedef creaButtonContainer::view::Button Button;
                                 *      @brief Defines the Button type.
                                 */
@@ -59,47 +79,49 @@ namespace creaButtonContainer
                                /*!     @typedef std::list< ButtonGroup* > ButtonGroupContainer;
                                 *      @brief Defines the ButtonGroupContainer type.
                                 */
-                               typedef std::list< ButtonGroup* > ButtonGroupContainer;
+                               typedef std::list<ButtonGroup*> ButtonGroupContainer;
                                // ----------------------------------------------------------------------------------
                                /*!     @typedef std::map< long, Button* > ButtonContainer;
                                 *      @brief Defines the ButtonContainer type.
                                 */
-                               typedef std::map< long, Button* > ButtonContainer;
+                               typedef std::map<long, Button*> ButtonContainer;
                                // ----------------------------------------------------------------------------------
                                //end of typedef definition
                        public:
                                /*!     @fn ButtonGroupFactory::ButtonGroupFactory( );
                                 *      @brief This is the default constructor.
                                 */
-                               ButtonGroupFactory( );
+                               ButtonGroupFactory();
                                // -------------------------------------------------------------------------------
                                /*!     @fn virtual ButtonGroupFactory::~ButtonGroupFactory( );
                                 *      @brief This is the destructor.
                                 */
                                virtual
-                               ~ButtonGroupFactory( );
+                               ~ButtonGroupFactory();
+
                                /*! @fn ButtonGroupContainer ButtonGroupFactory::CreateButtonGroupContainer( wxWindow* parent, ButtonGroupModel* settings );
-                                * @brief This function allows to create the ButtonGroupContainer.
+                                * @brief This method creates the ButtonGroupContainer.
                                 * @param parent the wxWindow* parent to be attached.
                                 * @param settings The Container settings.
                                 * @exception std::bad_alloc
                                 * @return ButtonGroupContainer The wx button group container.
                                 */
                                ButtonGroupContainer
-                               CreateButtonGroupContainer( wxWindow* parent,
-                                   ButtonGroupModel* settings );
+                               CreateButtonGroupContainer(wxWindow* parent,
+                                               ButtonGroupModel* settings);
                        private:
+
                                /*! @fn ButtonContainer ButtonGroupFactory::GetButtons( wxWindow* parent, ButtonList buttonModel );
-                                * @brief  This function allows to create a wx button container for a group.
+                                * @brief  This method creates a wx button container for a group.
                                 * @param parent the wxWindow* parent to be attached.
                                 * @param buttonModel The button list with its own information.
                                 * @exception std::bad_alloc
                                 * @return ButtonContainer The wx button container.
                                 */
                                ButtonContainer
-                               GetButtons( wxWindow* parent, ButtonList buttonModel );
+                               GetButtons(wxWindow* parent, ButtonList buttonModel);
                };
-       }//ecapseman
-}//ecapseman
+       }                               //ecapseman
+}                              //ecapseman
 
 #endif // CARTOBUTTONFACTORY_H