1 /*# ---------------------------------------------------------------------
3 # Copyright (c) CREATIS (Centre de Recherche en Acquisition et Traitement de l'Image
5 # Authors : Eduardo Davila, Frederic Cervenansky, Claire Mouton
6 # Previous Authors : Laurent Guigues, Jean-Pierre Roux
7 # CreaTools website : www.creatis.insa-lyon.fr/site/fr/creatools_accueil
9 # This software is governed by the CeCILL-B license under French law and
10 # abiding by the rules of distribution of free software. You can use,
11 # modify and/ or redistribute the software under the terms of the CeCILL-B
12 # license as circulated by CEA, CNRS and INRIA at the following URL
13 # http://www.cecill.info/licences/Licence_CeCILL-B_V1-en.html
14 # or in the file LICENSE.txt.
16 # As a counterpart to the access to the source code and rights to copy,
17 # modify and redistribute granted by the license, users are provided only
18 # with a limited warranty and the software's author, the holder of the
19 # economic rights, and the successive licensors have only limited
22 # The fact that you are presently reading this means that you have had
23 # knowledge of the CeCILL-B license and that you accept its terms.
24 # ------------------------------------------------------------------------ */
28 * @brief Contains the Button class.
29 * @author Diego CACERES (diego.caceres[AT]creatis.insa-lyon.fr)
36 #include <wx/bmpbuttn.h>
38 #include <wx/string.h>
42 /*! @namespace <creaButtonContainer>
43 * @brief Contains the creaButtonContainer library included in creaMaracasVisu.
45 namespace creaButtonContainer
47 /*! @namespace <creaButtonContainer::view>
48 * @brief Contains the implementation of the view in creaButtonContainer library.
49 * @see <a href="http://en.wikipedia.org/wiki/Model-view-controller">MVC Software Architecture</a>
53 /*! @class Button button.h "button.h"
54 * @brief This class contains the Button in the view perspective.
55 * @details This class contains the information of a button, it derives from wxBitmapButton.
56 * @see <a href="http://docs.wxwidgets.org/stable/wx_wxbitmapbutton.html">wxBitmapButton</a>
58 class Button : public wxBitmapButton
62 // ----------------------------------------------------------------------------------
63 /*! @typedef creaButtonContainer::model::TFunctor TFunctor;
64 * @brief Defines the TFunctor type.
66 typedef creaButtonContainer::model::TFunctor TFunctor;
67 // ----------------------------------------------------------------------------------
68 //end of typedef definition
70 // ----------------------------------------------------------------------------------
71 /*! @fn Button::Button( wxWindow* parent, long id, ButtonPair* pair );
72 * @brief This is the constructor.
73 * @param parent The wxWindow* parent.
74 * @param id The wxID of the button.
75 * @param pair The button information.
77 Button( wxWindow* parent, long id, ButtonPair* pair );
78 // ----------------------------------------------------------------------------------
79 /*! @fn virtual Button::~Button( );
80 * @brief This is the destructor.
84 // ----------------------------------------------------------------------------------
85 /*! @fn long Button::GetID( );
86 * @brief This method gets the wxID of the button.
87 * @return long wxID of the button.
91 // ----------------------------------------------------------------------------------
92 /*! @fn std::string Button::GetButtonName( );
93 * @brief This method returns the name of the button.
94 * @return std::string The name of the button.
98 // ----------------------------------------------------------------------------------
99 /*! @fn std::string Button::GetIconPath( );
100 * @brief This method returns the iconPath of the button.
101 * @return std::string The path of the icon.
105 // ----------------------------------------------------------------------------------
106 /*! @fn std::string Button::GetDescription( );
107 * @brief This method returns a the description of the button.
108 * @return std::string The tooltip of the button.
112 // ----------------------------------------------------------------------------------
113 /*! @fn void Button::Execute( );
114 * @brief This method executes the Functor (Call_Back Function).
115 * This is the event of the button that it was defined to be called remotely using
116 * call_back functions. In this project it was implemented using Functors.
117 * @exception std::bad_alloc
122 // ----------------------------------------------------------------------------------
124 ButtonPair* m_ButtonPair; //! <The pair with the button information.