3 * @brief This contains the ButtonGroup class.
4 * @author Diego CACERES (diego.caceres[AT]creatis.insa-lyon.fr)
12 #include <wx/stattext.h>
20 /*! @namespace <creaButtonContainer>
21 * @brief Contains the creaButtonContainer library included in creaMaracasVisu.
23 namespace creaButtonContainer
25 /*! @namespace <creaButtonContainer::view>
26 * @brief Contains the implementation of the view in creaButtonContainer library.
27 * @see <a href="http://en.wikipedia.org/wiki/Model-view-controller">MVC Software Architecture</a>
31 /*! @class ButtonGroup buttonGroup.h "buttonGroup.h"
32 * @brief This class contains the group of buttons.
38 // ----------------------------------------------------------------------------------
39 /*! @typedef creaButtonContainer::view::Button Button;
40 * @brief Defines the Button type.
42 typedef creaButtonContainer::view::Button Button;
43 // ----------------------------------------------------------------------------------
44 /*! @typedef std::map< long, Button* > ButtonContainer;
45 * @brief Defines the ButtonContainer type.
47 typedef std::map< long, Button* > ButtonContainer;
48 // ----------------------------------------------------------------------------------
49 /*! typedef std::list< long > IdButtonContainer;
50 * @brief Defines the IdButtonContainer type.
52 typedef std::list< long > IdButtonContainer;
54 // ----------------------------------------------------------------------------------
55 /*! @fn ButtonGroup( wxStaticText* groupName, ButtonContainer buttons );
56 * @brief This is the parameterized constructor.
57 * @param groupName wxStatigText* with the name of the group.
58 * @param buttons A container with buttons.
60 ButtonGroup( wxStaticText* groupName, ButtonContainer buttons );
61 // ----------------------------------------------------------------------------------
62 /*! @fn ~ButtonGroup( );
63 * @brief This is the destructor.
67 // ----------------------------------------------------------------------------------
68 /*! @fn GetButton( long id );
69 * @brief This method returns a Button*
70 * @param id The ID of the button.
75 // ----------------------------------------------------------------------------------
76 /*! @fn GetButtonContainer( );
77 * @brief This method returns the button container.
78 * @exception std::bad_alloc
79 * @return ButtonContainer.
82 GetButtonContainer( );
83 // ----------------------------------------------------------------------------------
84 /*! @fn GetButtonIdContainer( );
85 * @brief This method returns a list of button IDs.
86 * @exception std::bad_alloc
90 GetButtonIdContainer( );
91 // ----------------------------------------------------------------------------------
92 /*! @fn GetGroupName( );
93 * @brief This method returns the name of the group.
98 // ----------------------------------------------------------------------------------
100 wxStaticText* m_GroupName; //!<A pointer with the wxStaticText of name of the group.
101 ButtonContainer m_Buttons; //!<A container with buttons.
106 #endif // BUTTONGROUP_H