3 * @brief This contains the ButtonGroup class.
4 * @author Diego CACERES (diego.caceres[AT]creatis.insa-lyon.fr)
14 #include <wx/stattext.h>
18 /*! @namespace <creaButtonContainer>
19 * @brief Contains the creaButtonContainer library included in creaMaracasVisu.
21 namespace creaButtonContainer
23 /*! @namespace <creaButtonContainer::view>
24 * @brief Contains the implementation of the view in creaButtonContainer library.
25 * @see <a href="http://en.wikipedia.org/wiki/Model-view-controller">MVC Software Architecture</a>
29 /*! @class ButtonGroup buttonGroup.h "buttonGroup.h"
30 * @brief This class contains the group of buttons.
36 /*! @typedef creaButtonContainer::view::Button Button;
37 * @brief Defines the Button type.
39 typedef creaButtonContainer::view::Button Button;
40 // ----------------------------------------------------------------------------------
41 /*! @typedef std::map< long, Button* > ButtonContainer;
42 * @brief Defines the ButtonContainer type.
44 typedef std::map< long, Button* > ButtonContainer;
45 // ----------------------------------------------------------------------------------
46 /*! typedef std::list< long > IdButtonContainer;
47 * @brief Defines the IdButtonContainer type.
49 typedef std::list< long > IdButtonContainer;
51 // ----------------------------------------------------------------------------------
52 /*! @fn ButtonGroup( wxStaticText* groupName, ButtonContainer buttons );
53 * @brief This is the parameterized constructor.
54 * @param groupName wxStatigText* with the name of the group.
55 * @param buttons A container with buttons.
57 ButtonGroup( wxStaticText* groupName, ButtonContainer buttons );
58 // ----------------------------------------------------------------------------------
59 /*! @fn ~ButtonGroup( );
60 * @brief This is the destructor.
64 // ----------------------------------------------------------------------------------
65 /*! @fn GetButton( long id );
66 * @brief This method returns a Button*
67 * @param id The ID of the button.
72 // ----------------------------------------------------------------------------------
73 /*! @fn GetButtonContainer( );
74 * @brief This method returns the button container.
75 * @exception std::bad_alloc
76 * @return ButtonContainer.
79 GetButtonContainer( );
80 // ----------------------------------------------------------------------------------
81 /*! @fn GetButtonIdContainer( );
82 * @brief This method returns a list of button IDs.
83 * @exception std::bad_alloc
87 GetButtonIdContainer( );
88 // ----------------------------------------------------------------------------------
89 /*! @fn GetGroupName( );
90 * @brief This method returns the name of the group.
95 // ----------------------------------------------------------------------------------
97 wxStaticText* m_GroupName; //!<A pointer with the name of the group.
98 ButtonContainer m_Buttons; //!<A container with buttons.
103 #endif // BUTTONGROUP_H