+// Copyright (C) 2014-20xx CEA/DEN, EDF R&D\r
+\r
#ifndef CONFIG_MESSAGE_H\r
#define CONFIG_MESSAGE_H\r
\r
-#include <Config.h>\r
+#include <Config_def.h>\r
#include <Events_Message.h>\r
\r
#include <string>\r
\r
-/*\r
- * Class to pass a feature entry extracted from xml file.\r
+/*!\r
+ * \class Config_FeatureMessage\r
+ * \brief Class to pass a feature entry extracted from xml file.\r
* Example of the feature entry:\r
* <feature id="Part" text="New part" tooltip="Creates a new part" icon=":pictures/part_ico.png"/>\r
*/\r
-class Config_FeatureMessage: public Events_Message\r
+class Config_FeatureMessage : public Events_Message\r
{\r
std::string myId; //Feature unique id\r
- std::string myText; //Represents action's text\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 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 myDocumentKind; // kind of the document of the workbench (all documents if empty)\r
std::string myPluginLibrary; //Name of feature's library\r
\r
- bool myUseInput; //Action is being checked until user commit the operation\r
+ bool myUseInput; //Action is being checked until user commit the operation\r
+ bool myInternal; //Internal feature without GUI representation\r
std::string myNestedFeatures;\r
\r
-public:\r
+ public:\r
+ /// Event ID that feature is loaded in workbench (GUI)\r
+ inline static const char* GUI_EVENT()\r
+ {\r
+ static const char * MY_GUI_EVENT_ID("WorkshopFeatureLoaded");\r
+ return MY_GUI_EVENT_ID;\r
+ }\r
+ inline static const char* MODEL_EVENT()\r
+ {\r
+ static const char * MY_MODEL_EVENT_ID("ModelFeatureLoaded");\r
+ return MY_MODEL_EVENT_ID;\r
+ }\r
+\r
//const Events_ID theID, const void* theSender = 0\r
CONFIG_EXPORT Config_FeatureMessage(const Events_ID theId, const void* theParent = 0);\r
+ CONFIG_EXPORT virtual ~Config_FeatureMessage();\r
\r
//Auto-generated getters/setters\r
CONFIG_EXPORT const std::string& icon() const;\r
CONFIG_EXPORT const std::string& keysequence() const;\r
CONFIG_EXPORT const std::string& text() const;\r
CONFIG_EXPORT const std::string& tooltip() const;\r
-\r
CONFIG_EXPORT const std::string& groupId() const;\r
CONFIG_EXPORT const std::string& workbenchId() const;\r
+ CONFIG_EXPORT const std::string& documentKind() const;\r
CONFIG_EXPORT const std::string& pluginLibrary() const;\r
CONFIG_EXPORT const std::string& nestedFeatures() const;\r
CONFIG_EXPORT bool isUseInput() const;\r
+ CONFIG_EXPORT bool isInternal() const;\r
\r
CONFIG_EXPORT void setIcon(const std::string& icon);\r
CONFIG_EXPORT void setId(const std::string& id);\r
CONFIG_EXPORT void setTooltip(const std::string& tooltip);\r
CONFIG_EXPORT void setGroupId(const std::string& groupId);\r
CONFIG_EXPORT void setWorkbenchId(const std::string& workbenchId);\r
+ CONFIG_EXPORT void setDocumentKind(const std::string& documentKind);\r
CONFIG_EXPORT void setPluginLibrary(const std::string& thePluginLibrary);\r
CONFIG_EXPORT void setNestedFeatures(const std::string& theNestedFeatures);\r
CONFIG_EXPORT void setUseInput(bool isUseInput);\r
+ CONFIG_EXPORT void setInternal(bool isInternal);\r
};\r
\r
#endif // CONFIG_MESSAGE_H\r