src/ModuleBase/ModuleBase_Filter.h

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