#2509 creaMaracasVisu Feature New Normal - creaPanelButtonContainer ListPanel with...

[creaMaracasVisu.git] / lib / maracasVisuLib / src / interface / wxWindows / widgets / creaButtonContainer / controller / buttonContainerController.h

diff --git a/lib/maracasVisuLib/src/interface/wxWindows/widgets/creaButtonContainer/controller/buttonContainerController.h b/lib/maracasVisuLib/src/interface/wxWindows/widgets/creaButtonContainer/controller/buttonContainerController.h
index 2ccadcc86d9977515446ae241f71a0c18ccca88e..3cfc6efd08e707c1aa51bf44df251039d554410c 100644 (file)
--- a/lib/maracasVisuLib/src/interface/wxWindows/widgets/creaButtonContainer/controller/buttonContainerController.h
+++ b/lib/maracasVisuLib/src/interface/wxWindows/widgets/creaButtonContainer/controller/buttonContainerController.h
@@ -1,8 +1,33 @@
+/*# ---------------------------------------------------------------------
+#
+# 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 buttonContainerController.h
- * @brief This contains the ButtonContainerController class
+ * @brief Contains the ButtonContainerController class
  * @author Diego CACERES (diego.caceres[AT]creatis.insa-lyon.fr)
- * @date  2011-05-24
+ * @date  2011-06-02
  */
 
 #ifndef BUTTONCONTAINERCONTROLLER_H_
@@ -40,14 +65,14 @@ namespace creaButtonContainer
        {
                /*! @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.
+                *  @details This class describes the button events, it derives from wxEvtHandler.
                 *  @see <a href="http://docs.wxwidgets.org/stable/wx_wxevthandler.html">wxEvtHandler</a>
                 */
                class ButtonContainerController : public wxEvtHandler
                {
                        public:
                                //typedef definitions
+                               // ----------------------------------------------------------------------------------
                                /*!     @typedef creaButtonContainer::view::ButtonGroup ButtonGroup
                                 *      @brief Defines the ButtonGroup type
                                 */
@@ -88,6 +113,7 @@ namespace creaButtonContainer
                                 *      @brief Defines the BCPanel type
                                 */
                                typedef creaButtonContainer::view::ButtonContainerPanel BCPanel;
+                               // ----------------------------------------------------------------------------------
                                //end of typedef definition
                        public:
                                // ----------------------------------------------------------------------------------
@@ -105,7 +131,7 @@ namespace creaButtonContainer
 
                                // ----------------------------------------------------------------------------------
                                /*! @fn void AddEvents( );
-                                *      @brief This method connect every buttonEvent to the view.
+                                *      @brief This method connect every buttonEvents to the view.
                                 *      @exception std::bad_alloc
                                 */
                                void
@@ -127,6 +153,7 @@ namespace creaButtonContainer
                                void
                                ButtonEvent( wxCommandEvent& event );
                                // ----------------------------------------------------------------------------------
+
                        private:
                                BCPanel* m_BCPanel; //! <ButtonContainerPanel View pointer.
                };