/************************************************************************************//*!
 * Name:      @file buttonContainerController.h
 * Purpose:   @brief This contains the ButtonContainerController class
 * Author:    @author Diego CACERES (diego.caceres[AT]creatis.insa-lyon.fr)
 * 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<view>
	namespace view
	{
		//Predefinition of ButtonContainerPanel FriendClass!!
		//! @class ButtonContainerPanel buttonContainerPanel.h "buttonContainerPanel.h"

		class ButtonContainerPanel;
	}
	//!	@namespace<controller>
	namespace controller
	{
		/*! @class ButtonContainerController buttonContainerController.h "buttonContainerController.h"
		 *	@brief This class contains the ButtonContainerPanel controller
		 *  This class describes button events.
		 */
		class ButtonContainerController : public wxEvtHandler
		{
			public:
				//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:
				/*!	@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; //! <ButtonContainerPanel View pointer.
		};
	}//ecapsename
}//ecapsename

#endif //BUTTONCONTAINERCONTROLLER_H_