lib/maracasVisuLib/src/interface/wxWindows/widgets/creaPanelButtonContainer/buttonContainerSettings.h

   1 /*# ---------------------------------------------------------------------
   2 #
   3 # Copyright (c) CREATIS (Centre de Recherche en Acquisition et Traitement de l'Image
   4 #                        pour la Sant�)
   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
   8 #
   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.
  15 #
  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
  20 #  liability.
  21 #
  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 # ------------------------------------------------------------------------ */
  25
  26 /*!
  27  * @file buttonContainerSettings.h
  28  * @brief This contains the ButtonContainerSettings class.
  29  * @author Diego CACERES (diego.caceres[AT]creatis.insa-lyon.fr)
  30  * @date  2011-06-02
  31  */
  32
  33 #ifndef BUTTONCONTAINERSETTINGS_H_
  34 #define BUTTONCONTAINERSETTINGS_H_
  35
  36 #include <wx/panel.h>
  37 #include <wx/bitmap.h>
  38 #include <wx/listctrl.h>
  39
  40 #include <list>
  41 #include <map>
  42 #include <vector>
  43 #include <iostream>
  44
  45 #include "structBCPSettings.h"
  46 #include "containerSettings.h"
  47 #include "functor.h"
  48
  49
  50 /*!     @namespace <creaPanelButtonContainer>
  51  *      @brief Contains the creaPanelButtonContainer library included in creaMaracasVisu.
  52  */
  53 namespace creaPanelButtonContainer
  54 {
  55         /*! @class ButtonContainerSettings buttonContainerSettings.h "buttonContainerSettings.h"
  56          *      @brief This class contains the settings of the buttons.
  57          */
  58         class ButtonContainerSettings
  59         {
  60                 public:
  61                         //typedef definition.
  62                         // ----------------------------------------------------------------------------------
  63                         /*!     @typedef std::string* StringType;
  64                          *      @brief Defines the StringType type.
  65                          */
  66                         typedef std::string StringType;
  67                         // ----------------------------------------------------------------------------------
  68                         /*!     typedef creaButtonContainer::model::TFunctor TFunctor;
  69                          *      @brief Defines the TFunctor type.
  70                          */
  71                         typedef creaButtonContainer::model::TFunctor TFunctor;
  72                         // ----------------------------------------------------------------------------------
  73                         /*!     @typedef creaButtonContainer::model::ContainerSettings ButtonGroupSettings;
  74                          *      @brief Defines the ButtonGroupSettings type.
  75                          */
  76                         typedef creaButtonContainer::model::ContainerSettings ButtonGroupSettings;
  77                         // ----------------------------------------------------------------------------------
  78                         /*!     @typedef wxPanel* PanelButton;
  79                          *      @brief Defines the PanelButton type.
  80                          */
  81                         typedef wxPanel* PanelButton;
  82                         // ----------------------------------------------------------------------------------
  83                         /*!     @typedef std::pair< std::string, PanelButton > ActionButton;
  84                          *      @brief Defines the ActionButton type.
  85                          *      First is the button description, Second FunctionEventType
  86                          */
  87                         typedef std::pair< std::string, PanelButton > ActionButton;
  88
  89                         // ----------------------------------------------------------------------------------
  90                         /*!     @typedef std::pair< std::string, wxBitmap > ButtonInfo;
  91                          *      @brief Defines the ButtonInfo type.
  92                          *      First is the ButtonName, Second is the ImageIcon
  93                          */
  94                         typedef std::pair< std::string, wxBitmap > ButtonInfo;
  95
  96                         // ----------------------------------------------------------------------------------
  97                         /*!     @typedef std::pair< ButtonInfo*, ActionButton* > ButtonPair;
  98                          *      @brief Defines the ButtonPair type.
  99                          */
 100                         typedef std::pair< ButtonInfo*, ActionButton* > ButtonPair;
 101                         // ----------------------------------------------------------------------------------
 102                         /*!     @typedef std::list< std::string > KeyMapList;
 103                          *      @brief Defines the KeyMapList type.
 104                          */
 105                         typedef std::list< std::string > KeyMapList;
 106
 107                         // ----------------------------------------------------------------------------------
 108                         /*!     @typedef std::list< ButtonPair* > ButtonList;
 109                          *      @brief Defines the ButtonList type.
 110                          */
 111                         typedef std::list< ButtonPair* > ButtonList;
 112
 113                         // ----------------------------------------------------------------------------------
 114                         /*!     @typedef std::map< std::string, ButtonList > ButtonGroupMap;
 115                          *      @brief Defines the ButtonGroupMap type.
 116                          */
 117                         typedef std::map< std::string, ButtonList > ButtonGroupMap;
 118                         // ----------------------------------------------------------------------------------
 119                         /*!     @typedef std::vector< BCPSettingsStruct* > BCStructVectorType;
 120                          *      @brief Defines the BCStructVectorType type.
 121                          */
 122                         typedef std::vector< BCPSettingsStruct* > BCStructVectorType;
 123                         //end typedef definition
 124                         // ----------------------------------------------------------------------------------
 125                         /*! @class ButtonContainerSettings buttonContainerSettings.h "buttonContainerSettings.h"
 126                          *      @brief This class contains the settings of the button container.
 127                          */
 128
 129                         typedef wxListItem Item;
 130                         typedef std::list < tList* > ItemsList;
 131                         typedef std::map< StringType, ListLst > ListGroupMap;
 132
 133
 134                 public:
 135                         // ----------------------------------------------------------------------------------
 136                         /*! @fn ButtonContainerSettings( );
 137                          *      @brief This is the default constructor.
 138                          */
 139                         ButtonContainerSettings( );
 140                         // ----------------------------------------------------------------------------------
 141                         /*! @fn virtual ~ButtonContainerSettings( );
 142                          *      @brief This is the destructor.
 143                          */
 144                         virtual
 145                         ~ButtonContainerSettings( );
 146
 147                         // ----------------------------------------------------------------------------------
 148                         /*! @fn ButtonGroupMap GetButtonGroupContainer( );
 149                          *      @brief This method returns ButtonGroupMap with all buttons.
 150                          * @return
 151                          */
 152                         ButtonGroupMap
 153                         GetButtonGroupContainer( );
 154                         // ----------------------------------------------------------------------------------
 155                         /*! @fn KeyMapList GetGroupNameList( );
 156                          *      @brief This method returns a KeyMapsList with the name of the groups.
 157                          * @return
 158                          */
 159                         KeyMapList
 160                         GetGroupNameList( );
 161                         // ----------------------------------------------------------------------------------
 162                         /*! @fn PanelButton GetPanelButton( const std::string &buttonName );
 163                          *      @brief This method returns the panel of a button.
 164                          *      @param buttonName
 165                          *      @exception std::bad_alloc
 166                          *      @return
 167                          */
 168                         PanelButton
 169                         GetPanelButton( const std::string &buttonName );
 170                         // ----------------------------------------------------------------------------------
 171                         /*! @fn ButtonGroupSettings* GetButtonGroupSettings( TFunctor* functor );
 172                          *      @brief this method return the settings the generic settings for creaButtonContainer.
 173                          * @param functor The function to be called in the action button.
 174                          * @exception std::bad_alloc
 175                          * @return
 176                          */
 177                         ButtonGroupSettings*
 178                         GetButtonGroupSettings( TFunctor* functor );
 179                         // ----------------------------------------------------------------------------------
 180                         /*! @fn void SetButtonGroupContainer( ButtonGroupMap bGroupContainer );
 181                          *      @brief This method sets the button group container.
 182                          * @param bGroupContainer
 183                          */
 184
 185                         // ----------------------------------------------------------------------------------
 186
 187                         ButtonGroupSettings*
 188                         GetListGroupSettings();
 189
 190                         // ----------------------------------------------------------------------------------
 191
 192
 193
 194                         void
 195                         SetButtonGroupContainer( ButtonGroupMap bGroupContainer );
 196                         // ----------------------------------------------------------------------------------
 197                         /*! @fn void SetGroupNameList( KeyMapList gNameList );
 198                          *      @brief this method sets the groupName list
 199                          * @param gNameList
 200                          */
 201                         void
 202                         SetGroupNameList( KeyMapList gNameList );
 203
 204                         // ----------------------------------------------------------------------------------
 205                         /*! @fn void AddButton( const std::string &groupName, const std::string &buttonName,
 206                          const std::string &iconpath, const std::string &buttonDescription,
 207                          PanelButton panel );
 208                          * @brief This method adds a new button into a group of buttons.
 209                          * @param groupName The button groupName
 210                          * @param buttonName The buttonName
 211                          * @param iconpath The path of the icon
 212                          * @param buttonDescription The button tooltip
 213                          * @param panel The panel to be called when the button is clicked
 214                          * @exception std::bad_alloc
 215                          */
 216                         void
 217                         AddButton( const std::string &groupName, const std::string &buttonName,
 218                             const wxBitmap &icon, const std::string &buttonDescription,
 219                             PanelButton panel );
 220
 221                         // ----------------------------------------------------------------------------------
 222                         /*! @fn void AddButton( BCPSettingsStruct* info );
 223                          * @brief This method adds a new button into a group of buttons.
 224                          * @param info The pointer to BCPSettingsStruct.
 225                          * @exception std::bad_alloc
 226                          */
 227                         void
 228                         AddButton( BCPSettingsStruct* info );
 229
 230                         // ----------------------------------------------------------------------------------
 231                         /*! @fn void AddButtons( BCStructVectorType infoList );
 232                          * @brief This method adds new buttons into the container.
 233                          * @param infoList The BCStructVectorType
 234                          * @exception std::bad_alloc
 235                          */
 236                         void
 237                         AddButtons( BCStructVectorType infoList );
 238
 239                         void
 240                         AddItem (BCPSettingsStruct* info);
 241
 242                         void
 243                         AddItems( BCStructVectorType infoList );
 244
 245                         // ----------------------------------------------------------------------------------
 246                 private:
 247                         ButtonGroupMap m_ButtonGroupContainer; //!<This is the map with the groups of buttons.
 248                         KeyMapList m_GroupNameList; //!<This is a container with the name of the groups.
 249
 250                         ListGroupMap m_ListGroupContainer;
 251         };
 252 }//ecapseman
 253 #endif /* BUTTONCONTAINERSETTINGS_H_ */