X-Git-Url: https://git.creatis.insa-lyon.fr/pubgit/?a=blobdiff_plain;f=lib%2FmaracasVisuLib%2Fsrc%2Finterface%2FwxWindows%2Fwidgets%2FcreaButtonContainer%2Fview%2FbuttonManager.h;h=88c6786e1b21047afbd6d8b56e6da78a1db71c0e;hb=5380f9e66daf440f27f33bb060e5ae1a646612cd;hp=2a61580d5a2e025006d6cb3b570341b3c2ab7cb2;hpb=f6c7b458a17b67950d1844d6a600683a99cb2b6d;p=creaMaracasVisu.git

diff --git a/lib/maracasVisuLib/src/interface/wxWindows/widgets/creaButtonContainer/view/buttonManager.h b/lib/maracasVisuLib/src/interface/wxWindows/widgets/creaButtonContainer/view/buttonManager.h
index 2a61580..88c6786 100644
--- a/lib/maracasVisuLib/src/interface/wxWindows/widgets/creaButtonContainer/view/buttonManager.h
+++ b/lib/maracasVisuLib/src/interface/wxWindows/widgets/creaButtonContainer/view/buttonManager.h
@@ -2,7 +2,7 @@
  * @file buttonManager.h
  * @brief This contains the ButtonManager class.
  * @author Diego CACERES (diego.caceres[AT]creatis.insa-lyon.fr)
- * @date  2011-05-19
+ * @date  2011-06-02
  */
 
 #ifndef CARTOBUTTONCONTAINER_H
@@ -12,7 +12,10 @@
 #include <wx/bmpbuttn.h>
 #include <wx/stattext.h>
 #include <wx/string.h>
+
 #include <map>
+#include <exception>
+
 #include "button.h"
 #include "buttonGroup.h"
 
@@ -27,57 +30,68 @@ namespace creaButtonContainer
 	 */
 	namespace view
 	{
+		/*! @class ButtonManager buttonManager.h "buttonManager.h"
+		 *	@brief This class contains the ButtonManager view.
+		 *  @details This class describes a wxFlexGridSizer with the button manager.
+		 *  @see <a href="http://docs.wxwidgets.org/stable/wx_wxflexGridSizer.html">wxFlexGridSizer</a>
+		 */
 		class ButtonManager : public wxFlexGridSizer
 		{
 			public:
 				//typedef definition.
-				/*!	@typedef creaButtonContainer::model::TFunctor TFunctor;
-				 *	@brief Defines the TFunctor type.
+				// ----------------------------------------------------------------------------------
+				/*!	@typedef creaButtonContainer::view::Button Button;
+				 *	@brief Defines the Button type.
 				 */
 				typedef creaButtonContainer::view::Button Button;
-				/*!	@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 std::map< long, Button* > ButtonContainer;
+				 *	@brief Defines the ButtonContainer type.
 				 */
 				typedef std::map< long, Button* > ButtonContainer;
+				// ----------------------------------------------------------------------------------
 				//end of typedef definition.
 			public:
 				// ----------------------------------------------------------------------------------
 				/*! @fn ButtonManager( );
-				 *
+				 * @brief This is the default constructor.
+				 * @exception std::bad_alloc
 				 */
 				ButtonManager( );
 				// ----------------------------------------------------------------------------------
 				/*! @fn ButtonManager( ButtonGroup* buttonGroup );
-				 *
-				 * @param buttonGroup
+				 * @brief This is the parameterized constructor
+				 * @param buttonGroup The group of buttons.
 				 */
 				ButtonManager( ButtonGroup* buttonGroup );
 				// ----------------------------------------------------------------------------------
 				/*! @fn ~ButtonManager( );
-				 *
+				 * @brief This is the destructor.
 				 */
 				virtual
 				~ButtonManager( );
 				// ----------------------------------------------------------------------------------
 				/*! @fn SetGroupName( wxStaticText* groupName );
-				 *
+				 * @details Sets the groupName.
 				 * @param groupName
 				 */
 				void
 				SetGroupName( wxStaticText* groupName );
 				// ----------------------------------------------------------------------------------
 				/*! @fn ShowButtonManager( );
-				 *
+				 * @brief This method shows the ButtonManager
 				 */
 				void
 				ShowButtonManager( );
 				// ----------------------------------------------------------------------------------
 				/*! @fn HideButtonManager( );
-				 *
+				 * @brief This method hides the ButtonManager.
+				 * @exception std::bad_alloc
 				 */
 				void
 				HideButtonManager( );
@@ -85,15 +99,15 @@ namespace creaButtonContainer
 			private:
 				// ----------------------------------------------------------------------------------
 				/*! @fn SetButtonManager( ButtonContainer buttonContainer );
-				 *
+				 * @brief This method set the buttons and it is private.
 				 * @param buttonContainer
 				 */
 				void
 				SetButtonManager( ButtonContainer buttonContainer );
 				// ----------------------------------------------------------------------------------
 			private:
-				wxStaticText* m_GroupName;
-				wxGridSizer* m_GridSizer;
+				wxStaticText* m_GroupName; //!<The name of the group.
+				wxGridSizer* m_GridSizer; //!<The sizer that contains the buttons.
 		};
 	}//ecapseman
 }//ecapseman