1 /*# ---------------------------------------------------------------------
3 # Copyright (c) CREATIS (Centre de Recherche en Acquisition et Traitement de l'Image
5 # Authors : Eduardo Davila, Frederic Cervenansky, Claire Mouton
6 # Previous Authors : Laurent Guigues, Jean-Pierre Roux
7 # CreaTools website : www.creatis.insa-lyon.fr/site/fr/creatools_accueil
9 # This software is governed by the CeCILL-B license under French law and
10 # abiding by the rules of distribution of free software. You can use,
11 # modify and/ or redistribute the software under the terms of the CeCILL-B
12 # license as circulated by CEA, CNRS and INRIA at the following URL
13 # http://www.cecill.info/licences/Licence_CeCILL-B_V1-en.html
14 # or in the file LICENSE.txt.
16 # As a counterpart to the access to the source code and rights to copy,
17 # modify and redistribute granted by the license, users are provided only
18 # with a limited warranty and the software's author, the holder of the
19 # economic rights, and the successive licensors have only limited
22 # The fact that you are presently reading this means that you have had
23 # knowledge of the CeCILL-B license and that you accept its terms.
24 # ------------------------------------------------------------------------ */
27 * @file containerSettings.h
28 * @brief Contains the ContainerSettings class
29 * @author Diego CACERES (diego.caceres[AT]creatis.insa-lyon.fr)
33 #ifndef BUTTONGROUPSETTINGS_H_
34 #define BUTTONGROUPSETTINGS_H_
38 #include "structBCSettings.h"
41 /*! @namespace <creaButtonContainer>
42 * @brief Contains the creaButtonContainer library included in creaMaracasVisu.
44 namespace creaButtonContainer
46 /*! @namespace <creaButtonContainer::model>
47 * @brief Contains the implementation of the model in creaButtonContainer library.
48 * @see <a href="http://en.wikipedia.org/wiki/Model-view-controller">MVC Software Architecture</a>
52 /*! @class ContainerSettings containerSettings.h "containerSettings.h"
53 * @brief This class contains the settings of the button container.
55 class ContainerSettings
59 // ----------------------------------------------------------------------------------
60 /*! @typedef creaButtonContainer::model::BCSettingsStruct BCSettingsStruct;
61 * @brief Defines the BCSettingsStruct type.
63 typedef creaButtonContainer::model::BCSettingsStruct BCSettingsStruct;
64 // ----------------------------------------------------------------------------------
65 /*! @typedef std::vector< BCPSettingsStruct* > BCStructVectorType;
66 * @brief Defines the BCStructVectorType type.
68 typedef std::vector< BCSettingsStruct* > BCStructVectorType;
69 // ----------------------------------------------------------------------------------
70 //end of typedef definition
72 // ----------------------------------------------------------------------------------
73 /*! @fn ContainerSettings::ContainerSettings( )
74 * @brief This is the constructor.
77 // ----------------------------------------------------------------------------------
78 /*! @fn virtual ContainerSettings::~ContainerSettings( )
79 * @brief This is the destructor.
82 ~ContainerSettings( );
83 // ----------------------------------------------------------------------------------
84 /*! @fn ButtonGroupMap ContainerSettings::GetButtonGroupContainer( )
85 * @brief This method returns a container of buttons ordered by group.
86 * @return ButtonGroupMap A container with buttons
89 GetButtonGroupContainer( );
90 // ----------------------------------------------------------------------------------
91 /*! @fn KeyMapList ContainerSettings::GetGroupNameList( )
92 * @brief This method returns a container with the name of the groups.
93 * @return KeyMapList A list with the name of the button groups.
97 // ----------------------------------------------------------------------------------
98 /*! void ContainerSettings::SetButtonGroupContainer( ButtonGroupMap m_ButtonGroupContainer )
99 * @brief This method allows to create the ButtonGroupContainer.
100 * @param bgContainer The ButtonGroupMap with all buttons.
103 SetButtonGroupContainer( ButtonGroupMap bgContainer );
104 // ----------------------------------------------------------------------------------
105 /*! void ContainerSettings::SetGroupNameList( KeyMapList gNameList )
106 * @brief This method sets a container with the name of the groups.
107 * @param gNameList the KeyMapList with all groupNames.
110 SetGroupNameList( KeyMapList gNameList );
111 // ----------------------------------------------------------------------------------
113 * @fn ContainerSettings::AddButton( const std::string & groupName, const std::string buttonName,
114 const std::string iconpath, const std::string buttonDescription,
115 FunctionEventType event )
116 * @brief This method adds a new button to the container.
117 * @param groupName The name of the group of buttons.
118 * @param buttonName The ID of the button.
119 * @param iconpath The path of the button icon.
120 * @param buttonDescription The description of the button.
121 * @param event The event associated to the button.
122 * @see class Functor, ConcreteFunctor for add an event for a button.
123 * @exception std::bad_alloc
126 AddButton( const StringType & groupName, const StringType &buttonName,
127 const StringType &iconpath, const StringType &buttonDescription,
128 FunctionEventType event );
129 // ----------------------------------------------------------------------------------
130 /*! @fn void AddButton( BCSettingsStruct* info );
131 * @brief This method adds a new button to the container using the
132 * BCSettingsStruct structure.
133 * @exception std::bad_alloc
137 AddButton( BCSettingsStruct* info );
138 // ----------------------------------------------------------------------------------
139 /*! @fn void AddButtons( BCStructVectorType infoList );
140 * @brief This method adds new buttons to the container.
141 * @exception std::bad_alloc
145 AddButtons( BCStructVectorType infoList );
146 // ----------------------------------------------------------------------------------
148 ButtonGroupMap m_ButtonGroupContainer; //! <The container with the group of buttons.
149 KeyMapList m_GroupNameList; //! <The container with the name of the groups of buttons.
154 #endif /* BUTTONGROUPSETTINGS_H_ */