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
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
|
--
-- File: Aspect_Window.cdl
-- Created: 23 fevrier 1993
-- Author: NW,JPB,CAL
-- Modified: GG 28/01/00 G004 Add gamma correction value in Dump methods.
-- GG 07/03/00 G004 Add MMSize() method
-- TCL 26/10/00 G002 SetBackground(aName: CString) method
-- GG 28/11/00 G002 Add BackgroundImage(),
-- BackgroundFillMethod(),
-- HBackground() methods.
-- SAV 24/11/01 SetBackground(Quantity_Color)
--
---Copyright: MatraDatavision 1991,1992,1993
deferred class Window from Aspect
inherits
TShared from MMgt
---Purpose: This class allows the definition of a window
-- Warning: The position and size for the creation of the window
-- are defined in Device Screen Unit (DSU)
-- floating [0,1] space.
uses
Background from Aspect,
GradientBackground from Aspect,
GraphicDevice from Aspect,
TypeOfResize from Aspect,
FillMethod from Aspect,
Handle from Aspect,
PixMap from Aspect,
Ratio from Quantity,
Parameter from Quantity,
NameOfColor from Quantity,
Color from Quantity,
AsciiString from TCollection
raises
WindowDefinitionError from Aspect,
WindowError from Aspect
is
Initialize(aGraphicDevice: GraphicDevice from Aspect);
---Level: Public
---Purpose: Initializes the datas of a Window.
---------------------------------------------------
-- Category: Methods to modify the class definition
---------------------------------------------------
SetBackground ( me : mutable;
ABack : Background from Aspect ) is deferred;
---Level: Public
---Purpose: Modifies the window background.
---Category: Methods to modify the class definition
SetBackground ( me : mutable ;
BackColor : NameOfColor from Quantity ) is deferred;
---Level: Public
---Purpose: Modifies the window background from a Named Color.
---Category: Methods to modify the class definition
SetBackground ( me : mutable; color : Color from Quantity ) is deferred;
---Level: Public
---Purpose: Modifies the window background.
---Category: Methods to modify the class definition
SetBackground( me: mutable;
aName : CString from Standard;
aMethod : FillMethod from Aspect = Aspect_FM_CENTERED)
returns Boolean from Standard is deferred;
---Level: Public
---Purpose: Loads the window background from an image file <aName>
-- defined with a supported format XWD,GIF or BMP
-- and returns TRUE if the operation is successfull.
---Category: Methods to modify the class definition
SetBackground( me: mutable;
aBitmap: Handle from Aspect) is deferred;
---Level: Advanced
---Purpose: Loads the window background from a predefined bitmap.
-- Warning: the bitmap and window must have the same depth.
---Category: Methods to modify the class definition
SetBackground( me: mutable;
ABackground: GradientBackground from Aspect) is deferred;
---Level: Public
---Purpose: Modifies the window gradient background.
---Category: Methods to modify the class definition
SetDoubleBuffer ( me : mutable ;
DBmode : Boolean from Standard )
---Level: Advanced
---Purpose: Activates/Deactivates the Double Buffering capability
-- for this window.
-- Warning: Double Buffering is always DISABLE by default
-- If there is not enought ressources to activate the
-- double-buffering the DB mode flag can be set to FALSE.
---Category: Methods to modify the class definition
is deferred;
Flush ( me )
---Level: Advanced
---Purpose: Flushs all graphics to the screen and Swap the Double
-- buffer if Enable
---Category: Methods to modify the class definition
---Trigger: Raises if Something is WRONG at Drawing Time.
raises WindowError from Aspect is deferred;
Map ( me )
raises WindowError from Aspect is deferred;
---Level: Public
---Purpose: Opens the window <me>.
---Category: Methods to modify the class definition
Unmap ( me )
raises WindowError from Aspect is deferred;
---Level: Public
---Purpose: Closes the window <me>.
---Category: Methods to modify the class definition
DoResize ( me ) returns TypeOfResize from Aspect
raises WindowError from Aspect is deferred;
---Level: Advanced
---Purpose: Apply the resizing to the window <me>.
---Category: Methods to modify the class definition
DoMapping ( me ) returns Boolean from Standard
raises WindowError from Aspect is deferred;
---Level: Advanced
---Purpose: Apply the mapping change to the window <me>.
-- and returns TRUE if the window is mapped at screen.
---Category: Methods to modify the class definition
Destroy ( me : mutable )
raises WindowError from Aspect is deferred;
---Level: Advanced
---Purpose: Destroy the Window
---Category: Methods to modify the class definition
Clear (me)
raises WindowError from Aspect is deferred;
---Level: Public
---Purpose: Clear The Window in the Background Color
---Category: Methods to modify the class definition
ClearArea (me;
XCenter, YCenter: Integer from Standard;
Width , Height: Integer from Standard)
raises WindowError from Aspect is deferred;
---Level: Public
---Purpose: Clear The Window Area defined in PIXELS
-- in the Background Color
---Category: Methods to modify the class definition
Restore(me)
---Level: Public
---Purpose: Restore the BackingStored Window <me>.
---Category: Methods to modify the class definition
---Trigger: Raises if BackingStore() is disable.
raises WindowError from Aspect is deferred;
RestoreArea (me;
XCenter, YCenter: Integer from Standard;
Width , Height: Integer from Standard)
---Level: Public
---Purpose: Restore the BackingStored Window Area
-- defined in PIXELS.
---Category: Methods to modify the class definition
---Trigger: Raises if BackingStore() is disable.
raises WindowError from Aspect is deferred;
Dump ( me ; aFilename : CString from Standard;
aGammaValue: Real from Standard = 1.0) returns Boolean
---Level: Advanced
---Purpose: Dumps the Window to an image file (PNG, BMP, JPEG, GIF) with
--an optional gamma correction value according to the graphic system
--and returns TRUE if the dump occurs normaly.
---Category: Methods to modify the class definition
---Trigger: Raises if Window is not defined properly
raises WindowError from Aspect is deferred;
DumpArea ( me ; aFilename : CString from Standard ;
Xc, Yc : Integer from Standard ;
Width, Height : Integer from Standard;
aGammaValue: Real from Standard = 1.0 ) returns Boolean
---Level: Advanced
---Purpose: Dumps the Window Area defined by his center and PIXEL size
-- to an image file with
-- an optional gamma correction value according to the graphic system
--and returns TRUE if the dump occurs normaly.
---Category: Methods to modify the class definition
---Trigger: Raises if Window is not defined properly
-- or the area is out of the Window.
raises WindowError from Aspect is deferred;
ToPixMap ( me )
returns PixMap from Aspect
---Level : Public
---Purpose : dump the full contents of the window to a pixmap.
is deferred;
Load ( me ; aFilename : CString from Standard) returns Boolean
---Level: Advanced
---Purpose: Loads the XWD file to this Window.
-- Returns TRUE if the loading occurs normaly.
-- Warning: Note that the Window is enlarged automatically
--when the image size is too large for this window.
---Category: Methods to modify the class definition
---Trigger: Raises if Window is not defined properly
raises WindowError from Aspect is deferred;
LoadArea ( me ; aFilename : CString from Standard ;
Xc, Yc : Integer from Standard ;
Width, Height : Integer from Standard ) returns Boolean
---Level: Advanced
---Purpose: Loads the XWD file to Window Area defined by his center
--and PIXEL size
-- Returns TRUE if the loading occurs normaly.
-- Warning: Note that the Image is zoomed automatically
--when the image size is too large for this window area.
---Category: Methods to modify the class definition
---Trigger: Raises if Window is not defined properly
-- or the area is out of the Window.
raises WindowError from Aspect is deferred;
----------------------------
-- Category: Inquire methods
----------------------------
Background ( me ) returns Background from Aspect;
---Level: Public
---Purpose: Returns the window background.
---Category: Inquire methods
BackgroundImage ( me ) returns CString from Standard;
---Level: Public
---Purpose: Returns the current image background string
-- or NULL if nothing is defined.
BackgroundFillMethod( me ) returns FillMethod from Aspect;
---Level: Public
---Purpose: Returns the current image background fill mode.
GradientBackground ( me ) returns GradientBackground from Aspect;
---Level: Public
---Purpose: Returns the window gradient background.
HBackground ( me )
returns Handle from Aspect;
---Level: Advanced
---Purpose: Returns the background bitmap handle or
-- 0 when nothing is defined
---C++: inline
GraphicDevice ( me ) returns GraphicDevice from Aspect;
---Level: Public
---Purpose: Returns the Graphic Device associated to this Window.
---Category: Inquire methods
IsMapped ( me ) returns Boolean from Standard is deferred;
---Level: Public
---Purpose: Returns True if the window <me> is opened
-- and False if the window is closed.
---Category: Inquire methods
IsVirtual ( me ) returns Boolean from Standard;
---Level: Public
---Purpose: Returns True if the window <me> is virtual
---Category: Inquire methods
SetVirtual ( me : mutable;
theVirtual : Boolean from Standard );
---Level: Public
---Purpose: Setup the virtual state
---Category: Inquire methods
Ratio ( me ) returns Ratio from Quantity is deferred;
---Level: Public
---Purpose: Returns The Window RATIO equal to the physical
-- WIDTH/HEIGHT dimensions
---Category: Inquire methods
Position ( me ;
X1, Y1 ,X2, Y2 : out Parameter from Quantity)
is deferred;
---Level: Public
---Purpose: Returns The Window POSITION in DSU
---Category: Inquire methods
Position ( me ;
X1, Y1, X2, Y2 : out Integer from Standard )
is deferred;
---Level: Public
---Purpose: Returns The Window POSITION in PIXEL
---Category: Inquire methods
Size ( me ;
Width, Height : out Parameter from Quantity )
is deferred;
---Level: Public
---Purpose: Returns The Window SIZE in DSU
---Category: Inquire methods
Size ( me ;
Width, Height : out Integer from Standard )
is deferred;
---Level: Public
---Purpose: Returns The Window SIZE in PIXEL
---Category: Inquire methods
MMSize ( me ;
Width, Height : out Real from Standard )
is deferred;
---Level: Public
---Purpose: Returns The Window SIZE in MM
---Category: Inquire methods
Convert ( me ; PV : Integer from Standard )
returns Parameter from Quantity is deferred;
---Level: Public
---Purpose: Returns the DSU value depending of the PIXEL value.
---Category: Inquire methods
Convert ( me ; DV : Parameter from Quantity )
returns Integer from Standard is deferred;
---Level: Public
---Purpose: Returns the PIXEL value depending of the DSU value.
---Category: Inquire methods
Convert ( me ;
PX, PY : Integer from Standard ;
DX, DY : out Parameter from Quantity ) is deferred;
---Level: Public
---Purpose: Returns the DSU position depending of the PIXEL position.
---Category: Inquire methods
Convert ( me ;
DX, DY : Parameter from Quantity ;
PX, PY : out Integer from Standard ) is deferred;
---Level: Public
---Purpose: Returns the PIXEL position depending of the DSU position.
---Category: Inquire methods
BackingStore(me) returns Boolean from Standard is deferred;
---Level: Advanced
---Purpose: Returns the BackingStore capability for this Window .
-- If Answer is True Exposure can be recovered by
-- Restore RestoreArea methods .
-- If Answer is False,Application must Redraw
-- the exposed area.
---Category: Inquire methods
DoubleBuffer ( me )
returns Boolean from Standard is deferred;
---Level: Advanced
---Purpose: Returns the DoubleBuffer state.
---Category: Inquire methods
fields
MyGraphicDevice : GraphicDevice from Aspect is protected;
MyBackground : Background from Aspect is protected;
MyBackgroundImage : AsciiString from TCollection is protected;
MyBackgroundFillMethod : FillMethod from Aspect is protected;
MyHBackground : Handle from Aspect is protected;
MyGradientBackground : GradientBackground from Aspect is protected;
MyIsVirtual : Boolean from Standard is protected;
end Window;
|
