Files
OCCT/src/IFSelect/IFSelect_ParamEditor.cdl
bugmaster b311480ed5 0023024: Update headers of OCCT files
Added appropriate copyright and license information in source files
2012-03-21 19:43:04 +04:00

81 lines
3.1 KiB
Plaintext
Executable File

-- Created on: 1998-07-30
-- Created by: Christian CAILLET
-- Copyright (c) 1998-1999 Matra Datavision
-- Copyright (c) 1999-2012 OPEN CASCADE SAS
--
-- The content of this file is subject to the Open CASCADE Technology Public
-- License Version 6.5 (the "License"). You may not use the content of this file
-- except in compliance with the License. Please obtain a copy of the License
-- at http://www.opencascade.org and read it completely before using this file.
--
-- The Initial Developer of the Original Code is Open CASCADE S.A.S., having its
-- main offices at: 1, place des Freres Montgolfier, 78280 Guyancourt, France.
--
-- The Original Code and all software distributed under the License is
-- distributed on an "AS IS" basis, without warranty of any kind, and the
-- Initial Developer hereby disclaims all such warranties, including without
-- limitation, any warranties of merchantability, fitness for a particular
-- purpose or non-infringement. Please see the License for the specific terms
-- and conditions governing the rights and limitations under the License.
class ParamEditor from IFSelect inherits Editor from IFSelect
---Purpose : A ParamEditor gives access for edition to a list of TypedValue
-- (i.e. of Static too)
-- Its definition is made of the TypedValue to edit themselves,
-- and can add some constants, which can then be displayed but
-- not changed (for instance, system name, processor version ...)
--
-- I.E. it gives a way of editing or at least displaying
-- parameters as global
uses CString, Transient, AsciiString, HAsciiString, HSequenceOfHAsciiString,
InterfaceModel, EditForm, TypedValue
is
Create (nbmax : Integer = 100; label : CString = "") returns ParamEditor;
---Purpose : Creates a ParamEditor, empty, with a maximum count of params
-- (default is 100)
-- And a label, by default it will be "Param Editor"
AddValue (me : mutable; val : TypedValue; shortname : CString = "");
---Purpose : Adds a TypedValue
-- By default, its short name equates its complete name, it can
-- be explicited
AddConstantText (me : mutable; val : CString;
shortname : CString; completename : CString = "");
---Purpose : Adds a Constant Text, it will be Read Only
-- By default, its long name equates its shortname
Label (me) returns AsciiString;
Recognize (me; form : EditForm) returns Boolean;
StringValue (me; form : EditForm; num : Integer)
returns HAsciiString from TCollection;
Load (me; form : EditForm; ent : Transient; model : InterfaceModel)
returns Boolean;
Apply (me; form : EditForm; ent : Transient; model : InterfaceModel)
returns Boolean;
StaticEditor (myclass; list : HSequenceOfHAsciiString;
label : CString = "") returns ParamEditor;
---Purpose : Returns a ParamEditor to work on the Static Parameters of
-- which names are listed in <list>
-- Null Handle if <list> is null or empty
fields
thelabel : AsciiString;
end ParamEditor;