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 PanelButtonContainer
28 * @brief This contains the ButtonContainerSettings class.
29 * @author Diego CACERES (diego.caceres[AT]creatis.insa-lyon.fr)
33 #ifndef PANELBUTTONCONTAINER_H_
34 #define PANELBUTTONCONTAINER_H_
37 #include <wx/aui/aui.h>
39 #include <wx/gdicmn.h>
40 #include <wx/gbsizer.h>
41 #include <wx/bmpbuttn.h>
43 #include "listConfigDialog.h"
44 #include "containerSettings.h"
45 #include "buttonContainerPanel.h"
46 #include "buttonContainerSettings.h"
49 #include "Settings.xpm"
52 /*! @namespace <creaPanelButtonContainer>
53 * @brief Contains the creaPanelButtonContainer library included in creaMaracasVisu.
55 namespace creaPanelButtonContainer
57 /*! @class PanelButtonContainer panelButtonContainer.h "panelButtonContainer.h"
58 * @brief This class contains the PanelButtonContainer. It derives from wxPanel.
59 * @see <a href="http://docs.wxwidgets.org/stable/wx_wxpanel.html">wxPanel</a>
61 class PanelButtonContainer: public wxPanel
65 // ----------------------------------------------------------------------------------
66 /*! typedef creaPanelButtonContainer::ButtonContainerSettings ButtonContainerSettings;
67 * @brief Defines the ButtonContainerSettings type.
69 typedef creaPanelButtonContainer::ButtonContainerSettings ButtonContainerSettings;
70 /*! typedef creaButtonContainer::view::ButtonContainerPanel ButtonContainerPanel;
71 * @brief Defines the ButtonContainerPanel type.
73 typedef creaButtonContainer::view::ButtonContainerPanel ButtonContainerPanel;
76 /*! typedef creaButtonContainer::view::ListWx ListWx;
77 * @brief Defines a ListWx for (Configurable) List Container.
78 * This class inherits from wxPanel and contains a wxListBox.
80 typedef creaButtonContainer::view::ListWx ListWx;
81 /*! typedef creaPanelButtonContainer::ListConfigDialog ListConfigDialog;
82 * @brief Defines a ListConfigPanel to configure.
83 * This class inherits from wxDialog and contains the wxListBox and wxButton.
85 typedef creaButtonContainer::view::ListConfigDialog ListConfigDialog;
87 typedef creaButtonContainer::view::ComboBox ComboBox;
89 // ----------------------------------------------------------------------------------
91 //end of typedef definition.
93 // ----------------------------------------------------------------------------------
94 /*! @fn PanelButtonContainer( wxWindow* parent, ButtonContainerSettings* bcSettings );
95 * @brief This is the parameterized constructor.
96 * @param parent The wxWindow pointer to parent
97 * @param bcSettings //The buttonContainerSettings
99 PanelButtonContainer(wxWindow* parent,
100 ButtonContainerSettings* bcSettings, int type);
101 // ----------------------------------------------------------------------------------
102 /*! @fn virtual PanelButtonContainer( );
103 * @brief This is the destructor.
106 ~PanelButtonContainer();
107 // ----------------------------------------------------------------------------------
108 /*! @fn void UpdatePanel( const std::string &buttonName );
109 * @brief This method Updates the m_EventPanel to a panel
110 * of the clicked button in creaButtonContainer.
114 UpdatePanel(const std::string &buttonName);
115 // ----------------------------------------------------------------------------------
116 /*! @fn void GenericButtonEvent( const std::string &buttonName );
117 * @brief This method is the function that calls the panels contained in the buttons.
118 * (in creaButtonContainer is the function contained in the functors to be called back.
119 * @param buttonName The name of the button
122 GenericButtonEvent(const std::string &buttonName);
123 // ----------------------------------------------------------------------------------
125 /*! @fn void GenericListEvent( const std::string &buttonName );
126 * @brief This method is the function that calls the panels contained in the items list.
127 * (in creaButtonContainer is the function contained in the functors to be called back.
128 * @param buttonName The name of the button (item list)
131 GenericListEvent(const std::string &buttonName);
132 // ----------------------------------------------------------------------------------
133 /*! @fn void UpdateListPanel( const std::string &buttonName );
134 * @brief This method Updates the m_EventPanel to a panel
135 * of the clicked an item in creaButtonContainer.
136 * @param buttonName The name of the button (item list)
139 UpdateListPanel(const std::string &buttonName);
140 // ----------------------------------------------------------------------------------
141 /*! @fn void OnConfigButton( wxCommandEvent& event );
142 * @brief This method calls the wxDialog when
143 * the config button is clicked.
147 OnConfigButton(wxCommandEvent& event);
149 // ----------------------------------------------------------------------------------
152 ButtonContainerSettings* m_ButtonContainerSettings; //!<This is the buttonContainer settings.
155 ButtonContainerPanel* m_ButtonContainerPanel; //!<This is the panel with of buttons (creaButtonContainer)
156 wxAuiManager* m_AuiManager; //!<The AUI Manager for the panels.
157 wxPanel* m_EventPanel; //!<This is the panel used to contain the panels of the buttons. (it changes with the buttonAction)
160 ListWx* m_ListWxPanel;//!<This panel contains the list of the elements.
161 ListConfigDialog* m_ListConfigDialog;//!<This wxDialog shows the list of the elements and allows modifications.
163 wxPanel* m_PanelUp;//!<This panel contains the list of the elements empty,full and the config button.
164 wxPanel* m_EmptyPanel; //!<This panel is empty.
165 ListWx* m_CurrentWxPanel;//!<This panel contains the final list of the elements .
167 wxBitmapButton* m_ConfigButton;//!< "Config" Settings button.
169 ComboBox* m_ComboBoxPanel;//!<This panel contains the list of the comboBox elements.
172 DECLARE_EVENT_TABLE()
173 //!<Event Table declaration.
177 #endif // PANELBUTTONCONTAINER_H_