X-Git-Url: https://git.creatis.insa-lyon.fr/pubgit/?a=blobdiff_plain;ds=sidebyside;f=lib%2FmaracasVisuLib%2Fsrc%2Finterface%2FwxWindows%2Fwidgets%2FcreaButtonContainer%2Fcontroller%2FbuttonContainerController.h;h=260f44be20ecde29b00aa97654fcc5cdf85176dd;hb=ae196719490130990cdde501c982c3370b46b21c;hp=cfda8efecb4c381679b17f3e429f52bf31776104;hpb=4b092ee0b1bcda4d298e5ffc3b58b599e273db20;p=creaMaracasVisu.git

diff --git a/lib/maracasVisuLib/src/interface/wxWindows/widgets/creaButtonContainer/controller/buttonContainerController.h b/lib/maracasVisuLib/src/interface/wxWindows/widgets/creaButtonContainer/controller/buttonContainerController.h
index cfda8ef..260f44b 100644
--- a/lib/maracasVisuLib/src/interface/wxWindows/widgets/creaButtonContainer/controller/buttonContainerController.h
+++ b/lib/maracasVisuLib/src/interface/wxWindows/widgets/creaButtonContainer/controller/buttonContainerController.h
@@ -1,70 +1,126 @@
-/***************************************************************
+/************************************************************************************//*!
  * Name:      @file buttonContainerController.h
- * Purpose:   @brief This fhile contains the ButtonContainerController Class
+ * Purpose:   @brief This contains the ButtonContainerController class
  * Author:    @author Diego CACERES (diego.caceres[AT]creatis.insa-lyon.fr)
- * Modified:  2011-05-09
- * Copyright: Diego CACERES (http://www.creatis.insa-lyon.fr/~caceres/)
+ * Modified:  2011-05-17
+ * Copyright:
  * License:
- **************************************************************/
+ ***************************************************************************************/
 
 #ifndef BUTTONCONTAINERCONTROLLER_H_
 #define BUTTONCONTAINERCONTROLLER_H_
 
+//! @include <wx/event.h>
 #include <wx/event.h>
+//! @include <iostream>
+#include <iostream>
+//! @include <exception>
+#include <exception>
+
+//! @include "buttonContainerPanel.h"
 #include "buttonContainerPanel.h"
 
