1 // Copyright (C) 2014-2017 CEA/DEN, EDF R&D
3 // This library is free software; you can redistribute it and/or
4 // modify it under the terms of the GNU Lesser General Public
5 // License as published by the Free Software Foundation; either
6 // version 2.1 of the License, or (at your option) any later version.
8 // This library is distributed in the hope that it will be useful,
9 // but WITHOUT ANY WARRANTY; without even the implied warranty of
10 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
11 // Lesser General Public License for more details.
13 // You should have received a copy of the GNU Lesser General Public
14 // License along with this library; if not, write to the Free Software
15 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17 // See http://www.salome-platform.org/ or
18 // email : webmaster.salome@opencascade.com<mailto:webmaster.salome@opencascade.com>
21 #ifndef Model_Events_H_
22 #define Model_Events_H_
25 #include <ModelAPI_Events.h>
29 /// Allows to create ModelAPI messages
30 class Model_EventCreator : public ModelAPI_EventCreator
33 /// creates created, updated or moved messages and sends to the loop
34 virtual void sendUpdated(const ObjectPtr& theObject, const Events_ID& theEvent,
35 const bool isGroupped = true) const;
37 /// creates created, updated or moved messages with the objects collection and sends to the loop
38 virtual void sendUpdated(const std::list<ObjectPtr>& theObjects, const Events_ID& theEvent,
39 const bool isGroupped = true) const;
40 /// creates deleted message and sends to the loop
41 virtual void sendDeleted(const std::shared_ptr<ModelAPI_Document>& theDoc,
42 const std::string& theGroup) const;
44 /// creates reordered message and sends to the loop
45 virtual void sendReordered(const std::shared_ptr<ModelAPI_Feature>& theReordered) const;
47 /// must be one per application, the constructor for internal usage only
51 /// Message that feature was changed (used for Object Browser update): moved, updated and deleted
52 class Model_ObjectUpdatedMessage : public ModelAPI_ObjectUpdatedMessage
54 std::set<ObjectPtr> myObjects; ///< which feature is changed
56 /// Sender is not important, all information is located in the feature.
57 /// Use ModelAPI for creation of this event. Used for creation, movement and edition events.
58 Model_ObjectUpdatedMessage(const ObjectPtr& theObject, const Events_ID& theEvent);
60 friend class Model_EventCreator;
63 /// Returns the feature that has been updated
64 virtual const std::set<ObjectPtr>& objects() const;
66 //! Creates a new empty group (to store it in the loop before flush)
67 virtual std::shared_ptr<Events_MessageGroup> newEmpty();
69 //! Allows to join the given message with the current one
70 virtual void Join(const std::shared_ptr<Events_MessageGroup>& theJoined);
73 /// Message that feature was deleted (used for Object Browser update)
74 class Model_ObjectDeletedMessage : public ModelAPI_ObjectDeletedMessage
76 ///< group identifiers that contained the deleted feature and document where they are deleted
77 std::list<std::pair<std::shared_ptr<ModelAPI_Document>, std::string> > myGroups;
79 /// Use ModelAPI for creation of this event.
80 Model_ObjectDeletedMessage(const std::shared_ptr<ModelAPI_Document>& theDoc,
81 const std::string& theGroup);
83 friend class Model_EventCreator;
85 /// Returns the group where the objects were deleted
86 virtual const std::list<std::pair<std::shared_ptr<ModelAPI_Document>, std::string> >&
92 /// Returns the new empty message of this type
93 virtual std::shared_ptr<Events_MessageGroup> newEmpty();
95 /// Returns the identifier of this message
96 virtual const Events_ID messageId();
98 /// Appends to this message the given one
99 virtual void Join(const std::shared_ptr<Events_MessageGroup>& theJoined);
102 /// Message that feature was deleted (used for Object Browser update)
103 class Model_OrderUpdatedMessage : public ModelAPI_OrderUpdatedMessage
105 std::shared_ptr<ModelAPI_Feature> myReordered; ///< the feature that was moved
107 /// Use ModelAPI for creation of this event.
108 Model_OrderUpdatedMessage(FeaturePtr theReordered,
109 const void* theSender = 0);
111 friend class Model_EventCreator;
113 /// Returns the document that has been updated
114 virtual std::shared_ptr<ModelAPI_Feature> reordered()
119 /// Returns the identifier of this message
120 virtual const Events_ID messageId();