X-Git-Url: http://git.salome-platform.org/gitweb/?a=blobdiff_plain;f=src%2FModelAPI%2FModelAPI_Events.h;h=741aa0a8b00465a03a8f6220a16a21c38870cc46;hb=4af82842098757e6e7f4f28e2eb744d184bb2b3e;hp=26441f25336f9115398f9ea8bc68a88f1475e75c;hpb=3d7368386762b057fff327d24d0079b4a73c3004;p=modules%2Fshaper.git diff --git a/src/ModelAPI/ModelAPI_Events.h b/src/ModelAPI/ModelAPI_Events.h index 26441f253..741aa0a8b 100644 --- a/src/ModelAPI/ModelAPI_Events.h +++ b/src/ModelAPI/ModelAPI_Events.h @@ -10,7 +10,9 @@ #include #include #include +#include #include +#include #include #include @@ -34,19 +36,23 @@ static const char * EVENT_OBJECT_TO_REDISPLAY = "ObjectsToRedisplay"; static const char * EVENT_OPERATION_LAUNCHED = "OperationLaunched"; /// Event ID that plugin is loaded (comes with ModelAPI_ObjectUpdatedMessage) static const char * EVENT_PLUGIN_LOADED = "PliginLoaded"; -/// Event ID that data of feature has to be shown (comes with ModelAPI_ObjectUpdatedMessage) -static const char * EVENT_OBJECT_TOSHOW = "ObjectShow"; -/// Event ID that data of feature has to be shown (comes with ModelAPI_ObjectUpdatedMessage) -static const char * EVENT_OBJECT_TOHIDE = "ObjectHide"; +// +static const char * EVENT_DOCUMENT_CHANGED = "CurrentDocumentChanged"; static const char * EVENT_FEATURE_STATE_REQUEST = "FeatureStateRequest"; static const char * EVENT_FEATURE_STATE_RESPONSE = "FeatureStateResponse"; + +static const char * EVENT_UPDATE_VIEWER_BLOCKED = "UpdateViewerBlocked"; +static const char * EVENT_UPDATE_VIEWER_UNBLOCKED = "UpdateViewerUnblocked"; + /// Message that feature was changed (used for Object Browser update): moved, updated and deleted class MODELAPI_EXPORT ModelAPI_ObjectUpdatedMessage : public Events_MessageGroup { protected: + /// Creates an empty message ModelAPI_ObjectUpdatedMessage(const Events_ID theID, const void* theSender = 0); + /// The virtual destructor virtual ~ModelAPI_ObjectUpdatedMessage(); public: @@ -63,28 +69,33 @@ class MODELAPI_EXPORT ModelAPI_ObjectUpdatedMessage : public Events_MessageGroup /// Message that feature was deleted (used for Object Browser update) class MODELAPI_EXPORT ModelAPI_ObjectDeletedMessage : public Events_MessageGroup { - protected: +protected: + /// Creates an empty message ModelAPI_ObjectDeletedMessage(const Events_ID theID, const void* theSender = 0); + /// The virtual destructor virtual ~ModelAPI_ObjectDeletedMessage(); - public: +public: /// Returns the feature that has been updated virtual std::shared_ptr document() const = 0; /// Returns the group where the feature was deleted virtual const std::set& groups() const = 0; + /// Creates the new empty message of this kind virtual std::shared_ptr newEmpty() = 0; + /// Returns the identifier of the kind of a message virtual const Events_ID messageId() = 0; + /// Appenad to this message the given one. virtual void Join(const std::shared_ptr& theJoined) = 0; }; /// Allows to create ModelAPI messages class MODELAPI_EXPORT ModelAPI_EventCreator { - public: +public: /// creates created, updated or moved messages and sends to the loop virtual void sendUpdated(const ObjectPtr& theObject, const Events_ID& theEvent, const bool isGroupped = true) const = 0; @@ -100,26 +111,92 @@ class MODELAPI_EXPORT ModelAPI_EventCreator }; // TODO(sbh): Move this message into a separate package, like "GuiAPI" +/// Contains the state information about the feature: is it enabled or disabled. class ModelAPI_FeatureStateMessage : public Events_Message { - public: +public: + /// Creates an empty message MODELAPI_EXPORT ModelAPI_FeatureStateMessage(const Events_ID theID, const void* theSender = 0); + /// The virtual destructor MODELAPI_EXPORT virtual ~ModelAPI_FeatureStateMessage(); - // For request + /// Returns the feature this message is related to MODELAPI_EXPORT std::shared_ptr feature() const; + /// Stores the feature this message is related to MODELAPI_EXPORT void setFeature(std::shared_ptr& theFeature); // For response + /// Returns true if feature has specific state MODELAPI_EXPORT bool hasState(const std::string& theFeatureId) const; + /// Returns true if feature is enabled MODELAPI_EXPORT bool state(const std::string& theFeatureId, bool theDefault = false) const; + /// Stores the feature state MODELAPI_EXPORT void setState(const std::string& theFeatureId, bool theValue); + /// Returns all feature IDs with states MODELAPI_EXPORT std::list features() const; private: - // For Request + /// For Request std::shared_ptr myCurrentFeature; - // For response + /// For response std::map myFeatureState; }; +/// Message that document (Part, PartSet) was created +class ModelAPI_DocumentCreatedMessage : public Events_Message +{ + DocumentPtr myDocument; + + public: + /// Creates an empty message + MODELAPI_EXPORT ModelAPI_DocumentCreatedMessage(const Events_ID theID, const void* theSender = 0); + /// The virtual destructor + MODELAPI_EXPORT virtual ~ModelAPI_DocumentCreatedMessage(); + /// Static. Returns EventID of the message. + MODELAPI_EXPORT static Events_ID eventId() + { + static const char * MY_DOCUMENT_CREATED_EVENT_ID("DocumentCreated"); + return Events_Loop::eventByName(MY_DOCUMENT_CREATED_EVENT_ID); + } + + /// Returns a document stored in the message + MODELAPI_EXPORT DocumentPtr document() const; + /// Sets a document to the message + MODELAPI_EXPORT void setDocument(DocumentPtr theDocument); +}; + +/// Message that attribute text should be evaluated in the attribute value +class ModelAPI_AttributeEvalMessage : public Events_Message +{ + AttributePtr myAttribute; + + public: + /// Static. Returns EventID of the message. + MODELAPI_EXPORT static Events_ID& eventId() + { + static const char * MY_ATTRIBUTE_EVALUATION_EVENT_ID("AttributeEvaluationRequest"); + static Events_ID anId = Events_Loop::eventByName(MY_ATTRIBUTE_EVALUATION_EVENT_ID); + return anId; + } + + /// usefull method that creates and sends the AttributeEvalMessage event + MODELAPI_EXPORT static void send(AttributePtr theAttribute, const void* theSender) + { + std::shared_ptr aMessage = + std::shared_ptr( + new ModelAPI_AttributeEvalMessage(eventId(), theSender)); + aMessage->setAttribute(theAttribute); + Events_Loop::loop()->send(aMessage); + } + + /// Creates an empty message + MODELAPI_EXPORT ModelAPI_AttributeEvalMessage(const Events_ID theID, const void* theSender = 0); + /// The virtual destructor + MODELAPI_EXPORT virtual ~ModelAPI_AttributeEvalMessage(); + + /// Returns a document stored in the message + MODELAPI_EXPORT AttributePtr attribute() const; + /// Sets an attribute to the message + MODELAPI_EXPORT void setAttribute(AttributePtr theAttribute); +}; + #endif