/*!
 * @file containerSettings.h
 * @brief Contains the ContainerSettings class
 * @author Diego CACERES (diego.caceres[AT]creatis.insa-lyon.fr)
 * @date  2011-06-02
 */

#ifndef BUTTONGROUPSETTINGS_H_
#define BUTTONGROUPSETTINGS_H_

#include <vector>

#include "structBCSettings.h"
#include "system.h"

/*!	@namespace <creaButtonContainer>
 *	@brief Contains the creaButtonContainer library included in creaMaracasVisu.
 */
namespace creaButtonContainer
{
	/*! @namespace <creaButtonContainer::model>
	 *	@brief Contains the implementation of the model in creaButtonContainer library.
	 *	@see <a href="http://en.wikipedia.org/wiki/Model-view-controller">MVC Software Architecture</a>
	 */
	namespace model
	{
		/*! @class ContainerSettings containerSettings.h "containerSettings.h"
		 *	@brief This class contains the settings of the button container.
		 */
		class ContainerSettings
		{
			public:
				//typedef definition
				// ----------------------------------------------------------------------------------
				/*!	@typedef creaButtonContainer::model::BCSettingsStruct BCSettingsStruct;
				 *	@brief Defines the BCSettingsStruct type.
				 */
				typedef creaButtonContainer::model::BCSettingsStruct BCSettingsStruct;
				// ----------------------------------------------------------------------------------
				/*!	@typedef std::vector< BCPSettingsStruct* > BCStructVectorType;
				 *	@brief Defines the BCStructVectorType type.
				 */
				typedef std::vector< BCSettingsStruct* > BCStructVectorType;
				// ----------------------------------------------------------------------------------
				//end of typedef definition
			public:
				// ----------------------------------------------------------------------------------
				/*! @fn ContainerSettings::ContainerSettings( )
				 *	@brief This is the constructor.
				 */
				ContainerSettings( );
				// ----------------------------------------------------------------------------------
				/*! @fn virtual ContainerSettings::~ContainerSettings( )
				 *	@brief This is the destructor.
				 */
				virtual
				~ContainerSettings( );
				// ----------------------------------------------------------------------------------
				/*! @fn ButtonGroupMap ContainerSettings::GetButtonGroupContainer( )
				 * 	@brief This method returns a container of buttons ordered by group.
				 * 	@return ButtonGroupMap A container with buttons
				 */
				ButtonGroupMap
				GetButtonGroupContainer( );
				// ----------------------------------------------------------------------------------
				/*! @fn KeyMapList ContainerSettings::GetGroupNameList( )
				 * 	@brief This method returns a container with the name of the groups.
				 * 	@return KeyMapList A list with the name of the button groups.
				 */
				KeyMapList
				GetGroupNameList( );
				// ----------------------------------------------------------------------------------
				/*! void ContainerSettings::SetButtonGroupContainer( ButtonGroupMap m_ButtonGroupContainer )
				 * 	@brief This method allows to create the ButtonGroupContainer.
				 * 	@param bgContainer The ButtonGroupMap with all buttons.
				 */
				void
				SetButtonGroupContainer( ButtonGroupMap bgContainer );
				// ----------------------------------------------------------------------------------
				/*! void ContainerSettings::SetGroupNameList( KeyMapList gNameList )
				 * @brief This method sets a container with the name of the groups.
				 * @param gNameList the KeyMapList with all groupNames.
				 */
				void
				SetGroupNameList( KeyMapList gNameList );
				// ----------------------------------------------------------------------------------
				/*!
				 * @fn ContainerSettings::AddButton( const std::string & groupName, const std::string buttonName,
				 const std::string iconpath, const std::string buttonDescription,
				 FunctionEventType event )
				 * @brief This method adds a new button to the container.
				 * @param groupName The name of the group of buttons.
				 * @param buttonName The ID of the button.
				 * @param iconpath The path of the button icon.
				 * @param buttonDescription The description of the button.
				 * @param event The event associated to the button.
				 * @see class Functor, ConcreteFunctor for add an event for a button.
				 * @exception std::bad_alloc
				 */
				void
				AddButton( const StringType & groupName, const StringType &buttonName,
				    const StringType &iconpath, const StringType &buttonDescription,
				    FunctionEventType event );
				// ----------------------------------------------------------------------------------
				/*! @fn void AddButton( BCSettingsStruct* info );
				 * 	@brief This method adds a new button to the container using the
				 * 	BCSettingsStruct structure.
				 * 	@exception std::bad_alloc
				 * 	@param info
				 */
				void
				AddButton( BCSettingsStruct* info );
				// ----------------------------------------------------------------------------------
				/*! @fn void AddButtons( BCStructVectorType infoList );
				 *	@brief This method adds new buttons to the container.
				 *	@exception std::bad_alloc
				 * 	@param infoList
				 */
				void
				AddButtons( BCStructVectorType infoList );
				// ----------------------------------------------------------------------------------
			private:
				ButtonGroupMap m_ButtonGroupContainer; //! <The container with the group of buttons.
				KeyMapList m_GroupNameList; //! <The container with the name of the groups of buttons.
		};
	}
}

#endif /* BUTTONGROUPSETTINGS_H_ */