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

[creaMaracasVisu.git] / lib / maracasVisuLib / src / interface / wxWindows / widgets / creaButtonContainer / view / button.h

diff --git a/lib/maracasVisuLib/src/interface/wxWindows/widgets/creaButtonContainer/view/button.h b/lib/maracasVisuLib/src/interface/wxWindows/widgets/creaButtonContainer/view/button.h
index 45aeb4f4d83ee54e988c8cdf82275ff8169fc836..f323c4de5bd2b6a8053fec71145563a8d7d69cfb 100644 (file)
--- a/lib/maracasVisuLib/src/interface/wxWindows/widgets/creaButtonContainer/view/button.h
+++ b/lib/maracasVisuLib/src/interface/wxWindows/widgets/creaButtonContainer/view/button.h
@@ -1,22 +1,45 @@
+/*# ---------------------------------------------------------------------
+#
+# 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 button.h
  * @brief Contains the Button class.
  * @author Diego CACERES (diego.caceres[AT]creatis.insa-lyon.fr)
- * @date  2011-05-24
+ * @date  2011-06-02
  */
 
 #ifndef BUTTON_H
 #define BUTTON_H
 
+//#include <wx/listctrl.h>
 #include <wx/bmpbuttn.h>
 #include <wx/image.h>
 #include <wx/string.h>
-#include <string>
-#include <iostream>
-#include <exception>
-#include "functor.h"
-#include "system.h"
+#include <wx/bitmap.h>
 
+#include "system.h"
 
 /*!    @namespace <creaButtonContainer>
  *     @brief Contains the creaButtonContainer library included in creaMaracasVisu.
@@ -38,12 +61,15 @@ namespace creaButtonContainer
                {
                        public:
                                //typedef definition
+                               // ----------------------------------------------------------------------------------
                                /*!     @typedef creaButtonContainer::model::TFunctor TFunctor;
                                 *      @brief Defines the TFunctor type.
                                 */
                                typedef creaButtonContainer::model::TFunctor TFunctor;
+                               // ----------------------------------------------------------------------------------
                                //end of typedef definition
                        public:
+                               
                                // ----------------------------------------------------------------------------------
                                /*! @fn Button::Button( wxWindow* parent, long id, ButtonPair* pair );
                                 *      @brief This is the constructor.
@@ -70,21 +96,30 @@ namespace creaButtonContainer
                                 *      @brief This method returns the name of the button.
                                 *      @return std::string The name of the button.
                                 */
-                               std::string
+                               StringType
                                GetButtonName( );
+                               
+                               // ----------------------------------------------------------------------------------
+                               /*! @fn std::string Button::GetIconPath( );
+                                *      @brief This method returns the iconPath of the button.
+                                *      @return std::string The path of the icon.
+                                */
+                               BitmapType
+                               GetIcon( );
+
                                // ----------------------------------------------------------------------------------
                                /*! @fn std::string Button::GetIconPath( );
                                 *      @brief This method returns the iconPath of the button.
                                 *      @return std::string The path of the icon.
                                 */
-                               std::string
-                               GetIconPath( );
+                               //StringType
+                               //GetIconPath( );
                                // ----------------------------------------------------------------------------------
                                /*! @fn std::string Button::GetDescription( );
                                 *      @brief This method returns a the description of the button.
                                 *      @return std::string The tooltip of the button.
                                 */
-                               std::string
+                               StringType
                                GetDescription( );
                                // ----------------------------------------------------------------------------------
                                /*! @fn void Button::Execute( );
@@ -98,7 +133,8 @@ namespace creaButtonContainer
                                Execute( );
                                // ----------------------------------------------------------------------------------
                        private:
-                               ButtonPair* m_ButtonPair; //! <ButtonPair* ButtonPair pointer.
+                               ButtonPair* m_ButtonPair; //! <The pair with the button information.
+                               
                };
        }//ecapseman
 }//ecapseman