src/Config/Config_FeatureMessage.h

   1 #ifndef CONFIG_MESSAGE_H\r
   2 #define CONFIG_MESSAGE_H\r
   3 \r
   4 #include <Config_def.h>\r
   5 #include <Events_Message.h>\r
   6 \r
   7 #include <string>\r
   8 \r
   9 /// Event ID that feature is loaded (comes with Config_FeatureMessage)\r
  10 static const char * EVENT_FEATURE_LOADED = "FeatureLoaded";\r
  11 \r
  12 /*\r
  13  * Class to pass a feature entry extracted from xml file.\r
  14  * Example of the feature entry:\r
  15  * <feature id="Part" text="New part" tooltip="Creates a new part" icon=":pictures/part_ico.png"/>\r
  16  */\r
  17 class Config_FeatureMessage : public Events_Message\r
  18 {\r
  19   std::string myId;  //Feature unique id\r
  20   std::string myText;  //Represents action's text\r
  21   std::string myTooltip;  //Represents action's tooltip\r
  22   std::string myIcon;  //Represents action's icon\r
  23   std::string myKeysequence;  //Represents action's key sequence\r
  24 \r
  25   std::string myGroupId;  //Id of feature's group\r
  26   std::string myWorkbenchId;  //Id of feature's workbench\r
  27   std::string myPluginLibrary;  //Name of feature's library\r
  28 \r
  29   bool myUseInput;  //Action is being checked until user commit the operation\r
  30   bool myInternal;  //Internal feature without GUI representation\r
  31   std::string myNestedFeatures;\r
  32 \r
  33  public:\r
  34   //const Events_ID theID, const void* theSender = 0\r
  35   CONFIG_EXPORT Config_FeatureMessage(const Events_ID theId, const void* theParent = 0);CONFIG_EXPORT virtual ~Config_FeatureMessage();\r
  36 \r
  37   //Auto-generated getters/setters\r
  38   CONFIG_EXPORT const std::string& icon() const;CONFIG_EXPORT const std::string& id() const;CONFIG_EXPORT const std::string& keysequence() const;CONFIG_EXPORT const std::string& text() const;CONFIG_EXPORT const std::string& tooltip() const;\r
  39 \r
  40   CONFIG_EXPORT const std::string& groupId() const;CONFIG_EXPORT const std::string& workbenchId() const;CONFIG_EXPORT const std::string& pluginLibrary() const;CONFIG_EXPORT const std::string& nestedFeatures() const;CONFIG_EXPORT bool isUseInput() const;CONFIG_EXPORT bool isInternal() const;\r
  41 \r
  42   CONFIG_EXPORT void setIcon(const std::string& icon);CONFIG_EXPORT void setId(\r
  43       const std::string& id);CONFIG_EXPORT void setKeysequence(const std::string& keysequence);CONFIG_EXPORT void setText(\r
  44       const std::string& text);CONFIG_EXPORT void setTooltip(const std::string& tooltip);CONFIG_EXPORT void setGroupId(\r
  45       const std::string& groupId);CONFIG_EXPORT void setWorkbenchId(const std::string& workbenchId);CONFIG_EXPORT void setPluginLibrary(\r
  46       const std::string& thePluginLibrary);CONFIG_EXPORT void setNestedFeatures(\r
  47       const std::string& theNestedFeatures);CONFIG_EXPORT void setUseInput(bool isUseInput);CONFIG_EXPORT void setInternal(\r
  48       bool isInternal);\r
  49 };\r
  50 \r
  51 #endif // CONFIG_MESSAGE_H\r