Salome HOME
Spell-checking
[modules/shaper.git] / src / ModelAPI / ModelAPI_AttributeSelectionList.h
index 7bb04753a250ec21c3b2a6339738f74761b11bba..c94062ba3e29ac664e929ac51a97355a25d40b52 100644 (file)
@@ -20,19 +20,31 @@ class ModelAPI_AttributeSelectionList : public ModelAPI_Attribute
 {
  public:
   /// Adds the new reference to the end of the list
+  /// \param theContext object where the sub-shape was selected
+  /// \param theSubShape selected sub-shape (if null, the whole context is selected)
+  /// \param theTemporarily if it is true, do not store and name the added in the data framework
+  ///           (used to remove immediately, without the following updates)
   virtual void append(const ResultPtr& theContext,
-                      const GeomShapePtr& theSubShape) = 0;
+                      const GeomShapePtr& theSubShape,
+                      const bool theTemporarily = false) = 0;
 
   /// Adds the new reference to the end of the list by the naming name of the selected shape
   /// The type of shape is taken from the current selection type
   virtual void append(std::string theNamingName) = 0;
 
-  /// Returns the number ofselection attributes in the list
+  /// Removes the last element in the list
+  virtual void removeLast() = 0;
+
+  /// Returns the number of selection attributes in the list
   virtual int size() = 0;
 
-  virtual int selectionType() = 0;
+  /// The type of all elements selection
+  /// \returns the index of the enumeration of the type of shape
+  virtual const std::string selectionType() const = 0;
 
-  virtual void setSelectionType(int) = 0;
+  /// Sets the type of all elements selection
+  /// \param theType the index of the enumeration of the type of shape
+  virtual void setSelectionType(const std::string& theType) = 0;
 
   /// Returns the attribute selection by the index (zero based)
   virtual std::shared_ptr<ModelAPI_AttributeSelection> value(const int theIndex) = 0;
@@ -41,7 +53,7 @@ class ModelAPI_AttributeSelectionList : public ModelAPI_Attribute
   virtual void clear() = 0;
 
   /// Returns the type of this class of attributes
-  static std::string type()
+  static std::string typeId()
   {
     return "SelectionList";
   }