src/IFSelect/IFSelect_SelectControl.cdl

   1 -- Created on: 1994-02-16
   2 -- Created by: Christian CAILLET
   3 -- Copyright (c) 1994-1999 Matra Datavision
   4 -- Copyright (c) 1999-2014 OPEN CASCADE SAS
   5 --
   6 -- This file is part of Open CASCADE Technology software library.
   7 --
   8 -- This library is free software; you can redistribute it and/or modify it under
   9 -- the terms of the GNU Lesser General Public License version 2.1 as published
  10 -- by the Free Software Foundation, with special exception defined in the file
  11 -- OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
  12 -- distribution for complete text of the license and disclaimer of any warranty.
  13 --
  14 -- Alternatively, this file may be used under the terms of Open CASCADE
  15 -- commercial license or contractual agreement.
  16
  17 deferred class SelectControl  from IFSelect  inherits Selection
  18
  19     ---Purpose : A SelectControl kind Selection works with two input Selections
  20     --           in a dissymmetric way : the Main Input which gives an input
  21     --           list of Entities, to be processed, and the Second Input which
  22     --           gives another list, to be used to filter the main input.
  23     --
  24     --           e.g. : SelectDiff retains the items of the Main Input which
  25     --             are not in the Control Input (which acts as Diff Input)
  26     --           or a specific selection which retains Entities from the Main
  27     --             Input if and only if they are concerned by an entity from
  28     --             the Control Input (such as Views in IGES, etc...)
  29     --
  30     --           The way RootResult and Label are produced are at charge of
  31     --           each sub-class
  32
  33 uses  SelectionIterator
  34
  35 is
  36
  37     MainInput    (me) returns Selection;
  38     ---Purpose : Returns the Main Input Selection
  39
  40     HasSecondInput (me) returns Boolean;
  41     ---Purpose : Returns True if a Control Input is defined
  42     --           Thus, Result can be computed differently if there is a
  43     --           Control Input or if there is none
  44
  45     SecondInput (me) returns Selection;
  46     ---Purpose : Returns the Control Input Selection, or a Null Handle
  47
  48     SetMainInput    (me : mutable; sel : Selection);
  49     ---Purpose : Sets a Selection to be the Main Input
  50
  51     SetSecondInput (me : mutable; sel : Selection);
  52     ---Purpose : Sets a Selection to be the Control Input
  53
  54
  55     -- RootResult,Label remain to be defined by each class of Selection
  56     -- (also HasUniqueResult if it applies)
  57
  58     FillIterator (me; iter : in out SelectionIterator);
  59     ---Purpose : Puts in an Iterator the Selections from which "me" depends
  60     --           That is to say, the list of Input Selections
  61
  62
  63 fields
  64
  65     themain   : Selection;
  66     thesecond : Selection;
  67
  68 end SelectControl;