src/Model/Model_Events.h

   1 // Copyright (C) 2014-2022  CEA/DEN, EDF R&D
   2 //
   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.
   7 //
   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.
  12 //
  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
  16 //
  17 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
  18 //
  19
  20 #ifndef Model_Events_H_
  21 #define Model_Events_H_
  22
  23 #include <Model.h>
  24 #include <ModelAPI_Events.h>
  25
  26 #include <memory>
  27
  28 /// Allows to create ModelAPI messages
  29 class Model_EventCreator : public ModelAPI_EventCreator
  30 {
  31  public:
  32   /// creates created, updated or moved messages and sends to the loop
  33   virtual void sendUpdated(const ObjectPtr& theObject, const Events_ID& theEvent,
  34                            const bool isGroupped = true) const;
  35
  36   /// creates created, updated or moved messages with the objects collection and sends to the loop
  37   virtual void sendUpdated(const std::list<ObjectPtr>& theObjects, const Events_ID& theEvent,
  38     const bool isGroupped = true) const;
  39   /// creates deleted message and sends to the loop
  40   virtual void sendDeleted(const std::shared_ptr<ModelAPI_Document>& theDoc,
  41                            const std::string& theGroup) const;
  42
  43   /// creates reordered message and sends to the loop
  44   virtual void sendReordered(const std::shared_ptr<ModelAPI_Feature>& theReordered) const;
  45
  46   /// must be one per application, the constructor for internal usage only
  47   Model_EventCreator();
  48 };
  49
  50 /// Message that feature was changed (used for Object Browser update): moved, updated and deleted
  51 class Model_ObjectUpdatedMessage : public ModelAPI_ObjectUpdatedMessage
  52 {
  53   std::set<ObjectPtr> myObjects;  ///< which feature is changed
  54
  55   /// Sender is not important, all information is located in the feature.
  56   /// Use ModelAPI for creation of this event. Used for creation, movement and edition events.
  57   Model_ObjectUpdatedMessage(const ObjectPtr& theObject, const Events_ID& theEvent);
  58
  59   friend class Model_EventCreator;
  60  public:
  61
  62   /// Returns the feature that has been updated
  63   virtual const std::set<ObjectPtr>& objects() const;
  64
  65   //! Creates a new empty group (to store it in the loop before flush)
  66   virtual std::shared_ptr<Events_MessageGroup> newEmpty();
  67
  68   //! Allows to join the given message with the current one
  69   virtual void Join(const std::shared_ptr<Events_MessageGroup>& theJoined);
  70 };
  71
  72 /// Message that feature was deleted (used for Object Browser update)
  73 class Model_ObjectDeletedMessage : public ModelAPI_ObjectDeletedMessage
  74 {
  75   ///< group identifiers that contained the deleted feature and document where they are deleted
  76   std::list<std::pair<std::shared_ptr<ModelAPI_Document>, std::string> > myGroups;
  77
  78   /// Use ModelAPI for creation of this event.
  79   Model_ObjectDeletedMessage(const std::shared_ptr<ModelAPI_Document>& theDoc,
  80                              const std::string& theGroup);
  81
  82   friend class Model_EventCreator;
  83  public:
  84   /// Returns the group where the objects were deleted
  85   virtual const std::list<std::pair<std::shared_ptr<ModelAPI_Document>, std::string> >&
  86     groups() const
  87   {
  88     return myGroups;
  89   }
  90
  91   /// Returns the new empty message of this type
  92   virtual std::shared_ptr<Events_MessageGroup> newEmpty();
  93
  94   /// Returns the identifier of this message
  95   virtual const Events_ID messageId();
  96
  97   /// Appends to this message the given one
  98   virtual void Join(const std::shared_ptr<Events_MessageGroup>& theJoined);
  99 };
 100
 101 /// Message that feature was deleted (used for Object Browser update)
 102 class Model_OrderUpdatedMessage : public ModelAPI_OrderUpdatedMessage
 103 {
 104   std::shared_ptr<ModelAPI_Feature> myReordered;  ///< the feature that was moved
 105
 106   /// Use ModelAPI for creation of this event.
 107   Model_OrderUpdatedMessage(FeaturePtr theReordered,
 108                             const void* theSender = 0);
 109
 110   friend class Model_EventCreator;
 111  public:
 112   /// Returns the document that has been updated
 113   virtual std::shared_ptr<ModelAPI_Feature> reordered()
 114   {
 115     return myReordered;
 116   }
 117
 118   /// Returns the identifier of this message
 119   virtual const Events_ID messageId();
 120 };
 121
 122 #endif