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

diff --git a/lib/maracasVisuLib/src/interface/wxWindows/widgets/creaPanelButtonContainer/creaPanelButtonContainer.h b/lib/maracasVisuLib/src/interface/wxWindows/widgets/creaPanelButtonContainer/creaPanelButtonContainer.h
index 096cedd..b0cb014 100644
--- a/lib/maracasVisuLib/src/interface/wxWindows/widgets/creaPanelButtonContainer/creaPanelButtonContainer.h
+++ b/lib/maracasVisuLib/src/interface/wxWindows/widgets/creaPanelButtonContainer/creaPanelButtonContainer.h
@@ -37,6 +37,8 @@
 #include <wx/aui/aui.h>
 #include <string>
 #include <wx/gdicmn.h>
+#include <wx/gbsizer.h>
+#include <wx/bmpbuttn.h>
 
 #include "listConfigDialog.h"
 #include "containerSettings.h"
@@ -71,17 +73,17 @@ namespace creaPanelButtonContainer
 			//MLER
 			/*!	typedef creaButtonContainer::view::ListWx ListWx;
 			 *	@brief Defines a ListWx for (Configurable) List Container.
-			 *	This class inherits from wxPanel and contains a wxListBox
+			 *	This class inherits from wxPanel and contains a wxListBox.
 			 */
 			typedef creaButtonContainer::view::ListWx ListWx;
 			/*!	typedef creaPanelButtonContainer::ListConfigDialog ListConfigDialog;
-			 *	@brief Defines a ListConfigPanel to configure
+			 *	@brief Defines a ListConfigPanel to configure.
+			 *	This class inherits from wxDialog and contains the wxListBox and wxButton.
 			 */
 			typedef creaButtonContainer::view::ListConfigDialog ListConfigDialog;
-			//End MLER
-
 			// ----------------------------------------------------------------------------------
-			//end of typedef definition.
+			//End MLER
+  		//end of typedef definition.
 		public:
 			// ----------------------------------------------------------------------------------
 			/*! @fn PanelButtonContainer( wxWindow* parent, ButtonContainerSettings* bcSettings );
@@ -99,7 +101,7 @@ namespace creaPanelButtonContainer
 			~PanelButtonContainer();
 			// ----------------------------------------------------------------------------------
 			/*! @fn void UpdatePanel( const std::string &buttonName );
-			 *  @brief This method Updates the m_ButtonPanel to a panel
+			 *  @brief This method Updates the m_EventPanel to a panel
 			 *  of the clicked button in creaButtonContainer.
 			 * 	@param buttonName
 			 */
@@ -107,7 +109,7 @@ namespace creaPanelButtonContainer
 			UpdatePanel(const std::string &buttonName);
 			// ----------------------------------------------------------------------------------
 			/*! @fn void GenericButtonEvent( const std::string &buttonName );
-			 *	@brief This method is the function that calls the panels contained in the buttons
+			 *	@brief This method is the function that calls the panels contained in the buttons.
 			 *	(in creaButtonContainer is the function contained in the functors to be called back.
 			 * 	@param buttonName The name of the button
 			 */
@@ -115,31 +117,51 @@ namespace creaPanelButtonContainer
 			GenericButtonEvent(const std::string &buttonName);
 			// ----------------------------------------------------------------------------------
 			//MLER
+			/*! @fn void GenericListEvent( const std::string &buttonName );
+			 *	@brief This method is the function that calls the panels contained in the items list.
+			 *	(in creaButtonContainer is the function contained in the functors to be called back.
+			 * 	@param buttonName The name of the button (item list)
+			 */
 			void
 			GenericListEvent(const std::string &buttonName);
-
+			// ----------------------------------------------------------------------------------
+			/*! @fn void UpdateListPanel( const std::string &buttonName );
+			 *  @brief This method Updates the m_EventPanel to a panel
+			 *  of the clicked an item in creaButtonContainer.
+			 * 	@param buttonName The name of the button (item list)
+			 */
 			void
 			UpdateListPanel(const std::string &buttonName);
+			// ----------------------------------------------------------------------------------
+			/*! @fn void OnConfigButton( wxCommandEvent& event );
+			 *  @brief This method calls the wxDialog when
+			 *  the config button is clicked.
+			 * 	@param event
+			 */
 			void
 			OnConfigButton(wxCommandEvent& event);
-
+			//End MLER
 			// ----------------------------------------------------------------------------------
 		private:
 			//Settings
 			ButtonContainerSettings* m_ButtonContainerSettings; //!<This is the buttonContainer settings.
+
 			//Panel
-			ButtonContainerPanel* m_ButtonContainerPanel; //!<This is the panel with de buttons (creaButtonContainer)
+			ButtonContainerPanel* m_ButtonContainerPanel; //!<This is the panel with of buttons (creaButtonContainer)
 			wxAuiManager* m_AuiManager; //!<The AUI Manager for the panels.
 			wxPanel* m_EventPanel; //!<This is the panel used to contain the panels of the buttons. (it changes with the buttonAction)
 
 			//MLER
-			ListWx* m_ListWxPanel;
-			ListConfigDialog* m_ListConfigDialog;
-			//
-			wxPanel* m_PanelUp;
-			ListWx* m_CurrentWxPanel;
-			//todo change to bitmap
-			wxButton* m_ConfigButton;DECLARE_EVENT_TABLE()
+			ListWx* m_ListWxPanel;//!<This panel contains the list of the elements.
+			ListConfigDialog* m_ListConfigDialog;//!<This wxDialog shows the list of the elements and allows  modifications.
+
+			wxPanel* m_PanelUp;//!<This panel contains the list of the elements empty,full and the config button.
+			ListWx* m_CurrentWxPanel;//!<This panel contains the final list of the elements .
+
+			wxBitmapButton* m_ConfigButton;//!< "Config" Settings button.
+			//End MLER
+
+			DECLARE_EVENT_TABLE()
 			//!<Event Table declaration.
 	};
 } //ecapseman