/***************************************************************
 * Name:      @file containerSettings.h
 * Purpose:   @brief This contains ContainerSettings class
 * Author:    @author Diego CACERES (diego.caceres[AT]creatis.insa-lyon.fr)
 * Modified:  2011-05-09
 * Copyright: Diego CACERES (http://www.creatis.insa-lyon.fr/~caceres/)
 * License:
 **************************************************************/

#ifndef BUTTONGROUPSETTINGS_H_
#define BUTTONGROUPSETTINGS_H_

#include <list>
#include <map>
#include <iostream>
#include "system.h"

#include "functor.h"

///@namespace <creaButtonContainer>
namespace creaButtonContainer
{
	///@namespace <model>
	namespace model
	{
		/*!
		 * @class ContainerSettings
		 * @brief This class contains all information of groups and its buttons
		 */
		class ContainerSettings
		{
			public:
				/*!
				 * @brief This is the default constructor
				 */
				ContainerSettings( );
				virtual
				~ContainerSettings( );
				/*!
				 * @brief This function allows to create the ButtonGroupContainer.
				 * @param the wxWindow* parent to be attached.
				 * @param The Container settings.
				 * @return The wx button group container.
				 */
				ButtonGroupMap
				GetButtonGroupContainer( );
				/*!
				 * @brief This function allows to create the ButtonGroupContainer.
				 * @param the wxWindow* parent to be attached.
				 * @param The Container settings.
				 * @return The wx button group container.
				 */
				KeyMapList
				GetGroupNameList( );
				/*!
				 * @brief This function allows to create the ButtonGroupContainer.
				 * @param the wxWindow* parent to be attached.
				 * @param The Container settings.
				 * @return The wx button group container.
				 */
				void
				SetButtonGroupContainer( ButtonGroupMap m_ButtonGroupContainer );
				/*!
				 * @brief This function allows to create the ButtonGroupContainer.
				 * @param the wxWindow* parent to be attached.
				 * @param The Container settings.
				 * @return The wx button group container.
				 */
				void
				SetGroupNameList( KeyMapList m_GroupNameList );
				/*!
				 * @brief This function allows to create the ButtonGroupContainer.
				 * @param the wxWindow* parent to be attached.
				 * @param The Container settings.
				 * @return The wx button group container.
				 */
				void
				CreateGroup( const std::string & groupName );
				/*!
				 * @brief This function allows to create the ButtonGroupContainer.
				 * @param the wxWindow* parent to be attached.
				 * @param The Container settings.
				 * @return The wx button group container.
				 */
				void
				AddButton( const std::string & groupName, const std::string buttonName,
				    const std::string iconpath, const std::string buttonDescription,
				    FunctionEventType event );

			private:
				ButtonGroupMap m_ButtonGroupContainer;
				KeyMapList m_GroupNameList;
		};
	}
}

#endif /* BUTTONGROUPSETTINGS_H_ */