1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
|
-- File: IFSelect_Editor.cdl
-- Created: Mon Feb 23 15:04:39 1998
-- Author: Christian CAILLET
-- <cky@heliox.paris1.matra-dtv.fr>
---Copyright: Matra Datavision 1998
deferred class Editor from IFSelect inherits TShared
---Purpose : An Editor defines a set of values and a way to edit them, on
-- an entity or on the model (e.g. on its header)
--
-- Each Value is controlled by a TypedValue, with a number (it is
-- an Integer) and a name under two forms (complete and short)
-- and an edit mode
uses CString, Messenger from Message,
AsciiString from TCollection, HAsciiString from TCollection,
Array1OfTransient from TColStd, Array1OfAsciiString from TColStd,
Array1OfInteger from TColStd, DictionaryOfInteger from Dico,
HSequenceOfHAsciiString from TColStd,
InterfaceModel from Interface,
TypedValue from Interface, EditValue from IFSelect,
EditForm from IFSelect, ListEditor from IFSelect
raises OutOfRange from Standard
is
Initialize (nbval : Integer);
---Purpose : Prepares the list of Typed Values (gives its count)
-- This count can be tuned later, to a LOWER value, this allows
-- to initialize with a "maximum reservation" then cut the extra
SetNbValues (me : mutable; nbval : Integer)
---Purpose : Adjusts the true count of values. It can be LOWER or equal to
-- the initial size (which then acts as a reservation), but never
-- greater
raises OutOfRange is protected;
-- Error if <nbval> exceeds the initial reservation
SetValue (me : mutable; num : Integer;
typval : TypedValue;
shortname : CString = "";
accessmode : EditValue = IFSelect_Editable);
---Purpose : Sets a Typed Value for a given ident and short name, with an
-- Edit Mode
SetList (me : mutable; num : Integer; max : Integer = 0);
---Purpose : Sets a parameter to be a List
-- max < 0 : not for a list (set when starting)
-- max = 0 : list with no length limit (default for SetList)
-- max > 0 : list limited to <max> items
NbValues (me) returns Integer;
---Purpose : Returns the count of Typed Values
TypedValue (me; num : Integer) returns TypedValue;
---Purpose : Returns a Typed Value from its ident
IsList (me; num : Integer) returns Boolean;
---Purpose : Tells if a parameter is a list
MaxList (me; num : Integer) returns Integer;
---Purpose : Returns max length allowed for a list
-- = 0 means : list with no limit
-- < 0 means : not a list
Name (me; num : Integer; isshort : Boolean = Standard_False) returns CString;
---Purpose : Returns the name of a Value (complete or short) from its ident
-- Short Name can be empty
EditMode (me; num : Integer) returns EditValue;
---Purpose : Returns the edit mode of a Value
NameNumber (me; name : CString) returns Integer;
---Purpose : Returns the number (ident) of a Value, from its name, short or
-- complete. If not found, returns 0
-- Printings
PrintNames (me; S : Messenger from Message);
PrintDefs (me; S : Messenger from Message; labels : Boolean = Standard_False);
MaxNameLength (me; what : Integer) returns Integer;
---Purpose : Returns the MaxLength of, according to what :
-- <what> = -1 : length of short names
-- <what> = 0 : length of complete names
-- <what> = 1 : length of values labels
-- Specific methods
Label (me) returns AsciiString is deferred;
---Purpose : Returns the specific label
Form (me; readonly : Boolean; undoable : Boolean = Standard_True)
returns EditForm is virtual;
---Purpose : Builds and Returns an EditForm, empty (no data yet)
-- Can be redefined to return a specific type of EditForm
Recognize (me; form : EditForm) returns Boolean is deferred;
---Purpose : Tells if this Editor can work on this EditForm and its content
-- (model, entity ?)
StringValue (me; form : EditForm; num : Integer)
returns HAsciiString from TCollection is deferred;
---Purpose : Returns the value of an EditForm, for a given item
-- (if not a list. for a list, a Null String may be returned)
ListEditor (me; num : Integer) returns ListEditor is virtual;
---Purpose : Returns a ListEditor for a parameter which is a List
-- Default returns a basic ListEditor for a List, a Null Handle
-- if <num> is not for a List. Can be redefined
ListValue (me; form : EditForm; num : Integer)
returns HSequenceOfHAsciiString from TColStd is virtual;
---Purpose : Returns the value of an EditForm as a List, for a given item
-- If not a list, a Null Handle should be returned
-- Default returns a Null Handle, because many Editors have
-- no list to edit. To be redefined as required
Load (me; form : mutable EditForm; ent : Transient; model : InterfaceModel)
returns Boolean is deferred;
---Purpose : Loads original values from some data, to an EditForm
-- Remark: <ent> may be Null, this means all <model> is concerned
-- Also <model> may be Null, if no context applies for <ent>
-- And both <ent> and <model> may be Null, for a full static
-- editor
Update (me; form : mutable EditForm; num : Integer;
newval : HAsciiString; enforce : Boolean)
returns Boolean is virtual;
---Purpose : Updates the EditForm when a parameter is modified
-- I.E. default does nothing, can be redefined, as follows :
-- Returns True when done (even if does nothing), False in case
-- of refuse (for instance, if the new value is not suitable)
-- <num> is the rank of the parameter for the EDITOR itself
-- <enforce> True means that protected parameters can be touched
--
-- If a parameter commands the value of other ones, when it is
-- modified, it is necessary to touch them by Touch from EditForm
UpdateList (me; form : mutable EditForm; num : Integer;
newlist : HSequenceOfHAsciiString; enforce : Boolean)
returns Boolean is virtual;
---Purpose : Acts as Update, but when the value is a list
Apply (me; form : EditForm; ent : Transient; model : InterfaceModel)
returns Boolean is deferred;
---Purpose : Applies modified values of the EditForm with some data
-- Remark: <ent> may be Null, this means all <model> is concerned
-- Also <model> may be Null, if no context applies for <ent>
-- And both <ent> and <model> may be Null, for a full static
-- editor
fields
thenbval : Integer;
themaxsh : Integer;
themaxco : Integer;
themaxla : Integer;
thenames : DictionaryOfInteger;
thevalues : Array1OfTransient;
theshorts : Array1OfAsciiString;
themodes : Array1OfInteger;
thelists : Array1OfInteger;
end Editor;
|
