X-Git-Url: https://git.creatis.insa-lyon.fr/pubgit/?a=blobdiff_plain;f=lib%2FmaracasVisuLib%2Fsrc%2Finterface%2FwxWindows%2Fwidgets%2FcreaButtonContainer%2Fview%2FlistConfigDialog.h;h=f878bd6e276b8bacce751127763322fe0f9102f0;hb=5bcbe43584902af3a90cfbd1a886a9c8434f236e;hp=d45403aaee1b7836eafe7805c87fd750b2d27ffc;hpb=ecf68d834a4193f68661d9d73ea1e6652fb83f20;p=creaMaracasVisu.git

diff --git a/lib/maracasVisuLib/src/interface/wxWindows/widgets/creaButtonContainer/view/listConfigDialog.h b/lib/maracasVisuLib/src/interface/wxWindows/widgets/creaButtonContainer/view/listConfigDialog.h
index d45403a..f878bd6 100644
--- a/lib/maracasVisuLib/src/interface/wxWindows/widgets/creaButtonContainer/view/listConfigDialog.h
+++ b/lib/maracasVisuLib/src/interface/wxWindows/widgets/creaButtonContainer/view/listConfigDialog.h
@@ -23,12 +23,21 @@
  #  knowledge of the CeCILL-B license and that you accept its terms.
  # ------------------------------------------------------------------------ */
 
+/*!
+ * @file listConfigDialog.h
+ * @brief This contains the ListConfigDialog class.
+ * @author Monica ESPINOSA (espinosa[AT]creatis.insa-lyon.fr)
+ * @date  2015-01-02
+ */
+
 #ifndef LISTCONFIGDIALOG_H
 #define LISTCONFIGDIALOG_H
 
 #include <wx/panel.h>
 #include <wx/sizer.h>
+#include <wx/gbsizer.h>
 #include <wx/wx.h>
+#include <wx/bmpbuttn.h>
 
 #include <string>
 #include <vector>
@@ -36,49 +45,111 @@
 #include "functor.h"
 #include "listWx.h"
 
+/*!	@namespace <creaButtonContainer>
+ *	@brief Contains the creaButtonContainer library included in creaMaracasVisu.
+ */
 namespace creaButtonContainer
 {
-
+	/*! @namespace <creaButtonContainer::view>
+	 *	@brief Contains the implementation of the view in creaButtonContainer library.
+	 *	@see <a href="http://en.wikipedia.org/wiki/Model-view-controller">MVC Software Architecture</a>
+	 */
 	namespace view
 	{
-
+		/*! @class ListConfigDialog listConfigDialog.h "listConfigDialog.h"
+		 *	@brief This class contains the list in the wxDialog.
+		 *  @details This class contains the information of a Dialog with the lists, it derives from wxDialog.
+		 *  @see <a href="http://docs.wxwidgets.org/trunk/classwx_dialog.html">wxDialog</a>
+		 */
 		class ListConfigDialog: public wxDialog
 		{
 			public:
-
+				//typedef definition.
+				// ----------------------------------------------------------------------------------
+				/*!	typedef creaButtonContainer::model::TFunctor TFunctor;
+				 *	@brief Defines the TFunctor type.
+				 */
 				typedef creaButtonContainer::model::TFunctor TFunctor;
+				/*!	typedef creaButtonContainer::view::ListWx ListWx;
+				 *	@brief Defines the List Panel.
+				 */
 				typedef creaButtonContainer::view::ListWx ListWx;
-
+				// ----------------------------------------------------------------------------------
+				//end of typedef definition.
 			public:
-
+				// ----------------------------------------------------------------------------------
+				/*! @fn ListConfigDialog( wxWindow* parent, wxWindowID id,const wxString& title,
+				 ListWx* modelList, ListWx* currentList );
+				 *	@brief This is the parameterized constructor.
+				 * 	@param parent The wxWindow pointer to parent.
+				 * 	@param id The wxID of the button.
+				 * 	@param title //The title wxDialog.
+				 * 	@param modelList //The list is filled with the elements of model.
+				 * 	@param currentList //The list is filled with the events.
+				 */
 				ListConfigDialog(wxWindow* parent, wxWindowID id, const wxString& title,
 						ListWx* modelList, ListWx* currentList);
+				// ----------------------------------------------------------------------------------
+				/*! @fn virtual ~Button( );
+				 *	@brief This is the destructor.
+				 */
+				virtual
 				~ListConfigDialog();
-
+				// ----------------------------------------------------------------------------------
+				/*! @fn void OnAdd( wxCommandEvent& event );
+				 *  @brief This method add an item to current list.
+				 * 	@param event
+				 */
 				void
 				OnAdd(wxCommandEvent& event);
+				// ----------------------------------------------------------------------------------
+				/*! @fn void OnDelete( wxCommandEvent& event );
+				 *  @brief This method remove an item of current list.
+				 * 	@param event
+				 */
 				void
 				OnDelete(wxCommandEvent& event);
+				// ----------------------------------------------------------------------------------
+				/*! @fn void OnMoveUp( wxCommandEvent& event );
+				 *  @brief This method move up an item of current list.
+				 * 	@param event
+				 */
 				void
 				OnMoveUp(wxCommandEvent& event);
+				// ----------------------------------------------------------------------------------
+				/*! @fn void OnMoveDown( wxCommandEvent& event );
+				 *  @brief This method move down an item of current list.
+				 * 	@param event
+				 */
 				void
 				OnMoveDown(wxCommandEvent& event);
+				// ----------------------------------------------------------------------------------
+				/*! @fn void OnOk( wxCommandEvent& event );
+				 *  @brief This method confirm the changes of current list.
+				 * 	@param event
+				 */
 				void
 				OnOk(wxCommandEvent& event);
+				// ----------------------------------------------------------------------------------
+				/*! @fn void OnCancel( wxCommandEvent& event );
+				 *  @brief This method discard the changes of current list.
+				 * 	@param event
+				 */
 				void
 				OnCancel(wxCommandEvent& event);
+				// ----------------------------------------------------------------------------------
 
 			private:
-				//todo change it to wxBitmap
-				wxButton* buttonAdd;
-				wxButton* buttonDel;
-				wxButton* okButton;
-				wxButton* cancelButton;
-				wxButton* upButton;
-				wxButton* downButton;
-				//
-				ListWx* m_OriginalListWx; // Original list
-				ListWx* m_CurrentListWx; //Configurable list
+
+				wxBitmapButton* m_AddButton;				//!< ">" Add button.
+				wxBitmapButton* m_RemoveButton;				//!< "<" Remove button.
+				wxButton* m_OkButton;				//!< "Ok" Remove button.
+				wxButton* m_CancelButton;				//!< "Cancel" Remove button.
+				wxBitmapButton* m_UpButton;				//!< "/\" Remove button.
+				wxBitmapButton* m_DownButton;				//!< "\/" Remove button.
+
+				ListWx* m_OriginalListWx; //!< The Original list.
+				ListWx* m_CurrentListWx; //!<The Configurable list.
 		};
 	}
 }