]> Creatis software - creaMaracasVisu.git/blob - lib/maracasVisuLib/src/interface/wxWindows/widgets/creaButtonContainer/view/groupManager.h
creaButtonContainer: Documentation updates :) :). If you turns on the documentation...
[creaMaracasVisu.git] / lib / maracasVisuLib / src / interface / wxWindows / widgets / creaButtonContainer / view / groupManager.h
1 /*!
2  * @file groupManager.h
3  * @brief This contains the GroupManager class
4  * @author Diego CACERES (diego.caceres[AT]creatis.insa-lyon.fr)
5  * @date  2011-05-19
6  */
7
8 #ifndef GROUPMANAGER_H
9 #define GROUPMANAGER_H
10
11 #include <wx/sizer.h>
12 #include <wx/button.h>
13 #include <wx/stattext.h>
14 #include <wx/event.h>
15 #include <list>
16 #include <iostream>
17 #include "buttonManager.h"
18 #include "buttonGroup.h"
19 #include <wx/event.h>
20
21 /*!     @namespace <creaButtonContainer>
22  *      @brief Contains the creaButtonContainer library included in creaMaracasVisu.
23  */
24 namespace creaButtonContainer
25 {
26         /*! @namespace <creaButtonContainer::view>
27          *      @brief Contains the implementation of the view in creaButtonContainer library.
28          *      @see <a href="http://en.wikipedia.org/wiki/Model-view-controller">MVC Software Architecture</a>
29          */
30         namespace view
31         {
32                 class GroupManager : public wxFlexGridSizer
33                 {
34                         public:
35                                 //typedef definition
36                                 /*!     @typedef creaButtonContainer::model::TFunctor TFunctor;
37                                  *      @brief Defines the TFunctor type.
38                                  */
39                                 typedef creaButtonContainer::view::ButtonGroup ButtonGroup;
40                                 /*!     @typedef creaButtonContainer::model::TFunctor TFunctor;
41                                  *      @brief Defines the TFunctor type.
42                                  */
43                                 typedef wxButton ExpansionButton;
44                                 //end of typedef definition.
45                         public:
46                                 // ----------------------------------------------------------------------------------
47                                 /*! @fn GroupManager( wxWindow* parent, ButtonGroup* buttonGroup );
48                                  *
49                                  * @param parent
50                                  * @param buttonGroup
51                                  */
52                                 GroupManager( wxWindow* parent, ButtonGroup* buttonGroup );
53                                 // ----------------------------------------------------------------------------------
54                                 /*! @fn
55                                  * ~GroupManager( );
56                                  */
57                                 virtual
58                                 ~GroupManager( );
59                                 //Getters and Setters
60                                 // ----------------------------------------------------------------------------------
61                                 /*! @fn
62                                  *  @return
63                                  */
64                                 long
65                                 GetButtonID( );
66                                 // ----------------------------------------------------------------------------------
67                                 /*! @fn GetButton( );
68                                  *
69                                  * @return
70                                  */
71                                 ExpansionButton*
72                                 GetButton( );
73                                 // ----------------------------------------------------------------------------------
74                                 /*! @fn GetButtonManager( );
75                                  *
76                                  * @return
77                                  */
78                                 ButtonManager*
79                                 GetButtonManager( );
80                                 // ----------------------------------------------------------------------------------
81                                 /*! @fn SetButtonID( long id );
82                                  *
83                                  * @param id
84                                  */
85                                 void
86                                 SetButtonID( long id );
87                                 // ----------------------------------------------------------------------------------
88                                 /*! @fn SetButton( ExpansionButton* button );
89                                  *
90                                  * @param button
91                                  */
92                                 void
93                                 SetButton( ExpansionButton* button );
94                                 // ----------------------------------------------------------------------------------
95                                 /*! @fn SetButtonManager( ButtonManager* manager );
96                                  *
97                                  * @param manager
98                                  */
99                                 void
100                                 SetButtonManager( ButtonManager* manager );
101                                 // ----------------------------------------------------------------------------------
102                                 /*! @fn HideSubPanel( bool hide );
103                                  *
104                                  * @param hide
105                                  */
106                                 void
107                                 HideSubPanel( bool hide );
108
109                         private:
110                                 long m_IDExpButton;
111                                 ExpansionButton* m_ExpansionButton;
112                                 ButtonManager* m_ButtonManager;
113                 };
114         }//ecapseman
115 }//ecapseman
116
117 #endif // GROUPMANAGER_H