/************************************************************************************//*!
 * 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"

//!	@namespace <creaButtonContainer>
namespace creaButtonContainer
{
	//!	@namespace <view>
	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
		{
			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

#endif // BUTTON_H