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 listConfigDialog.h
28 * @brief This contains the ListConfigDialog class.
29 * @author Monica ESPINOSA (espinosa[AT]creatis.insa-lyon.fr)
33 #ifndef LISTCONFIGDIALOG_H
34 #define LISTCONFIGDIALOG_H
38 #include <wx/gbsizer.h>
40 #include <wx/bmpbuttn.h>
41 #include <wx/msgdlg.h>
51 #include "settings.xpm"
53 /*! @namespace <creaButtonContainer>
54 * @brief Contains the creaButtonContainer library included in creaMaracasVisu.
56 namespace creaButtonContainer
58 /*! @namespace <creaButtonContainer::view>
59 * @brief Contains the implementation of the view in creaButtonContainer library.
60 * @see <a href="http://en.wikipedia.org/wiki/Model-view-controller">MVC Software Architecture</a>
64 /*! @class ListConfigDialog listConfigDialog.h "listConfigDialog.h"
65 * @brief This class contains the list in the wxDialog.
66 * @details This class contains the information of a Dialog with the lists, it derives from wxDialog.
67 * @see <a href="http://docs.wxwidgets.org/trunk/classwx_dialog.html">wxDialog</a>
69 class ListConfigDialog: public wxDialog
73 // ----------------------------------------------------------------------------------
74 /*! typedef creaButtonContainer::model::TFunctor TFunctor;
75 * @brief Defines the TFunctor type.
77 typedef creaButtonContainer::model::TFunctor TFunctor;
78 /*! typedef creaButtonContainer::view::ListWx ListWx;
79 * @brief Defines the List Panel.
81 typedef creaButtonContainer::view::ListWx ListWx;
82 // ----------------------------------------------------------------------------------
83 //end of typedef definition.
85 // ----------------------------------------------------------------------------------
86 /*! @fn ListConfigDialog( wxWindow* parent, wxWindowID id,const wxString& title,
87 ListWx* modelList, ListWx* currentList );
88 * @brief This is the parameterized constructor.
89 * @param parent The wxWindow pointer to parent.
90 * @param id The wxID of the button.
91 * @param title //The title wxDialog.
92 * @param modelList //The list is filled with the elements of model.
93 * @param currentList //The list is filled with the events.
95 ListConfigDialog(wxWindow* parent, wxWindowID id, const wxString& title,
96 ListWx* modelList, ListWx* currentList);
97 // ----------------------------------------------------------------------------------
98 /*! @fn virtual ~Button( );
99 * @brief This is the destructor.
103 // ----------------------------------------------------------------------------------
104 /*! @fn void OnAdd( wxCommandEvent& event );
105 * @brief This method add an item to current list.
109 OnAdd(wxCommandEvent& event);
110 // ----------------------------------------------------------------------------------
111 /*! @fn void OnDelete( wxCommandEvent& event );
112 * @brief This method remove an item of current list.
116 OnDelete(wxCommandEvent& event);
117 // ----------------------------------------------------------------------------------
118 /*! @fn void OnMoveUp( wxCommandEvent& event );
119 * @brief This method move up an item of current list.
123 OnMoveUp(wxCommandEvent& event);
124 // ----------------------------------------------------------------------------------
125 /*! @fn void OnMoveDown( wxCommandEvent& event );
126 * @brief This method move down an item of current list.
130 OnMoveDown(wxCommandEvent& event);
131 // ----------------------------------------------------------------------------------
132 /*! @fn void OnOk( wxCommandEvent& event );
133 * @brief This method confirm the changes of current list.
137 OnOk(wxCommandEvent& event);
138 // ----------------------------------------------------------------------------------
139 /*! @fn void OnCancel( wxCommandEvent& event );
140 * @brief This method discard the changes of current list.
144 OnCancel(wxCommandEvent& event);
145 // ----------------------------------------------------------------------------------
149 wxBitmapButton* m_AddButton; //!< ">" Add button.
150 wxBitmapButton* m_RemoveButton; //!< "<" Remove button.
151 wxButton* m_OkButton; //!< "Ok" Remove button.
152 wxButton* m_CancelButton; //!< "Cancel" Remove button.
153 wxBitmapButton* m_UpButton; //!< "/\" Move Up button.
154 wxBitmapButton* m_DownButton; //!< "\/" Move Down button.
155 wxArrayString m_LastStatus; //!<Last status array.
157 ListWx* m_OriginalListWx; //!< The Original list.
158 ListWx* m_CurrentListWx; //!<The Configurable list.
163 #endif // LISTCONFIGDIALOGL_H