src/ModuleBase/ModuleBase_Filter.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 ModuleBase_Filter_H
  21 #define ModuleBase_Filter_H
  22
  23 #include "ModuleBase.h"
  24
  25 #include <SelectMgr_Filter.hxx>
  26
  27 #include <list>
  28
  29 /**
  30  * \ingroup GUI
  31  * This object is assigned by the name
  32  * in the XML file to the specific attribute or to the whole feature.
  33  * If isOK method of the filter returns "false", it is signalized in user interface
  34  * that the processed entity should not be selected.
  35  * Filterss must be registered in the filters factory to be
  36  * correctly identified by the XML string-ID.
  37  */
  38 class ModuleBase_Filter
  39 {
  40 public:
  41   /// Constructor
  42   MODULEBASE_EXPORT ModuleBase_Filter() {}
  43
  44   /**
  45    * Returns an OCC selection filter. It can be appended into the context of a viewer
  46    * It creates a filter if it has not be created yet.
  47    * \return the selection filter
  48    */
  49   MODULEBASE_EXPORT Handle(SelectMgr_Filter) getFilter();
  50
  51   /**
  52    * Sets the arguments to the filter.
  53    * \param theArguments a list of arguments
  54    */
  55   MODULEBASE_EXPORT virtual void setArguments(const std::list<std::string>& theArguments) = 0;
  56 protected:
  57   /**
  58    * It creates an internal instance of the OCC filter
  59    */
  60   virtual void createFilter() = 0;
  61
  62 protected:
  63   /// current instance of the OCC selection filter
  64   Handle(SelectMgr_Filter) myFilter;
  65 };
  66
  67 #endif //ModuleBase_Filter