Salome HOME
Set plugin's library name as field of feature message.
[modules/shaper.git] / src / Config / Config_FeatureMessage.h
index 1a0f99477a8a39ce592ea42fe01fa4d529c472f0..8f5fc335418b5d17f55c522774ff4a9ce0b3306a 100644 (file)
@@ -6,17 +6,22 @@
 #include <Event_Message.hxx>\r
 #include <string>\r
 \r
+/*\r
+ * Class to pass a feature entry extracted from xml file.\r
+ * Example of the feature entry:\r
+ * <feature id="new_part" text="Part" tooltip="Creates a new part" icon=":pictures/part_ico.png"/>\r
+ */\r
 class CONFIG_EXPORT Config_FeatureMessage: public Event_Message\r
 {\r
+  std::string myId;  //Feature unique id\r
+  std::string myText; //Represents action's text\r
+  std::string myTooltip;  //Represents action's tooltip\r
+  std::string myIcon; //Represents action's icon\r
+  std::string myKeysequence;  //Represents action's key sequence\r
 \r
-  std::string myId;\r
-  std::string myText;\r
-  std::string myTooltip;\r
-  std::string myIcon;\r
-  std::string myKeysequence;\r
-\r
-  std::string myGroupId;\r
-  std::string myWorkbenchId;\r
+  std::string myGroupId;  //Id of feature's group\r
+  std::string myWorkbenchId;  //Id of feature's workbench\r
+  std::string myPluginLibrary;  //Name of feature's library\r
 \r
 public:\r
   //const Event_ID theID, const void* theSender = 0\r
@@ -31,6 +36,7 @@ public:
 \r
   const std::string& groupId() const;\r
   const std::string& workbenchId() const;\r
+  const std::string& pluginLibrary() const;\r
 \r
   void setIcon(const std::string& icon);\r
   void setId(const std::string& id);\r
@@ -40,6 +46,7 @@ public:
 \r
   void setGroupId(const std::string& groupId);\r
   void setWorkbenchId(const std::string& workbenchId);\r
+  void setPluginLibrary(const std::string& thePluginLibrary);\r
 };\r
 \r
 #endif // CONFIG_MESSAGE_H\r
\ No newline at end of file