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-2012 OPEN CASCADE SAS
   5 --
   6 -- The content of this file is subject to the Open CASCADE Technology Public
   7 -- License Version 6.5 (the "License"). You may not use the content of this file
   8 -- except in compliance with the License. Please obtain a copy of the License
   9 -- at http://www.opencascade.org and read it completely before using this file.
  10 --
  11 -- The Initial Developer of the Original Code is Open CASCADE S.A.S., having its
  12 -- main offices at: 1, place des Freres Montgolfier, 78280 Guyancourt, France.
  13 --
  14 -- The Original Code and all software distributed under the License is
  15 -- distributed on an "AS IS" basis, without warranty of any kind, and the
  16 -- Initial Developer hereby disclaims all such warranties, including without
  17 -- limitation, any warranties of merchantability, fitness for a particular
  18 -- purpose or non-infringement. Please see the License for the specific terms
  19 -- and conditions governing the rights and limitations under the License.
  20
  21
  22
  23 class ParamEditor  from IFSelect    inherits Editor  from IFSelect
  24
  25     ---Purpose : A ParamEditor gives access for edition to a list of TypedValue
  26     --           (i.e. of Static too)
  27     --           Its definition is made of the TypedValue to edit themselves,
  28     --           and can add some constants, which can then be displayed but
  29     --           not changed (for instance, system name, processor version ...)
  30     --
  31     --           I.E. it gives a way of editing or at least displaying
  32     --           parameters as global
  33
  34 uses CString, Transient, AsciiString, HAsciiString, HSequenceOfHAsciiString,
  35      InterfaceModel, EditForm, TypedValue
  36
  37 is
  38
  39     Create (nbmax : Integer = 100; label : CString = "") returns ParamEditor;
  40     ---Purpose : Creates a ParamEditor, empty, with a maximum count of params
  41     --           (default is 100)
  42     --           And a label, by default it will be "Param Editor"
  43
  44     AddValue (me : mutable; val : TypedValue; shortname : CString = "");
  45     ---Purpose : Adds a TypedValue
  46     --           By default, its short name equates its complete name, it can
  47     --           be explicited
  48
  49     AddConstantText (me : mutable; val : CString;
  50                      shortname : CString; completename : CString = "");
  51     ---Purpose : Adds a Constant Text, it will be Read Only
  52     --           By default, its long name equates its shortname
  53
  54
  55     Label (me) returns AsciiString;
  56
  57     Recognize (me; form : EditForm) returns Boolean;
  58
  59     StringValue (me; form : EditForm;  num : Integer)
  60         returns HAsciiString from TCollection;
  61
  62     Load (me; form : EditForm; ent : Transient; model : InterfaceModel)
  63         returns Boolean;
  64
  65     Apply (me; form : EditForm; ent : Transient; model : InterfaceModel)
  66         returns Boolean;
  67
  68
  69
  70     StaticEditor (myclass; list : HSequenceOfHAsciiString;
  71                   label : CString = "") returns ParamEditor;
  72     ---Purpose : Returns a ParamEditor to work on the Static Parameters of
  73     --           which names are listed in <list>
  74     --           Null Handle if <list> is null or empty
  75
  76 fields
  77
  78     thelabel : AsciiString;
  79
  80 end ParamEditor;