lib/maracasVisuLib/src/interface/wxWindows/widgets/creaButtonContainer/model/system.h

   1 /*!
   2  * @file system.h
   3  * @brief Contains a system typedefs used to reuse code.
   4  * @author Diego CACERES (diego.caceres[AT]creatis.insa-lyon.fr)
   5  * @date  2011-05-19
   6 */
   7
   8 #ifndef SYSTEM_H_
   9 #define SYSTEM_H_
  10
  11 #include <list>
  12 #include <map>
  13 #include <iostream>
  14 #include "functor.h"
  15
  16 /*!     @namespace <creaButtonContainer>
  17  *      @brief Contains the creaButtonContainer library included in creaMaracasVisu.
  18  */
  19 namespace creaButtonContainer
  20 {
  21         /*!     @typedef model::TFunctor* FunctionEventType;
  22          *      @brief Defines the FunctionEventType type.
  23          */
  24         typedef model::TFunctor* FunctionEventType;
  25         // ----------------------------------------------------------------------------------
  26         /*!     @typedef creaButtonContainer::view::Button Button;
  27          *      @brief Defines the ActionButton type.
  28          *      First is the button description, Second FunctionEventType
  29          */
  30         typedef std::pair< std::string, FunctionEventType > ButtonAction;
  31         // ----------------------------------------------------------------------------------
  32         /*!     @typedef std::pair< std::string, std::string > ButtonInfo;
  33          *      @brief Defines the ButtonInfo type.
  34          *      First is the ButtonName and Second is the IconPath
  35          */
  36         typedef std::pair< std::string, std::string > ButtonInfo;
  37         // ----------------------------------------------------------------------------------
  38         /*!     @typedef std::pair< ButtonInfo*, ActionButton* > ButtonPair;
  39          *      @brief Defines the ButtonPair type.
  40          */
  41         typedef std::pair< ButtonInfo*, ButtonAction* > ButtonPair;
  42         // ----------------------------------------------------------------------------------
  43         /*!     @typedef std::list< std::string > KeyMapList;
  44          *      @brief Defines the KeyMapList type.
  45          */
  46         typedef std::list< std::string > KeyMapList;
  47         // ----------------------------------------------------------------------------------
  48         /*!     @typedef std::list< ButtonPair* > ButtonList;
  49          *      @brief Defines the ButtonList type.
  50          */
  51         typedef std::list< ButtonPair* > ButtonList;
  52         // ----------------------------------------------------------------------------------
  53         /*!     @typedef std::map< std::string, ButtonList > ButtonGroupMap;
  54          *      @brief Defines the ButtonGroupMap type.
  55          */
  56         typedef std::map< std::string, ButtonList > ButtonGroupMap;
  57 // ----------------------------------------------------------------------------------
  58 }
  59
  60 #endif /* SYSTEM_H_ */