src/IFSelect/IFSelect_SelectList.cdl

   1 -- Created on: 1992-11-18
   2 -- Created by: Christian CAILLET
   3 -- Copyright (c) 1992-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 generic class SelectList  from IFSelect (Entity as Transient)
  18         inherits SelectInList
  19
  20
  21     ---Purpose : A SelectList kind Selection selects a part of an Entity, as
  22     --           well as this Entity can be described as an ordered List.
  23     --           That is to say, it must have two methods :
  24     --
  25     --             NbEntities (me) returns Integer;
  26     --             Entity (me; num : Integer) returns Transient;
  27     --
  28     --           For each class of Entity for which we want to define a
  29     --           SelectList, we will instanciate this class with the
  30     --           desired class of Entity as definition parameter : the deferred
  31     --           methods NbEntities and ListedEntity are now defined to call
  32     --           the required methods from <Entity>
  33     --
  34     --           SelectList works as SelectInList, beeing a sub-class of it
  35
  36 uses AsciiString from TCollection, Transient, EntityIterator, IntParam
  37
  38 raises OutOfRange
  39
  40 is
  41
  42     Create returns mutable SelectList;
  43     ---Purpose : Creates a SelectList (with no limit);
  44
  45     KeepInputEntity (me; iter : in out EntityIterator);
  46     ---Purpose : Keeps Input Entity, as having required type <Entity>
  47
  48     NbItems (me; ent : Transient) returns Integer;
  49     ---Purpose : Returns count of Entities in the list in the Entity <ent>
  50     --           by calling method NbEntity from parameter class Entity
  51
  52     ListedEntity (me; num : Integer; ent : Transient)
  53         returns Transient  raises OutOfRange;
  54     ---Purpose : Returns an Entity of the list in the Entity <ent>, by calling
  55     --           method Entity from parameter class Entity
  56     --           Error if <ent> has not required type, or if <num> is not in
  57     --           the right range (1,NbEntities),
  58
  59     ListLabel (me) returns AsciiString from TCollection;
  60     ---Purpose : Returns the specific label for the list
  61     --           then, following cases :
  62     --           " From .. Until .." or "From .." or "Until .." or "Rank no .."
  63     --  Warning : it is not possible to give a character constant to instantiate
  64     --           a generic class, thus "List From Entity" is not adapted :
  65     --           redefine Label if judged necessary
  66
  67 end SelectList;