Salome HOME
Set plugin's library name as field of feature message.
[modules/shaper.git] / src / Config / Config_FeatureMessage.h
1 #ifndef CONFIG_MESSAGE_H\r
2 #define CONFIG_MESSAGE_H\r
3 \r
4 #include "Config.h"\r
5 \r
6 #include <Event_Message.hxx>\r
7 #include <string>\r
8 \r
9 /*\r
10  * Class to pass a feature entry extracted from xml file.\r
11  * Example of the feature entry:\r
12  * <feature id="new_part" text="Part" tooltip="Creates a new part" icon=":pictures/part_ico.png"/>\r
13  */\r
14 class CONFIG_EXPORT Config_FeatureMessage: public Event_Message\r
15 {\r
16   std::string myId;  //Feature unique id\r
17   std::string myText; //Represents action's text\r
18   std::string myTooltip;  //Represents action's tooltip\r
19   std::string myIcon; //Represents action's icon\r
20   std::string myKeysequence;  //Represents action's key sequence\r
21 \r
22   std::string myGroupId;  //Id of feature's group\r
23   std::string myWorkbenchId;  //Id of feature's workbench\r
24   std::string myPluginLibrary;  //Name of feature's library\r
25 \r
26 public:\r
27   //const Event_ID theID, const void* theSender = 0\r
28   Config_FeatureMessage(const Event_ID theId, const void* theParent = 0);\r
29 \r
30   //Auto-generated getters/setters\r
31   const std::string& icon() const;\r
32   const std::string& id() const;\r
33   const std::string& keysequence() const;\r
34   const std::string& text() const;\r
35   const std::string& tooltip() const;\r
36 \r
37   const std::string& groupId() const;\r
38   const std::string& workbenchId() const;\r
39   const std::string& pluginLibrary() const;\r
40 \r
41   void setIcon(const std::string& icon);\r
42   void setId(const std::string& id);\r
43   void setKeysequence(const std::string& keysequence);\r
44   void setText(const std::string& text);\r
45   void setTooltip(const std::string& tooltip);\r
46 \r
47   void setGroupId(const std::string& groupId);\r
48   void setWorkbenchId(const std::string& workbenchId);\r
49   void setPluginLibrary(const std::string& thePluginLibrary);\r
50 };\r
51 \r
52 #endif // CONFIG_MESSAGE_H\r