X-Git-Url: http://git.salome-platform.org/gitweb/?a=blobdiff_plain;f=src%2FConfig%2FConfig_FeatureMessage.h;h=f890f44c3f8f42f743e6774a0e996b126eb2d8ab;hb=60e95a5502a6940c6c27ce5d561b3c684b0b0a4f;hp=a7928800a5e5dc36fe20c07f58943bb6030dc937;hpb=6654a921211670c15a79a997ca666a174fe8a6f6;p=modules%2Fshaper.git diff --git a/src/Config/Config_FeatureMessage.h b/src/Config/Config_FeatureMessage.h index a7928800a..f890f44c3 100644 --- a/src/Config/Config_FeatureMessage.h +++ b/src/Config/Config_FeatureMessage.h @@ -1,36 +1,52 @@ +// Copyright (C) 2014-20xx CEA/DEN, EDF R&D + #ifndef CONFIG_MESSAGE_H #define CONFIG_MESSAGE_H -#include +#include #include #include -/* - * Class to pass a feature entry extracted from xml file. +/*! + * \class Config_FeatureMessage + * \brief Class to pass a feature entry extracted from xml file. * Example of the feature entry: * */ -class Config_FeatureMessage: public Events_Message +class Config_FeatureMessage : public Events_Message { std::string myId; //Feature unique id - std::string myText; //Represents action's text + std::string myText; //Represents action's text std::string myTooltip; //Represents action's tooltip - std::string myIcon; //Represents action's icon + std::string myIcon; //Represents action's icon std::string myKeysequence; //Represents action's key sequence std::string myGroupId; //Id of feature's group std::string myWorkbenchId; //Id of feature's workbench + std::string myDocumentKind; // kind of the document of the workbench (all documents if empty) std::string myPluginLibrary; //Name of feature's library - bool myUseInput; //Action is being checked until user commit the operation + bool myUseInput; //Action is being checked until user commit the operation + bool myInternal; //Internal feature without GUI representation + std::string myNestedFeatures; + + public: + /// Event ID that feature is loaded in workbench (GUI) + inline static const char* GUI_EVENT() + { + static const char * MY_GUI_EVENT_ID("WorkshopFeatureLoaded"); + return MY_GUI_EVENT_ID; + } + inline static const char* MODEL_EVENT() + { + static const char * MY_MODEL_EVENT_ID("ModelFeatureLoaded"); + return MY_MODEL_EVENT_ID; + } -public: //const Events_ID theID, const void* theSender = 0 CONFIG_EXPORT Config_FeatureMessage(const Events_ID theId, const void* theParent = 0); - - //TODO(sbh): Implement static method to extract event id [SEID] - //static const char* eventId() { return ""; } + CONFIG_EXPORT virtual ~Config_FeatureMessage(); //Auto-generated getters/setters CONFIG_EXPORT const std::string& icon() const; @@ -38,22 +54,26 @@ public: CONFIG_EXPORT const std::string& keysequence() const; CONFIG_EXPORT const std::string& text() const; CONFIG_EXPORT const std::string& tooltip() const; - CONFIG_EXPORT const std::string& groupId() const; CONFIG_EXPORT const std::string& workbenchId() const; + CONFIG_EXPORT const std::string& documentKind() 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; CONFIG_EXPORT void setIcon(const std::string& icon); CONFIG_EXPORT void setId(const std::string& id); CONFIG_EXPORT void setKeysequence(const std::string& keysequence); CONFIG_EXPORT void setText(const std::string& text); CONFIG_EXPORT void setTooltip(const std::string& tooltip); - CONFIG_EXPORT void setGroupId(const std::string& groupId); CONFIG_EXPORT void setWorkbenchId(const std::string& workbenchId); + CONFIG_EXPORT void setDocumentKind(const std::string& documentKind); CONFIG_EXPORT void setPluginLibrary(const std::string& thePluginLibrary); - CONFIG_EXPORT bool isUseInput() const; + CONFIG_EXPORT void setNestedFeatures(const std::string& theNestedFeatures); CONFIG_EXPORT void setUseInput(bool isUseInput); + CONFIG_EXPORT void setInternal(bool isInternal); }; #endif // CONFIG_MESSAGE_H