-///@namespace<creaButtonContainer>
+//!	@namespace<creaButtonContainer>
 namespace creaButtonContainer
 {
-	///@namespace<view>
+	//! @namespace<view>
 	namespace view
 	{
 		//Predefinition of ButtonContainerPanel FriendClass!!
-		///@class ButtonContainerPanel buttonContainerPanel.h "buttonContainerPanel.h"
+		//! @class ButtonContainerPanel buttonContainerPanel.h "buttonContainerPanel.h"
+
 		class ButtonContainerPanel;
 	}
-	///@namespace<controller>
+	//!	@namespace<controller>
 	namespace controller
 	{
-		/*!@class ButtonContainerController buttonContainerController.h "buttonContainerController.h"
-		*	@brief This class contains the ButtonContainerPanel controller
-		* This class describes the panel and button events.
-		*/
+		/*! @class ButtonContainerController buttonContainerController.h "buttonContainerController.h"
+		 *	@brief This class contains the ButtonContainerPanel controller
+		 *  This class describes button events.
+		 */
 		class ButtonContainerController : public wxEvtHandler
 		{
 			public:
-				///@typedef creaButtonContainer::view::ButtonGroup ButtonGroup
-				///@typedef typedef creaButtonContainer::view::GroupManager GroupManager;
-				///@typedef std::list< ButtonGroup* > ButtonGroupList;
-				///@typedef std::map< long, GroupManager* > GroupManagerList;
-				///@typedef wxFlexGridSizer Sizer;
-				///@typedef std::list< long > KeyList;
-				///@typedef creaButtonContainer::model::ContainerSettings ButtonGroupSettings;
-				///@typedef creaButtonContainer::view::ButtonContainerPanel BCPanel;
-				//typedef definition
+				//typedef definitions
+				/*!	@typedef creaButtonContainer::view::ButtonGroup ButtonGroup
+				 *	@brief Defines the ButtonGroup type
+				 */
 				typedef creaButtonContainer::view::ButtonGroup ButtonGroup;
+				// ----------------------------------------------------------------------------------
+				/*!	@typedef typedef creaButtonContainer::view::GroupManager GroupManager
+				 *	@brief Defines the GroupManager type
+				 */
 				typedef creaButtonContainer::view::GroupManager GroupManager;
+				// ----------------------------------------------------------------------------------
+				/*!	@typedef std::list< ButtonGroup* > ButtonGroupList
+				 *	@brief Defines the ButtonGroupList type
+				 */
 				typedef std::list< ButtonGroup* > ButtonGroupList;
+				// ----------------------------------------------------------------------------------
+				/*!	@typedef std::map< long, GroupManager* > GroupManagerList
+				 * @brief Defines the GroupManagerList type
+				 */
 				typedef std::map< long, GroupManager* > GroupManagerList;
+				// ----------------------------------------------------------------------------------
+				/*!	@typedef wxFlexGridSizer Sizer
+				 *	@brief Defines the Sizer type
+				 */
 				typedef wxFlexGridSizer Sizer;
+				// ----------------------------------------------------------------------------------
+				/*!	@typedef std::list< long > KeyList
+				 *	@brief Defines the KeyList type
+				 */
 				typedef std::list< long > KeyList;
+				// ----------------------------------------------------------------------------------
+				/*!	@typedef creaButtonContainer::model::ContainerSettings ButtonGroupSettings
+				 *	@brief Defines the ButtonGroupSettings type
+				 */
 				typedef creaButtonContainer::model::ContainerSettings
 				    ButtonGroupSettings;
+				// ----------------------------------------------------------------------------------
+				/*!	@typedef creaButtonContainer::view::ButtonContainerPanel BCPanel
+				 *	@brief Defines the BCPanel type
+				 */
 				typedef creaButtonContainer::view::ButtonContainerPanel BCPanel;
 				//end of typedef definition
 			public:
-				///!The Parameterized Constructor
+				/*!	@fn ButtonContainerController::ButtonContainerController( BCPanel* )
+				 *	@brief This is the Parameterized constructor.
+				 * 	@param BCPanel*
+				 */
 				ButtonContainerController( BCPanel* );
+				// ----------------------------------------------------------------------------------
+				/*! @fn virtual ButtonContainerController::~ButtonContainerController( )
+				 *	@brief This is the destructor.
+				 */
 				virtual
 				~ButtonContainerController( );
+				// ----------------------------------------------------------------------------------
+				/*! @fn void ButtonContainerController::AddEvents( )
+				 *	@brief This function connect every buttonEvent to the view.
+				 *	@exception std::bad_alloc
+				 */
 				void
 				AddEvents( );
+				// ----------------------------------------------------------------------------------
+				/*! @fn void ButtonContainerController::ButtonExpEvent( wxCommandEvent& event )
+				 *	@brief This function is the button group "+" "-" event.
+				 *	@exception std::bad_alloc
+				 * 	@param event Button action event.
+				 */
 				void
 				ButtonExpEvent( wxCommandEvent& event );
+				// ----------------------------------------------------------------------------------
+				/*! @fn void ButtonContainerController::ButtonEvent( wxCommandEvent& event )
+				 *	@brief This function calls the events of the buttonContainer buttons
+				 *	@exception std::bad_alloc
+				 * 	@param event Button action event.
+				 */
 				void
 				ButtonEvent( wxCommandEvent& event );
+				// ----------------------------------------------------------------------------------
 			private:
-				BCPanel* m_BCPanel;
+				BCPanel* m_BCPanel; //! <ButtonContainerPanel View pointer.
 		};
 	}//ecapsename
 }//ecapsename