Salome HOME
Set plugin's library name as field of feature message.
[modules/shaper.git] / src / Config / Config_FeatureMessage.h
index ff14c46aefbe385cc5599575ebafdc27ac5ecc64..8f5fc335418b5d17f55c522774ff4a9ce0b3306a 100644 (file)
@@ -1,45 +1,52 @@
-#ifndef CONFIG_MESSAGE_H
-#define CONFIG_MESSAGE_H
-
-#include "Config.h"
-
-#include <Event_Message.hxx>
-#include <string>
-
-class CONFIG_EXPORT Config_FeatureMessage : public Event_Message
-{
-
-  std::string myId;
-  std::string myText;
-  std::string myTooltip;
-  std::string myIcon;
-  std::string myKeysequence;
-
-  std::string myGroupId;
-  std::string myWorkbenchId;
-
-public:
-  //const Event_ID theID, const void* theSender = 0
-  Config_FeatureMessage(const Event_ID theId, const void* theParent = 0);
-
-  //Auto-generated getters/setters
-  const std::string& icon() const;
-  const std::string& id() const;
-  const std::string& keysequence() const;
-  const std::string& text() const;
-  const std::string& tooltip() const;
-
-  const std::string& groupId() const;
-  const std::string& workbenchId() const;
-
-  void setIcon(const std::string& icon);
-  void setId(const std::string& id);
-  void setKeysequence(const std::string& keysequence);
-  void setText(const std::string& text);
-  void setTooltip(const std::string& tooltip);
-
-  void setGroupId(const std::string& groupId);
-  void setWorkbenchId(const std::string& workbenchId);
-};
-
-#endif // CONFIG_MESSAGE_H
+#ifndef CONFIG_MESSAGE_H\r
+#define CONFIG_MESSAGE_H\r
+\r
+#include "Config.h"\r
+\r
+#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 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
+  Config_FeatureMessage(const Event_ID theId, const void* theParent = 0);\r
+\r
+  //Auto-generated getters/setters\r
+  const std::string& icon() const;\r
+  const std::string& id() const;\r
+  const std::string& keysequence() const;\r
+  const std::string& text() const;\r
+  const std::string& tooltip() const;\r
+\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
+  void setKeysequence(const std::string& keysequence);\r
+  void setText(const std::string& text);\r
+  void setTooltip(const std::string& tooltip);\r
+\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