X-Git-Url: http://git.salome-platform.org/gitweb/?a=blobdiff_plain;f=src%2FModelAPI%2FModelAPI_AttributeSelectionList.h;h=7aba03eb562d112022f1c4709750b46ece63752b;hb=7b4be16ca6e44bd9fc8aaca8cda03646801adcd4;hp=fec280f37ece835150537c58ec98a6e44d01ffd7;hpb=7bf19255421b34594c7b0a76d0ce28166d0ce895;p=modules%2Fshaper.git diff --git a/src/ModelAPI/ModelAPI_AttributeSelectionList.h b/src/ModelAPI/ModelAPI_AttributeSelectionList.h index fec280f37..7aba03eb5 100644 --- a/src/ModelAPI/ModelAPI_AttributeSelectionList.h +++ b/src/ModelAPI/ModelAPI_AttributeSelectionList.h @@ -1,8 +1,22 @@ -// Copyright (C) 2014-20xx CEA/DEN, EDF R&D - -// File: ModelAPI_AttributeSelectionList.h -// Created: 22 Oct 2014 -// Author: Mikhail PONIKAROV +// Copyright (C) 2014-2017 CEA/DEN, EDF R&D +// +// This library is free software; you can redistribute it and/or +// modify it under the terms of the GNU Lesser General Public +// License as published by the Free Software Foundation; either +// version 2.1 of the License, or (at your option) any later version. +// +// This library is distributed in the hope that it will be useful, +// but WITHOUT ANY WARRANTY; without even the implied warranty of +// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +// Lesser General Public License for more details. +// +// You should have received a copy of the GNU Lesser General Public +// License along with this library; if not, write to the Free Software +// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA +// +// See http://www.salome-platform.org/ or +// email : webmaster.salome@opencascade.com +// #ifndef ModelAPI_AttributeSelectionList_H_ #define ModelAPI_AttributeSelectionList_H_ @@ -10,6 +24,8 @@ #include "ModelAPI_AttributeSelection.h" #include +class GeomAPI_Shape; + /**\class ModelAPI_AttributeSelectionList * \ingroup DataModel * \brief Attribute that contains list of references to the sub-shapes with @@ -20,15 +36,47 @@ 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 std::shared_ptr& 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 if the given is empty + virtual void append(const std::string theNamingName, const std::string& theType = "") = 0; + + /// Reset temporary stored values + virtual void removeTemporaryValues() = 0; - /// Returns the number ofselection attributes in the list + /// Removes the last element in the list + virtual void removeLast() = 0; + + /// Removes the elements from the list. + /// \param theIndices a list of indices of elements to be removed + virtual void remove(const std::set& theIndices) = 0; + + /// Returns the number of selection attributes in the list virtual int size() = 0; - virtual int selectionType() = 0; + /// Returns true if the object with the shape are in 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, it checks also the temporary added item + /// \returns true if the pair is found in the attirbute + virtual bool isInList( + const ResultPtr& theContext, const std::shared_ptr& theSubShape, + const bool theTemporarily = false) = 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 value(const int theIndex) = 0; @@ -36,28 +84,26 @@ class ModelAPI_AttributeSelectionList : public ModelAPI_Attribute /// Returns all attributes virtual void clear() = 0; + /// Starts or stops cashing of the values in the attribute (the cash may become invalid + /// on modification of the attribute or sub-elements, so the cash must be enabled only + /// during non-modification operations with this attribute) + virtual void cashValues(const bool theEnabled) = 0; + /// Returns the type of this class of attributes - static std::string type() + static std::string typeId() { return "SelectionList"; } /// Returns the type of this class of attributes, not static method - virtual std::string attributeType() - { - return type(); - } + MODELAPI_EXPORT virtual std::string attributeType(); /// To virtually destroy the fields of successors - virtual ~ModelAPI_AttributeSelectionList() - { - } + MODELAPI_EXPORT virtual ~ModelAPI_AttributeSelectionList(); protected: /// Objects are created for features automatically - MODELAPI_EXPORT ModelAPI_AttributeSelectionList() - { - } + MODELAPI_EXPORT ModelAPI_AttributeSelectionList(); }; //! Pointer on double attribute