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 This contains the ButtonGroup class.
29 * @author Diego CACERES (diego.caceres[AT]creatis.insa-lyon.fr)
37 #include <wx/stattext.h>
45 /*! @namespace <creaButtonContainer>
46 * @brief Contains the creaButtonContainer library included in creaMaracasVisu.
48 namespace creaButtonContainer
50 /*! @namespace <creaButtonContainer::view>
51 * @brief Contains the implementation of the view in creaButtonContainer library.
52 * @see <a href="http://en.wikipedia.org/wiki/Model-view-controller">MVC Software Architecture</a>
56 /*! @class ButtonGroup buttonGroup.h "buttonGroup.h"
57 * @brief This class contains the group of buttons.
63 // ----------------------------------------------------------------------------------
64 /*! @typedef creaButtonContainer::view::Button Button;
65 * @brief Defines the Button type.
67 typedef creaButtonContainer::view::Button Button;
68 // ----------------------------------------------------------------------------------
69 /*! @typedef std::map< long, Button* > ButtonContainer;
70 * @brief Defines the ButtonContainer type.
72 typedef std::map< long, Button* > ButtonContainer;
73 // ----------------------------------------------------------------------------------
74 /*! typedef std::list< long > IdButtonContainer;
75 * @brief Defines the IdButtonContainer type.
77 typedef std::list< long > IdButtonContainer;
79 // ----------------------------------------------------------------------------------
80 /*! @fn ButtonGroup( wxStaticText* groupName, ButtonContainer buttons );
81 * @brief This is the parameterized constructor.
82 * @param groupName wxStatigText* with the name of the group.
83 * @param buttons A container with buttons.
85 ButtonGroup( wxStaticText* groupName, ButtonContainer buttons );
86 // ----------------------------------------------------------------------------------
87 /*! @fn ~ButtonGroup( );
88 * @brief This is the destructor.
92 // ----------------------------------------------------------------------------------
93 /*! @fn GetButton( long id );
94 * @brief This method returns a Button*
95 * @param id The ID of the button.
100 // ----------------------------------------------------------------------------------
101 /*! @fn GetButtonContainer( );
102 * @brief This method returns the button container.
103 * @exception std::bad_alloc
104 * @return ButtonContainer.
107 GetButtonContainer( );
108 // ----------------------------------------------------------------------------------
109 /*! @fn GetButtonIdContainer( );
110 * @brief This method returns a list of button IDs.
111 * @exception std::bad_alloc
115 GetButtonIdContainer( );
116 // ----------------------------------------------------------------------------------
117 /*! @fn GetGroupName( );
118 * @brief This method returns the name of the group.
123 // ----------------------------------------------------------------------------------
125 wxStaticText* m_GroupName; //!<A pointer with the wxStaticText of name of the group.
126 ButtonContainer m_Buttons; //!<A container with buttons.
131 #endif // BUTTONGROUP_H