blob: 365df1980b2d4df511b3feab3836deb61f74fc3d (
plain)
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
|
--
-- File: Aspect_FontStyle.cdl
-- Created: Mardi 7 Septembre 1993
-- Author: GG
--
---Copyright: MatraDatavision 1991-1993
--
class FontStyle from Aspect
---Version:
---Purpose: This class defines a Font Style.
-- The Style can be Predefined or defined by the user
---Keywords: FontStyle
---Warning:
---References:
uses
Length from Quantity,
PlaneAngle from Quantity,
TypeOfFont from Aspect,
AsciiString from TCollection
raises
FontStyleDefinitionError from Aspect
is
Create
returns FontStyle from Aspect
---Level: Public
---Purpose: Creates a font style with the default values of
-- FontStyle type : DEFAULT
--
raises FontStyleDefinitionError from Aspect;
-- if the maximum number of font style is exceeded
Create ( Type : TypeOfFont from Aspect;
Size : Length from Quantity;
Slant : PlaneAngle from Quantity = 0.0;
CapsHeight : Boolean from Standard = Standard_False)
returns FontStyle from Aspect
---Level: Public
---Purpose: Creates the font style <Type> depending of
-- Size given in the basic LENGTH unit and Slant in
-- the basic PLANE ANGLE unit.
-- When CapsHeight is TRUE the size defines the
-- ascent height of the font;if FALSE,the size
-- defines the ascent+descent part of the font.
raises FontStyleDefinitionError from Aspect;
-- if the Size is <= 0.
Create ( Style : CString from Standard;
Size : Length from Quantity;
Slant : PlaneAngle from Quantity = 0.0;
CapsHeight : Boolean from Standard = Standard_False)
returns FontStyle from Aspect
---Level: Public
---Purpose: Creates a font style from Adobe font style descriptor
-- depending of Size given in MM and Slant in RADIAN.
-- When CapsHeight is TRUE the size defines the
-- ascent height of the font;if FALSE,the size
-- defines the ascent+descent part of the font.
-- Font Style Descriptor must be :
-- Simple form is "family" Ex: "helvetica"
-- More complex form is "family-weight" Ex: "helvetica-bold"
-- Full form is :
-- "-foundry-family-weight-slant-swdth-adstyl-pixelsize"
-- "-pointsize-resx-resy-spacing-avgWidth-registry-encoding"
-- where each field must be replaced by an "*"
-- Warning: create the smalest font size if the foundry height
--and the <Size> are null.
raises FontStyleDefinitionError from Aspect;
-- if <Style> is empty or don't have an normalized X format
Create ( Style : CString from Standard)
returns FontStyle from Aspect
---Level: Public
---Purpose: Creates a transformable font with the full font name <Style>
-- given in the XLFD descriptor :
-- "-foundry-family-weight-slant-swidth-adstyl-pixelsize-pointsize-
-- resx-resy-spacing-avdWidth-registry-encoding".
-- The fields pixelsize ,pointsize,resx,resy are sets to 0
-- and all unknown fields sets to '*'.
-- Example: "adobe-helvetica-bold-*-*-*-0-0-0-0-*-*-iso8859-*"
-- Warning: the height and slant of the font is supposed to be NULL
-- and computed dynamically at the drawing text time.
raises FontStyleDefinitionError from Aspect;
---Trigger: If <Style> is empty or dont't have an XLFD font descriptor.
---------------------------------------------------
-- Category: Methods to modify the class definition
---------------------------------------------------
Assign ( me : in out ;
Other : FontStyle from Aspect )
returns FontStyle from Aspect;
---Level: Public
---Purpose: Updates the font style <me> from the definition of the
-- font style <Other>.
---Category: Methods to modify the class definition
---C++: alias operator =
---C++: return &
SetValues ( me : in out ;
Type : TypeOfFont from Aspect;
Size : Length from Quantity;
Slant : PlaneAngle from Quantity = 0.0;
CapsHeight : Boolean from Standard = Standard_False)
---Level: Public
---Purpose: Updates the font style <me> from the definition of the
-- font style <Type>.
raises FontStyleDefinitionError from Aspect;
-- if the Size is <= 0.
---Category: Methods to modify the class definition
SetValues ( me : in out ;
Style : CString from Standard;
Size : Length from Quantity;
Slant : PlaneAngle from Quantity = 0.0;
CapsHeight : Boolean from Standard = Standard_False)
---Level: Public
---Purpose: Updates a font style with the new Abode font descriptor
-- Warning: create the smalest font size if the foundry height
--and the <Size> are null.
raises FontStyleDefinitionError from Aspect;
---Trigger: If <Style> is empty or dont't have an normalized X format.
---Category: Methods to modify the class definition
SetValues ( me : in out ;
Style : CString from Standard)
---Level: Public
---Purpose: Updates a font style with the new XLFD font descriptor
raises FontStyleDefinitionError from Aspect;
---Trigger: If <Style> is empty or dont't have an XLFD font descriptor.
---Category: Methods to modify the class definition
SetFamily (me : in out;
aName: CString from Standard);
---Level: Public
---Purpose: Sets the family of the font.
SetWeight (me : in out;
aName: CString from Standard);
---Level: Public
---Purpose: Sets the weight of the font.
SetRegistry (me : in out;
aName: CString from Standard);
---Level: Public
---Purpose: Sets the registry of the font.
SetEncoding (me : in out;
aName: CString from Standard);
---Level: Public
---Purpose: Sets the encoding of the font.
----------------------------
-- Category: Inquire methods
----------------------------
Style ( me )
returns TypeOfFont from Aspect;
---Level: Public
---Purpose: Returns the type of the font style <me>
---Category: Inquire methods
Length ( me )
returns Integer from Standard ;
---Level: Public
---Purpose: Returns the string components length of the
-- font style descriptor
---Category: Inquire methods
Value ( me )
returns CString from Standard ;
---Level: Public
---Purpose: Returns the String component of a font style
---Category: Inquire methods
Size ( me )
returns Length from Quantity ;
---Level: Public
---Purpose: Returns the Size component of a font style
---Category: Inquire methods
Slant ( me )
returns PlaneAngle from Quantity ;
---Level: Public
---Purpose: Returns the Slant component of a font style
---Category: Inquire methods
CapsHeight( me )
returns Boolean from Standard;
---Level: Public
---Purpose: Returns the CapsHeight component of a font style
---Category: Inquire methods
AliasName (me)
returns CString from Standard;
---Level: Public
---Purpose: Returns a shorter font name which identify the
-- main characteristics of the fonts.
---Example: "helvetica-bold"
FullName (me)
returns CString from Standard;
---Level: Public
---Purpose: Returns the full normalized font name
Foundry (me)
returns CString from Standard;
---Level: Public
---Purpose: Returns the foundry of the font.
---Example: "adobe"
Family (me)
returns CString from Standard;
---Level: Public
---Purpose: Returns the family of the font.
---Example: "helvetica"
Weight (me)
returns CString from Standard;
---Level: Public
---Purpose: Returns the weight of the font.
---Example: "bold"
Registry (me)
returns CString from Standard;
---Level: Public
---Purpose: Returns the char set registry of the font.
---Example: "iso8859"
Encoding (me)
returns CString from Standard;
---Level: Public
---Purpose: Returns the char set encoding of the font.
---Example: "1"
SSlant (me)
returns CString from Standard;
---Level: Public
---Purpose: Returns the slant of the font.
---Example: "i"
SWidth (me)
returns CString from Standard;
---Level: Public
---Purpose: Returns the width name of the font.
---Example: "normal"
SStyle (me)
returns CString from Standard;
---Level: Public
---Purpose: Returns the style name of the font.
---Example: "serif"
SPixelSize (me)
returns CString from Standard;
---Level: Public
---Purpose: Returns the pixel size of the font.
SPointSize (me)
returns CString from Standard;
---Level: Public
---Purpose: Returns the point size of the font.
SResolutionX (me)
returns CString from Standard;
---Level: Public
---Purpose: Returns the resolution X of the font.
SResolutionY (me)
returns CString from Standard;
---Level: Public
---Purpose: Returns the resolution Y of the font.
SSpacing (me)
returns CString from Standard;
---Level: Public
---Purpose: Returns the spacing of the font.
---Example: "p"
SAverageWidth (me)
returns CString from Standard;
---Level: Public
---Purpose: Returns the average width of the font.
---Example: "90"
Dump (me);
---Level: Public
---Purpose: Dumps the font attributes.
IsEqual(me; Other : FontStyle from Aspect) returns Boolean;
---C++: alias operator==
IsNotEqual(me; Other : FontStyle from Aspect) returns Boolean;
---C++: alias operator!=
----------------------------
-- Category: Private methods
----------------------------
SetPredefinedStyle ( me : in out ;
Type : TypeOfFont from Aspect;
Size : Length from Quantity;
Slant : PlaneAngle from Quantity;
CapsHeight : Boolean from Standard)
---Level: Internal
---Purpose: Set MyFontString with the predefined style value
-- and size according of type
---Category: Private methods
raises FontStyleDefinitionError from Aspect is private;
-- if the Type is USERDEFINED !
Normalize (myclass;
aFontName: CString from Standard;
aSize: in out Real from Standard)
returns CString from Standard is private;
---Purpose: Returns a normalized descriptor from the font name
-- <aFontName>
Field (myclass;
aFontName: AsciiString from TCollection;
aRank: Integer from Standard)
returns CString from Standard is private;
---Purpose: Returns the field at position <aRank>
-- from the font name <aFontName>.
SetField (myclass;
aFontName: AsciiString from TCollection;
aField: CString from Standard;
aRank: Integer from Standard)
returns CString from Standard is private;
---Purpose: Sets the field at position <aRank>
-- of the fontname <aFontName>
-- from the field name <aField>.
--
fields
--
-- Class : Aspect_FontStyle
--
-- Purpose : Declaration of variables specific to font styles
--
MyFontType : TypeOfFont from Aspect is protected;
MyStyle : AsciiString from TCollection is protected;
MyFontName : AsciiString from TCollection is protected;
MyFontSize : Real from Standard is protected;
MyFontSlant : Real from Standard is protected;
MyCapsHeight : Boolean from Standard is protected;
end FontStyle;
|
