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 # ------------------------------------------------------------------------ */
27 * @file groupManager.h
28 * @brief This contains the GroupManager class
29 * @author Diego CACERES (diego.caceres[AT]creatis.insa-lyon.fr)
33 #ifndef GROUPMANAGER_H
34 #define GROUPMANAGER_H
37 #include <wx/button.h>
38 #include <wx/stattext.h>
44 #include "buttonManager.h"
45 #include "buttonGroup.h"
47 /*! @namespace <creaButtonContainer>
48 * @brief Contains the creaButtonContainer library included in creaMaracasVisu.
50 namespace creaButtonContainer
52 /*! @namespace <creaButtonContainer::view>
53 * @brief Contains the implementation of the view in creaButtonContainer library.
54 * @see <a href="http://en.wikipedia.org/wiki/Model-view-controller">MVC Software Architecture</a>
58 /*! @class GroupManager groupManager.h "groupManager.h"
59 * @brief This class contains the GroupManager.
60 * @details This class describes a wxFlexGridSizer with the group manager.
61 * @see <a href="http://docs.wxwidgets.org/stable/wx_wxflexGridSizer.html">wxFlexGridSizer</a>
63 class GroupManager : public wxFlexGridSizer
67 // ----------------------------------------------------------------------------------
68 /*! @typedef creaButtonContainer::view::ButtonGroup ButtonGroup;
69 * @brief Defines the ButtonGroup type.
71 typedef creaButtonContainer::view::ButtonGroup ButtonGroup;
72 // ----------------------------------------------------------------------------------
73 /*! @typedef wxButton ExpansionButton;
74 * @brief Defines the ExpansionButton type.
76 typedef wxButton ExpansionButton;
77 // ----------------------------------------------------------------------------------
78 //end of typedef definition.
80 // ----------------------------------------------------------------------------------
81 /*! @fn GroupManager( wxWindow* parent, ButtonGroup* buttonGroup );
82 * @brief This is the parameterized constructor.
83 * @param parent The wxWindow* parent
84 * @param buttonGroup The pointer to the ButtonGroup.
86 GroupManager( wxWindow* parent, ButtonGroup* buttonGroup );
87 // ----------------------------------------------------------------------------------
88 /*! @fn ~GroupManager( );
89 * @brief This is the destructor.
93 // ----------------------------------------------------------------------------------
94 /*! @fn GetButtonID( );
95 * @brief This method returns the Button ID.
100 // ----------------------------------------------------------------------------------
101 /*! @fn GetButton( );
102 * @brief This method returns the expansion button.
107 // ----------------------------------------------------------------------------------
108 /*! @fn GetButtonManager( );
109 * @brief This method returns the manager of the buttons.
114 // ----------------------------------------------------------------------------------
115 /*! @fn SetButtonID( long id );
116 * @brief This method sets the ID of the expansion button.
120 SetButtonID( long id );
121 // ----------------------------------------------------------------------------------
122 /*! @fn SetButton( ExpansionButton* button );
123 * @brief This method sets the expansion button.
127 SetButton( ExpansionButton* button );
128 // ----------------------------------------------------------------------------------
129 /*! @fn SetButtonManager( ButtonManager* manager );
130 * @brief This method Sets the ButtonManager
131 * @param manager A pointer with the manager.
134 SetButtonManager( ButtonManager* manager );
135 // ----------------------------------------------------------------------------------
136 /*! @fn HideSubPanel( bool hide );
137 * @brief This method hides the subPanel (Hides the buttons).
138 * @param hide True if you need to hide the buttons.
141 HideSubPanel( bool hide );
144 long m_IDExpButton; //!<ID of "+""-" expansion button.
145 ExpansionButton* m_ExpansionButton; //!<The expansion button.
146 ButtonManager* m_ButtonManager; //!<The button manager.
151 #endif // GROUPMANAGER_H