0022627: Change OCCT memory management defaults
[occt.git] / src / Xw / Xw_FontMap.cdl
1 --
2 -- File:        Xw_FontMap.cdl
3 -- Created:     24/08/93
4 -- Author:      GG
5 --
6 ---Copyright:   MatraDatavision 1993
7 --
8
9 class FontMap from Xw inherits Transient 
10
11         ---Version: 0.0
12
13         ---Purpose: This class defines a FontMap object.
14
15         ---Keywords:
16         ---Warning:
17         ---References:
18
19 uses
20
21         FontMap                 from Aspect,
22         FontMapEntry            from Aspect
23
24 raises
25
26         FontMapDefinitionError  from Aspect,
27         BadAccess from Aspect
28
29 is
30
31         Create
32         returns mutable FontMap from Xw
33         is protected;
34         ---Level: Internal
35
36         Create (Connexion : CString from Standard) 
37         returns mutable FontMap from Xw 
38         ---Level: Public
39         ---Purpose: Creates a FontMap with an unallocated FontMapEntry.
40         raises FontMapDefinitionError from Aspect;
41         ---Error if FontMap creation failed according
42         --       to the supported hardware
43
44         SetEntry (me : mutable; 
45                   Entry : FontMapEntry from Aspect)
46         ---Level: Public
47         ---Purpose: Modifies an entry already defined or adds <Entry>
48         --          in the font map <me> if it don't exist.
49         raises BadAccess from Aspect is virtual;
50         ---Purpose:  Warning if FontMap size is exceeded.
51         --         or FontMap is not defined properly
52         --         or FontMapEntry Index is out of range according
53         --         to the supported hardware
54
55         SetEntries (me : mutable;
56                   Fontmap : FontMap from Aspect)
57         ---Level: Public
58         ---Purpose: Modifies all entries of <me> from the new Fontmap.
59         raises BadAccess from Aspect is virtual;
60         ---Purpose:  Warning if FontMap size is exceeded.
61         --         or FontMap is not defined properly
62         --         or One of new FontMapEntry Index is out of range according
63         --         to the supported hardware
64
65         Destroy (me : mutable) is virtual;
66         ---Level: Public
67         ---Purpose: Destroies the Fontmap
68         ---C++: alias ~
69
70         ----------------------------
71         -- Category: Inquire methods
72         ----------------------------
73
74         FreeFonts (me)
75         returns Integer from Standard 
76         ---Level: Public
77         ---Purpose: Returns the number of Free Fonts in the Fontmap
78         --          depending of the HardWare
79         raises BadAccess from Aspect is static;
80         ---Error If FontMap is not defined properly
81
82         ExtendedFontMap (me)
83         returns Address from Standard
84         is static protected;
85         ---Level: Public
86         ---Purpose: Returns extended data fontmap structure pointer.
87         ---Category: Inquire methods
88
89
90 fields
91
92         MyExtendedDisplay       : Address from Standard;
93         MyExtendedFontMap       : Address from Standard;
94
95 friends
96
97         class GraphicDevice from Xw
98
99 end FontMap;