src/IFSelect/IFSelect_ParamEditor.cdl

   1 -- Created on: 1998-07-30
   2 -- Created by: Christian CAILLET
   3 -- Copyright (c) 1998-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 class ParamEditor  from IFSelect    inherits Editor  from IFSelect
  18
  19     ---Purpose : A ParamEditor gives access for edition to a list of TypedValue
  20     --           (i.e. of Static too)
  21     --           Its definition is made of the TypedValue to edit themselves,
  22     --           and can add some constants, which can then be displayed but
  23     --           not changed (for instance, system name, processor version ...)
  24     --
  25     --           I.E. it gives a way of editing or at least displaying
  26     --           parameters as global
  27
  28 uses CString, Transient, AsciiString, HAsciiString, HSequenceOfHAsciiString,
  29      InterfaceModel, EditForm, TypedValue
  30
  31 is
  32
  33     Create (nbmax : Integer = 100; label : CString = "") returns ParamEditor;
  34     ---Purpose : Creates a ParamEditor, empty, with a maximum count of params
  35     --           (default is 100)
  36     --           And a label, by default it will be "Param Editor"
  37
  38     AddValue (me : mutable; val : TypedValue; shortname : CString = "");
  39     ---Purpose : Adds a TypedValue
  40     --           By default, its short name equates its complete name, it can
  41     --           be explicited
  42
  43     AddConstantText (me : mutable; val : CString;
  44                      shortname : CString; completename : CString = "");
  45     ---Purpose : Adds a Constant Text, it will be Read Only
  46     --           By default, its long name equates its shortname
  47
  48
  49     Label (me) returns AsciiString;
  50
  51     Recognize (me; form : EditForm) returns Boolean;
  52
  53     StringValue (me; form : EditForm;  num : Integer)
  54         returns HAsciiString from TCollection;
  55
  56     Load (me; form : EditForm; ent : Transient; model : InterfaceModel)
  57         returns Boolean;
  58
  59     Apply (me; form : EditForm; ent : Transient; model : InterfaceModel)
  60         returns Boolean;
  61
  62
  63
  64     StaticEditor (myclass; list : HSequenceOfHAsciiString;
  65                   label : CString = "") returns ParamEditor;
  66     ---Purpose : Returns a ParamEditor to work on the Static Parameters of
  67     --           which names are listed in <list>
  68     --           Null Handle if <list> is null or empty
  69
  70 fields
  71
  72     thelabel : AsciiString;
  73
  74 end ParamEditor;