src/SketchPlugin/SketchPlugin_ExternalValidator.h

   1 // Copyright (C) 2014-2023  CEA, EDF
   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 SketchPlugin_ExternalValidator_H
  21 #define SketchPlugin_ExternalValidator_H
  22
  23 #include <SketchPlugin.h>
  24 #include <ModelAPI_AttributeValidator.h>
  25
  26 /**\class SketchPlugin_ExternalValidator
  27  * \ingroup Validators
  28  * \brief Validator for the points selection
  29  *
  30  * Allows to select points only.
  31  */
  32 class SketchPlugin_ExternalValidator : public ModelAPI_AttributeValidator
  33 {
  34 public:
  35   /// returns true if the feature of attribute do not contain external features
  36   /// in the given attribute and
  37   /// among attributes listed in the arguments
  38   /// \param theAttribute an attribute to check
  39   /// \param theArguments a filter parameters
  40   /// \param theError error message
  41   SKETCHPLUGIN_EXPORT virtual bool isValid(const AttributePtr& theAttribute,
  42                                            const std::list<std::string>& theArguments,
  43                                            Events_InfoMessage& theError) const;
  44
  45 protected:
  46   /// returns true if the feature of the attribute is external
  47   /// \param theAttribute an attribute to check
  48   bool isExternalAttribute(const AttributePtr& theAttribute) const;
  49 };
  50
  51 #endif