v1.0.3 BUG 1404

[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 7d83a710d0a9172371fa30e5611598e9be5c34ba..8462034bb47f89adbd9101b805239988d740191d 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,8 +1,8 @@
 /*!
  * @file button.h
- * @brief This contains the Button class.
+ * @brief Contains the Button class.
  * @author Diego CACERES (diego.caceres[AT]creatis.insa-lyon.fr)
- * @date  2011-05-19
+ * @date  2011-06-02
  */
 
 #ifndef BUTTON_H
@@ -11,9 +11,7 @@
 #include <wx/bmpbuttn.h>
 #include <wx/image.h>
 #include <wx/string.h>
-#include <string>
-#include <iostream>
-#include "functor.h"
+
 #include "system.h"
 
 /*!    @namespace <creaButtonContainer>
@@ -27,19 +25,21 @@ namespace creaButtonContainer
         */
        namespace view
        {
-               /*! @class Button : public wxBitmapButton button.h "button.h"
+               /*! @class Button button.h "button.h"
                 *      @brief This class contains the Button in the view perspective.
-                *  @details This class contains the information of a button, it derives from wxBitmapButton
+                *  @details This class contains the information of a button, it derives from wxBitmapButton.
                 *  @see <a href="http://docs.wxwidgets.org/stable/wx_wxbitmapbutton.html">wxBitmapButton</a>
                 */
                class Button : public wxBitmapButton
                {
                        public:
                                //typedef definition
+                               // ----------------------------------------------------------------------------------
                                /*!     @typedef creaButtonContainer::model::TFunctor TFunctor;
                                 *      @brief Defines the TFunctor type.
                                 */
                                typedef creaButtonContainer::model::TFunctor TFunctor;
+                               // ----------------------------------------------------------------------------------
                                //end of typedef definition
                        public:
                                // ----------------------------------------------------------------------------------
@@ -58,44 +58,45 @@ namespace creaButtonContainer
                                ~Button( );
                                // ----------------------------------------------------------------------------------
                                /*! @fn long Button::GetID( );
-                                *      @brief This function gets the wxID of the button.
+                                *      @brief This method gets the wxID of the button.
                                 *      @return long wxID of the button.
                                 */
                                long
                                GetID( );
                                // ----------------------------------------------------------------------------------
                                /*! @fn std::string Button::GetButtonName( );
-                                *      @brief This function returns the name of the button.
+                                *      @brief This method returns the name of the button.
                                 *      @return std::string The name of the button.
                                 */
-                               std::string
+                               StringType
                                GetButtonName( );
                                // ----------------------------------------------------------------------------------
                                /*! @fn std::string Button::GetIconPath( );
-                                *      @brief This function returns the iconPath of the button.
+                                *      @brief This method returns the iconPath of the button.
                                 *      @return std::string The path of the icon.
                                 */
-                               std::string
+                               StringType
                                GetIconPath( );
                                // ----------------------------------------------------------------------------------
                                /*! @fn std::string Button::GetDescription( );
-                                *      @brief This function returns a the description of the button.
+                                *      @brief This method returns a the description of the button.
                                 *      @return std::string The tooltip of the button.
                                 */
-                               std::string
+                               StringType
                                GetDescription( );
                                // ----------------------------------------------------------------------------------
                                /*! @fn void Button::Execute( );
-                                *      @brief This function executes the Functor (Call_Back Function).
+                                *      @brief This method executes the Functor (Call_Back Function).
                                 *      This is the event of the button that it was defined to be called remotely using
                                 *      call_back functions. In this project it was implemented using Functors.
+                                *      @exception std::bad_alloc
                                 *      @see TFunctor
                                 */
                                void
                                Execute( );
                                // ----------------------------------------------------------------------------------
                        private:
-                               ButtonPair* m_ButtonPair; //! <ButtonPair* ButtonPair pointer.
+                               ButtonPair* m_ButtonPair; //! <The pair with the button information.
                };
        }//ecapseman
 }//ecapseman