creaButtonContainer: Updates in documentation, adding try catch clauses and cleaning...

[creaMaracasVisu.git] / lib / maracasVisuLib / src / interface / wxWindows / widgets / creaButtonContainer / view / button.h

diff --git a/lib/maracasVisuLib/src/interface/wxWindows/widgets/creaButtonContainer/view/button.h b/lib/maracasVisuLib/src/interface/wxWindows/widgets/creaButtonContainer/view/button.h
index 4ef2af960736a75e37088b138657859a56acc3c2..ea30b2024bf45340c1eb49faa4fb4a4db41e0f31 100644 (file)
--- a/lib/maracasVisuLib/src/interface/wxWindows/widgets/creaButtonContainer/view/button.h
+++ b/lib/maracasVisuLib/src/interface/wxWindows/widgets/creaButtonContainer/view/button.h
@@ -1,56 +1,98 @@
-/***************************************************************
- * Name:      Button.h
- * Purpose:   Defines a Button
- * Author:    Diego CACERES (diego.caceres[AT]creatis.insa-lyon.fr)
- * Modified:  2011-05-09
- * Copyright: Diego CACERES (http://www.creatis.insa-lyon.fr/~caceres/)
+/************************************************************************************//*!
+ * Name:      @file button.h
+ * Purpose:   @brief This contains the Button class
+ * Author:    @author Diego CACERES (diego.caceres[AT]creatis.insa-lyon.fr)
+ * Modified:  2011-05-18
+ * Copyright:
  * License:
- **************************************************************/
+ ***************************************************************************************/
 
 #ifndef BUTTON_H
 #define BUTTON_H
 
+//! @include <wx/bmpbuttn.h>
 #include <wx/bmpbuttn.h>
+//! @include <<wx/image.h>
 #include <wx/image.h>
+//! @include <wx/string.h>
 #include <wx/string.h>
+//! @include <string>
 #include <string>
+//! @include <iostream>
+#include <iostream>
+//! @include "functor.h"
 #include "functor.h"
+//! @include "system.h"
 #include "system.h"
 
-using std::string;
-
+//!    @namespace <creaButtonContainer>
 namespace creaButtonContainer
 {
+       //!     @namespace <view>
        namespace view
        {
-               /**
-                Class Description: This class defines a wxBitmapButton.
-                **/
-                       class Button : public wxBitmapButton
-                       {
-                               public:
-                                       //Typedef definition
-                                       typedef creaButtonContainer::model::TFunctor TFunctor;
-                               public:
-                                       //--------------------------------------------------------------------
-                                       Button( wxWindow* parent, long id, ButtonPair* pair );
-                                       virtual
-                                       ~Button( );
-                                       //--------------------------------------------------------------------
-                                       long
-                                       GetID( );
-                                       string
-                                       GetButtonName( );
-                                       string
-                                       GetIconPath( );
-                                       string
-                                       GetDescription( );
-                                       //--------------------------------------------------------------------
-                                       void
-                                       Execute( );
-                               private:
-                                       ButtonPair* m_ButtonPair;
-                       };
+               /*! @class ContainerSettings containerSettings.h "containerSettings.h"
+                *      @brief This class contains the settings of the button container.
+                *  This class describes how to add new buttons to the container.
+                */
+               class Button : public wxBitmapButton
+               {
+                       public:
+                               /*!     @typedef creaButtonContainer::model::ContainerSettings ButtonGroupModel;
+                                *      @brief Defines the ButtonGroupModel type.
+                                */
+                               typedef creaButtonContainer::model::TFunctor TFunctor;
+                       public:
+                               // ----------------------------------------------------------------------------------
+                               /*! @fn void ContainerSettings::ContainerSettings( )
+                                *      @brief This is the constructor.
+                                */
+                               Button( wxWindow* parent, long id, ButtonPair* pair );
+                               // ----------------------------------------------------------------------------------
+                               /*! @fn void ContainerSettings::ContainerSettings( )
+                                *      @brief This is the constructor.
+                                */
+                               virtual
+                               ~Button( );
+                               // ----------------------------------------------------------------------------------
+                               /*! @fn KeyMapList ContainerSettings::GetGroupNameList( )
+                                *      @brief This function returns a container with the name of the groups.
+                                *      @return KeyMapList A list with the name of the button groups.
+                                */
+                               long
+                               GetID( );
+                               // ----------------------------------------------------------------------------------
+                               /*! @fn KeyMapList ContainerSettings::GetGroupNameList( )
+                                *      @brief This function returns a container with the name of the groups.
+                                *      @return long A list with the name of the button groups.
+                                */
+                               std::string
+                               GetButtonName( );
+                               // ----------------------------------------------------------------------------------
+                               /*! @fn KeyMapList ContainerSettings::GetGroupNameList( )
+                                *      @brief This function returns a container with the name of the groups.
+                                *      @return std::string A list with the name of the button groups.
+                                */
+                               std::string
+                               GetIconPath( );
+                               // ----------------------------------------------------------------------------------
+                               /*! @fn KeyMapList ContainerSettings::GetGroupNameList( )
+                                *      @brief This function returns a container with the name of the groups.
+                                *      @return std::string A list with the name of the button groups.
+                                */
+                               std::string
+                               GetDescription( );
+                               // ----------------------------------------------------------------------------------
+                               /*! @fn KeyMapList ContainerSettings::GetGroupNameList( )
+                                *      @brief This function returns a container with the name of the groups.
+                                *      @return std::string A list with the name of the button groups.
+                                */
+                               void
+                               Execute( );
+                               // ----------------------------------------------------------------------------------
+                       private:
+                               ButtonPair* m_ButtonPair; //! <ButtonPair* ButtonPail pointer.
+               };
        }//ecapseman
 }//ecapseman