X-Git-Url: https://git.creatis.insa-lyon.fr/pubgit/?a=blobdiff_plain;ds=sidebyside;f=lib%2FmaracasVisuLib%2Fsrc%2Finterface%2FwxWindows%2Fwidgets%2FcreaButtonContainer%2Fview%2FgroupManager.h;h=c187c2e0fb91bcee8b8bc27fdc2c69a9c3e65682;hb=825f47d7d281a359e9fec03de88e7db58e9e49ff;hp=349a22eee7ab6386693bc3ccf7e2c806559d707b;hpb=f6c7b458a17b67950d1844d6a600683a99cb2b6d;p=creaMaracasVisu.git

diff --git a/lib/maracasVisuLib/src/interface/wxWindows/widgets/creaButtonContainer/view/groupManager.h b/lib/maracasVisuLib/src/interface/wxWindows/widgets/creaButtonContainer/view/groupManager.h
index 349a22e..c187c2e 100644
--- a/lib/maracasVisuLib/src/interface/wxWindows/widgets/creaButtonContainer/view/groupManager.h
+++ b/lib/maracasVisuLib/src/interface/wxWindows/widgets/creaButtonContainer/view/groupManager.h
@@ -2,7 +2,7 @@
  * @file groupManager.h
  * @brief This contains the GroupManager class
  * @author Diego CACERES (diego.caceres[AT]creatis.insa-lyon.fr)
- * @date  2011-05-19
+ * @date  2011-06-02
  */
 
 #ifndef GROUPMANAGER_H
@@ -11,12 +11,13 @@
 #include <wx/sizer.h>
 #include <wx/button.h>
 #include <wx/stattext.h>
-#include <wx/event.h>
+
 #include <list>
 #include <iostream>
+#include <exception>
+
 #include "buttonManager.h"
 #include "buttonGroup.h"
-#include <wx/event.h>
 
 /*!	@namespace <creaButtonContainer>
  *	@brief Contains the creaButtonContainer library included in creaMaracasVisu.
@@ -29,87 +30,95 @@ namespace creaButtonContainer
 	 */
 	namespace view
 	{
+		/*! @class GroupManager groupManager.h "groupManager.h"
+		 *	@brief This class contains the GroupManager.
+		 *  @details This class describes a wxFlexGridSizer with the group manager.
+		 *  @see <a href="http://docs.wxwidgets.org/stable/wx_wxflexGridSizer.html">wxFlexGridSizer</a>
+		 */
 		class GroupManager : public wxFlexGridSizer
 		{
 			public:
 				//typedef definition
-				/*!	@typedef creaButtonContainer::model::TFunctor TFunctor;
-				 *	@brief Defines the TFunctor type.
+				// ----------------------------------------------------------------------------------
+				/*!	@typedef creaButtonContainer::view::ButtonGroup ButtonGroup;
+				 *	@brief Defines the ButtonGroup type.
 				 */
 				typedef creaButtonContainer::view::ButtonGroup ButtonGroup;
-				/*!	@typedef creaButtonContainer::model::TFunctor TFunctor;
-				 *	@brief Defines the TFunctor type.
+				// ----------------------------------------------------------------------------------
+				/*!	@typedef wxButton ExpansionButton;
+				 *	@brief Defines the ExpansionButton type.
 				 */
 				typedef wxButton ExpansionButton;
+				// ----------------------------------------------------------------------------------
 				//end of typedef definition.
 			public:
 				// ----------------------------------------------------------------------------------
 				/*! @fn GroupManager( wxWindow* parent, ButtonGroup* buttonGroup );
-				 *
-				 * @param parent
-				 * @param buttonGroup
+				 *	@brief This is the parameterized constructor.
+				 * 	@param parent The wxWindow* parent
+				 * 	@param buttonGroup The pointer to the ButtonGroup.
 				 */
 				GroupManager( wxWindow* parent, ButtonGroup* buttonGroup );
 				// ----------------------------------------------------------------------------------
-				/*! @fn
-				 * ~GroupManager( );
+				/*! @fn ~GroupManager( );
+				 *  @brief This is the destructor.
 				 */
 				virtual
 				~GroupManager( );
-				//Getters and Setters
 				// ----------------------------------------------------------------------------------
-				/*! @fn
+				/*! @fn GetButtonID( );
+				 *  @brief This method returns the Button ID.
 				 *  @return
 				 */
 				long
 				GetButtonID( );
 				// ----------------------------------------------------------------------------------
 				/*! @fn GetButton( );
-				 *
+				 * 	@brief This method returns the expansion button.
 				 * @return
 				 */
 				ExpansionButton*
 				GetButton( );
 				// ----------------------------------------------------------------------------------
 				/*! @fn GetButtonManager( );
-				 *
-				 * @return
+				 *	@brief This method returns the manager of the buttons.
+				 * 	@return
 				 */
 				ButtonManager*
 				GetButtonManager( );
 				// ----------------------------------------------------------------------------------
 				/*! @fn SetButtonID( long id );
-				 *
+				 *	@brief This method sets the ID of the expansion button.
 				 * @param id
 				 */
 				void
 				SetButtonID( long id );
 				// ----------------------------------------------------------------------------------
 				/*! @fn SetButton( ExpansionButton* button );
-				 *
+				 *	@brief This method sets the expansion button.
 				 * @param button
 				 */
 				void
 				SetButton( ExpansionButton* button );
 				// ----------------------------------------------------------------------------------
 				/*! @fn SetButtonManager( ButtonManager* manager );
-				 *
-				 * @param manager
+				 *	@brief This method Sets the ButtonManager
+				 * @param manager A pointer with the manager.
 				 */
 				void
 				SetButtonManager( ButtonManager* manager );
 				// ----------------------------------------------------------------------------------
 				/*! @fn HideSubPanel( bool hide );
-				 *
-				 * @param hide
+				 *	@brief This method hides the subPanel (Hides the buttons).
+				 * @param hide True if you need to hide the buttons.
 				 */
 				void
 				HideSubPanel( bool hide );
 
 			private:
-				long m_IDExpButton;
-				ExpansionButton* m_ExpansionButton;
-				ButtonManager* m_ButtonManager;
+				long m_IDExpButton; //!<ID of "+""-" expansion button.
+				ExpansionButton* m_ExpansionButton; //!<The expansion button.
+				ButtonManager* m_ButtonManager; //!<The button manager.
 		};
 	}//ecapseman
 }//ecapseman