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

   1 /*!
   2  * @file structBCSettings.h
   3  * @brief Contains BCSettingsStruct structure.
   4  * @author Diego CACERES (diego.caceres[AT]creatis.insa-lyon.fr)
   5  * @date  2011-05-24
   6  */
   7
   8 #ifndef STRUCTBCSETTINGS_H_
   9 #define STRUCTBCSETTINGS_H_
  10
  11 #include <string>
  12 #include "system.h"
  13
  14 /*!     @namespace <creaButtonContainer>
  15  *      @brief Contains the creaButtonContainer library included in creaMaracasVisu.
  16  */
  17 namespace creaButtonContainer
  18 {
  19         /*! @namespace <creaButtonContainer::model>
  20          *      @brief Contains the implementation of the model in creaButtonContainer library.
  21          *      @see <a href="http://en.wikipedia.org/wiki/Model-view-controller">MVC Software Architecture</a>
  22          */
  23         namespace model
  24         {
  25                 /*! @struct <BCSettingsStruct> structBCSettings.h "structBCSettings.h"
  26                  *      @brief This is the Button Container Settings structure.
  27                  */
  28                 struct BCSettingsStruct
  29                 {
  30                                 std::string groupName; //! <The name of the group of buttons.
  31                                 std::string buttonName; //! <The name of the button.
  32                                 std::string iconpath; //! <The iconPath of the button.
  33                                 std::string buttonDescription; //! <The description of the button.
  34                                 FunctionEventType eventFunction; //! <The event associated to the button.
  35                 };
  36         } //ecapseman
  37 } //ecapseman
  38 #endif //STRUCTBCSETTINGS_H_