#2502 creaMaracasVisu Feature New Normal - alternation between containers: button...

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

diff --git a/lib/maracasVisuLib/src/interface/wxWindows/widgets/creaPanelButtonContainer/creaPanelButtonContainer.h b/lib/maracasVisuLib/src/interface/wxWindows/widgets/creaPanelButtonContainer/creaPanelButtonContainer.h
index 6579b6332a435572d30d13648d70e676f38b10bd..f20232ba4ae9cdcd8f879af1ac374fc243df0a39 100644 (file)
--- a/lib/maracasVisuLib/src/interface/wxWindows/widgets/creaPanelButtonContainer/creaPanelButtonContainer.h
+++ b/lib/maracasVisuLib/src/interface/wxWindows/widgets/creaPanelButtonContainer/creaPanelButtonContainer.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 PanelButtonContainer
  * @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 PANELBUTTONCONTAINER_H_
@@ -30,13 +55,14 @@ namespace creaPanelButtonContainer
        {
                public:
                        //typedef definition.
-                       /*!     typedef creaButtonContainer::model::TFunctor TFunctor;
-                        *      @brief Defines the TFunctor type.
+                       // ----------------------------------------------------------------------------------
+                       /*!     typedef creaPanelButtonContainer::ButtonContainerSettings ButtonContainerSettings;
+                        *      @brief Defines the ButtonContainerSettings type.
                         */
                        typedef creaPanelButtonContainer::ButtonContainerSettings
                            ButtonContainerSettings;
-                       /*!     typedef creaButtonContainer::model::TFunctor TFunctor;
-                        *      @brief Defines the TFunctor type.
+                       /*!     typedef creaButtonContainer::view::ButtonContainerPanel ButtonContainerPanel;
+                        *      @brief Defines the ButtonContainerPanel type.
                         */
                        typedef creaButtonContainer::view::ButtonContainerPanel
                            ButtonContainerPanel;
@@ -46,11 +72,11 @@ namespace creaPanelButtonContainer
                        // ----------------------------------------------------------------------------------
                        /*! @fn PanelButtonContainer( wxWindow* parent, ButtonContainerSettings* bcSettings );
                         *      @brief This is the parameterized constructor.
-                        *      @param parent
-                        *      @param bcSettings
+                        *      @param parent The wxWindow pointer to parent
+                        *      @param bcSettings //The buttonContainerSettings
                         */
                        PanelButtonContainer( wxWindow* parent,
-                           ButtonContainerSettings* bcSettings );
+                           ButtonContainerSettings* bcSettings, int type );
                        // ----------------------------------------------------------------------------------
                        /*! @fn virtual PanelButtonContainer( );
                         *      @brief This is the destructor.
@@ -59,7 +85,7 @@ namespace creaPanelButtonContainer
                        ~PanelButtonContainer( );
                        // ----------------------------------------------------------------------------------
                        /*! @fn void UpdatePanel( const std::string &buttonName );
-                        *  @brief This method Updates the m_ButtonPanel for a panel
+                        *  @brief This method Updates the m_ButtonPanel to a panel
                         *  of the clicked button in creaButtonContainer.
                         *      @param buttonName
                         */
@@ -69,7 +95,7 @@ namespace creaPanelButtonContainer
                        /*! @fn void GenericButtonEvent( const std::string &buttonName );
                         *      @brief This method is the function that calls the panels contained in the buttons
                         *      (in creaButtonContainer is the function contained in the functors to be called back.
-                        *      @param buttonName
+                        *      @param buttonName The name of the button
                         */
                        void
                        GenericButtonEvent( const std::string &buttonName );
@@ -81,6 +107,7 @@ namespace creaPanelButtonContainer
                        ButtonContainerPanel* m_ButtonContainerPanel; //!<This is the panel with de buttons (creaButtonContainer)
                        wxAuiManager* m_AuiManager; //!<The AUI Manager for the panels.
                        wxPanel* m_ButtonPanel; //!<This is the panel used to contain the panels of the buttons. (it changes with the buttonAction)
+               DECLARE_EVENT_TABLE() //!<Event Table declaration.
        };
 }//ecapseman