-/************************************************************************************//*!
- * 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:
- ***************************************************************************************/
+/*!
+ * @file button.h
+ * @brief This contains the Button class.
+ * @author Diego CACERES (diego.caceres[AT]creatis.insa-lyon.fr)
+ * @date 2011-05-19
+ */
#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"
-//! @namespace <creaButtonContainer>
+/*! @namespace <creaButtonContainer>
+ * @brief Contains the creaButtonContainer library included in creaMaracasVisu.
+ */
namespace creaButtonContainer
{
- //! @namespace <view>
+ /*! @namespace <creaButtonContainer::view>
+ * @brief Contains the implementation of the view in creaButtonContainer library.
+ * @see <a href="http://en.wikipedia.org/wiki/Model-view-controller">MVC Software Architecture</a>
+ */
namespace view
{
- /*! @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 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
+ * @see <a href="http://docs.wxwidgets.org/stable/wx_wxbitmapbutton.html">wxBitmapButton</a>
*/
class Button : public wxBitmapButton
{
public:
- /*! @typedef creaButtonContainer::model::ContainerSettings ButtonGroupModel;
- * @brief Defines the ButtonGroupModel type.
+ //typedef definition
+ /*! @typedef creaButtonContainer::model::TFunctor TFunctor;
+ * @brief Defines the TFunctor type.
*/
typedef creaButtonContainer::model::TFunctor TFunctor;
+ //end of typedef definition
public:
// ----------------------------------------------------------------------------------
- /*! @fn void ContainerSettings::ContainerSettings( )
+ /*! @fn Button::Button( wxWindow* parent, long id, ButtonPair* pair );
* @brief This is the constructor.
+ * @param parent The wxWindow* parent.
+ * @param id The wxID of the button.
+ * @param pair The button information.
*/
Button( wxWindow* parent, long id, ButtonPair* pair );
// ----------------------------------------------------------------------------------
- /*! @fn void ContainerSettings::ContainerSettings( )
- * @brief This is the constructor.
+ /*! @fn virtual Button::~Button( );
+ * @brief This is the destructor.
*/
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.
+ /*! @fn long Button::GetID( );
+ * @brief This function gets the wxID of the button.
+ * @return long wxID of the button.
*/
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.
+ /*! @fn std::string Button::GetButtonName( );
+ * @brief This function returns the name of the button.
+ * @return std::string The name of the button.
*/
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.
+ /*! @fn std::string Button::GetIconPath( );
+ * @brief This function returns the iconPath of the button.
+ * @return std::string The path of the icon.
*/
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.
+ /*! @fn std::string Button::GetDescription( );
+ * @brief This function returns a the description of the button.
+ * @return std::string The tooltip of the button.
*/
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.
+ /*! @fn void Button::Execute( );
+ * @brief This function 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.
+ * @see TFunctor
*/
void
Execute( );
// ----------------------------------------------------------------------------------
private:
- ButtonPair* m_ButtonPair; //! <ButtonPair* ButtonPail pointer.
+ ButtonPair* m_ButtonPair; //! <ButtonPair* ButtonPair pointer.
};
}//ecapseman
}//ecapseman
git://git.creatis.insa-lyon.fr / creaMaracasVisu.git / blobdiff