0023186: Unable to display Graphic3d_ArrayOfPoints after migrating from OCCT 6.5.2
[occt.git] / src / Draw / Draw_Interpretor.cdl
CommitLineData
b311480e 1-- Created on: 1995-02-23
2-- Created by: Remi LEQUETTE
3-- Copyright (c) 1995-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
7fd59977 21
22
23class Interpretor from Draw
24
25 ---Purpose: Provides an encapsulation of the TCL interpretor
26 -- to define Draw commands.
27
28uses
29
30 PInterp from Draw,
31 CommandFunction from Draw,
32 AsciiString from TCollection,
33 ExtendedString from TCollection
34
35is
36
37 Create returns Interpretor from Draw;
38
39 Init(me : in out);
40
41 Add(me : in out; Command : CString;
42 Help : CString;
43 Function : CommandFunction from Draw;
44 Group : CString = "User Commands");
45 ---Purpose: Creates a new command with name <Command>, help
46 -- string <Help> in group <Group>.
47 -- <Function> implement the function.
48
49 Add(me : in out; Command : CString;
50 Help : CString;
51 FileName : CString ;
52 Function : CommandFunction from Draw;
53 Group : CString = "User Commands");
54 ---Purpose: Creates a new command with name <Command>, help
55 -- string <Help> in group <Group>. <Function>
56 -- implement the function.
57 -- <FileName> is the name of the file that contains
58 -- the implementation of the command
59 --
60
61 Remove(me : in out; Command : CString)
62 returns Boolean;
63 ---Purpose: Removes <Command>, returns true if success (the
64 -- command existed).
65
66 --
67 -- The result
68 --
69
70 Result(me) returns CString;
71
72 Reset(me : in out);
73 ---Purpose: Resets the result to empty string
74
75 Append(me : in out; Result : CString) returns Interpretor from Draw;
76 ---Purpose: Appends to the result
77 ---C++: return &
78 ---C++: alias operator<<
79
80 Append(me : in out; Result : AsciiString from TCollection)
81 returns Interpretor from Draw;
82 ---Purpose: Appends to the result
83 ---C++: return &
84 ---C++: alias operator<<
85
86 Append(me : in out; Result : ExtendedString from TCollection)
87 returns Interpretor from Draw;
88 ---Purpose: Appends to the result
89 ---C++: return &
90 ---C++: alias operator<<
91
92 Append(me : in out; Result : Integer) returns Interpretor from Draw;
93 ---Purpose: Appends to the result
94 ---C++: return &
95 ---C++: alias operator<<
96
97 Append(me : in out; Result : Real) returns Interpretor from Draw;
98 ---Purpose: Appends to the result
99 ---C++: return &
100 ---C++: alias operator<<
101
102 Append(me : in out; Result : SStream) returns Interpretor from Draw;
103 ---Purpose: Appends to the result
104 ---C++: return &
105 ---C++: alias operator<<
106
107 AppendElement(me : in out; Result : CString);
108 ---Purpose: Appends to the result the string as a list element
109
110
111
112 --
113 -- Interpetation
114 --
115
116 Eval(me : in out; Script : CString)
117 returns Integer;
118 ---Purpose: Eval the script and returns OK = 0, ERROR = 1
119
120 RecordAndEval(me : in out; Script : CString; Flags : Integer = 0)
121 returns Integer;
122 ---Purpose: Eval the script and returns OK = 0, ERROR = 1
123 -- Store the script in the history record.
124
125 EvalFile(me : in out; FileName : CString)
126 returns Integer;
127 ---Purpose: Eval the content on the file and returns status
128
129 Complete(myclass; Script : CString) returns Boolean;
130 ---Purpose: Returns True if the script is complete, no pending
131 -- closing braces. (})
132
133 Destroy(me : in out);
134 ---C++: alias ~
135
136 --
137 -- Access to Tcl_Interp
138 --
139
140 Create(anInterp : PInterp from Draw)
141 returns Interpretor from Draw;
142
143 Set(me : in out; anInterp : PInterp from Draw);
144
145 Interp (me) returns PInterp from Draw;
146
147 fields
148
149 isAllocated : Boolean from Standard;
150 myInterp : PInterp from Draw;
151
152end Interpretor;