X-Git-Url: https://git.creatis.insa-lyon.fr/pubgit/?a=blobdiff_plain;f=lib%2FmaracasVisuLib%2Fsrc%2Finterface%2FwxWindows%2Fwidgets%2FcreaButtonContainer%2Fmodel%2FcontainerSettings.h;h=8be486179452cd03c315f2ea756ea1679e0dc907;hb=8138ced89fa9f1cc6933ff739dfa28b1e3c3883b;hp=1707176244cceea21679d2fec5927d205a8a1d62;hpb=4b092ee0b1bcda4d298e5ffc3b58b599e273db20;p=creaMaracasVisu.git diff --git a/lib/maracasVisuLib/src/interface/wxWindows/widgets/creaButtonContainer/model/containerSettings.h b/lib/maracasVisuLib/src/interface/wxWindows/widgets/creaButtonContainer/model/containerSettings.h index 1707176..8be4861 100644 --- a/lib/maracasVisuLib/src/interface/wxWindows/widgets/creaButtonContainer/model/containerSettings.h +++ b/lib/maracasVisuLib/src/interface/wxWindows/widgets/creaButtonContainer/model/containerSettings.h @@ -1,95 +1,127 @@ -/*************************************************************** - * 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: - **************************************************************/ +/*! + * @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 -#include -#include -#include "system.h" +#include -#include "functor.h" +#include "structBCSettings.h" +#include "system.h" -///@namespace +/*! @namespace + * @brief Contains the creaButtonContainer library included in creaMaracasVisu. + */ namespace creaButtonContainer { - ///@namespace + /*! @namespace + * @brief Contains the implementation of the model in creaButtonContainer library. + * @see MVC Software Architecture + */ namespace model { - /*! - * @class ContainerSettings - * @brief This class contains all information of groups and its buttons + /*! @class ContainerSettings containerSettings.h "containerSettings.h" + * @brief This class contains the settings of the button container. */ class ContainerSettings { public: - /*! - * @brief This is the default constructor + //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( ); - /*! - * @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. + // ---------------------------------------------------------------------------------- + /*! @fn ButtonGroupMap ContainerSettings::GetButtonGroupContainer( ) + * @brief This method returns a container of buttons ordered by group. + * @return ButtonGroupMap A container with buttons */ 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. + // ---------------------------------------------------------------------------------- + /*! @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( ); - /*! - * @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 ContainerSettings::SetButtonGroupContainer( ButtonGroupMap m_ButtonGroupContainer ) + * @brief This method allows to create the ButtonGroupContainer. + * @param bgContainer The ButtonGroupMap with all buttons. */ 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. + 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 m_GroupNameList ); + SetGroupNameList( KeyMapList gNameList ); + // ---------------------------------------------------------------------------------- /*! - * @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. + * @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 - 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. + 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( const std::string & groupName, const std::string buttonName, - const std::string iconpath, const std::string buttonDescription, - FunctionEventType event ); - + 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; - KeyMapList m_GroupNameList; + ButtonGroupMap m_ButtonGroupContainer; //!