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