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

diff --git a/lib/maracasVisuLib/src/interface/wxWindows/widgets/creaPanelButtonContainer/buttonContainerSettings.h b/lib/maracasVisuLib/src/interface/wxWindows/widgets/creaPanelButtonContainer/buttonContainerSettings.h
index 3d71e1a..80528a2 100644
--- a/lib/maracasVisuLib/src/interface/wxWindows/widgets/creaPanelButtonContainer/buttonContainerSettings.h
+++ b/lib/maracasVisuLib/src/interface/wxWindows/widgets/creaPanelButtonContainer/buttonContainerSettings.h
@@ -119,13 +119,20 @@ namespace creaPanelButtonContainer
 			 *	@brief Defines the BCStructVectorType type.
 			 */
 			typedef std::vector<BCPSettingsStruct*> BCStructVectorType;
-			//end typedef definition
-
 			//MLER
+			// ----------------------------------------------------------------------------------
+			/*!	@typedef std::pair<std::string, wxPanel*> ListAction;
+			 *	@brief Defines the ListAction type.
+			 *	First is the button name(item list), Second FunctionEventType
+			 */
 			typedef std::pair<std::string, wxPanel*> ListAction;
+			// ----------------------------------------------------------------------------------
+			/*!	@typedef std::vector<ListAction> ItemsVector;
+			 *	@brief Defines the Items Vector type.
+			 */
 			typedef std::vector<ListAction> ItemsVector;
 			//MLER
-
+			//end typedef definition
 			// ----------------------------------------------------------------------------------
 
 		public:
@@ -178,13 +185,7 @@ namespace creaPanelButtonContainer
 			 *	@brief This method sets the button group container.
 			 * @param bGroupContainer
 			 */
-
 			// ----------------------------------------------------------------------------------
-			ButtonGroupSettings*
-			GetListGroupSettings();
-
-			// ----------------------------------------------------------------------------------
-
 			void
 			SetButtonGroupContainer(ButtonGroupMap bGroupContainer);
 			// ----------------------------------------------------------------------------------
@@ -194,7 +195,6 @@ namespace creaPanelButtonContainer
 			 */
 			void
 			SetGroupNameList(KeyMapList gNameList);
-
 			// ----------------------------------------------------------------------------------
 			/*! @fn void AddButton( const std::string &groupName, const std::string &buttonName,
 			 const std::string &iconpath, const std::string &buttonDescription,
@@ -211,7 +211,6 @@ namespace creaPanelButtonContainer
 			AddButton(const std::string &groupName, const std::string &buttonName,
 					const wxBitmap &icon, const std::string &buttonDescription,
 					PanelButton panel);
-
 			// ----------------------------------------------------------------------------------
 			/*! @fn void AddButton( BCPSettingsStruct* info );
 			 * @brief This method adds a new button into a group of buttons.
@@ -220,26 +219,42 @@ namespace creaPanelButtonContainer
 			 */
 			void
 			AddButton(BCPSettingsStruct* info);
-
 			// ----------------------------------------------------------------------------------
-			/*! @fn void AddButtons( BCStructVectorType infoList );
-			 * @brief This method adds new buttons into the container.
+			/*! @fn void InitModel( BCStructVectorType infoList, int type );
+			 * @brief This method adds new buttons or items into the container (Depends type).
 			 * @param infoList The BCStructVectorType
+			 * @param type If 1:Buttons 2:List 3:Configurable List
 			 * @exception std::bad_alloc
 			 */
 			void
 			InitModel(BCStructVectorType infoList, int type);
 			// ----------------------------------------------------------------------------------
 			//MLER
+			/*! @fn void AddItems( BCPSettingsStruct* info );
+			 * @brief This method adds a new item into a list.
+			 * @param info The pointer to BCPSettingsStruct.
+			 * @exception std::bad_alloc
+			 */
 			void
 			AddItems(BCPSettingsStruct* info);
 			// ----------------------------------------------------------------------------------
+			/*! @fn PanelButton GetPanelList( const std::string &buttonName );
+			 * 	@brief This method returns the panel of a list.
+			 * 	@param buttonName (item element)
+			 * 	@exception std::bad_alloc
+			 * 	@return
+			 */
 			ItemsVector
 			GetItemsVector();
-
+			// ----------------------------------------------------------------------------------
+			/*! @fn PanelButton GetPanelList( const std::string &buttonName );
+			 * 	@brief This method returns the panel of a list.
+			 * 	@param buttonName (item element)
+			 * 	@exception std::bad_alloc
+			 * 	@return
+			 */
 			wxPanel*
 			GetPanelList(const StringType &buttonName);
-
 			//MLER
 			// ----------------------------------------------------------------------------------
 		private: