0024624: Lost word in license statement in source files
[occt.git] / src / Aspect / Aspect_FontMapEntry.cdl
CommitLineData
b311480e 1-- Created on: 1993-09-07
2-- Created by: GG
3-- Copyright (c) 1993-1999 Matra Datavision
973c2be1 4-- Copyright (c) 1999-2014 OPEN CASCADE SAS
7fd59977 5--
973c2be1 6-- This file is part of Open CASCADE Technology software library.
7fd59977 7--
d5f74e42 8-- This library is free software; you can redistribute it and/or modify it under
9-- the terms of the GNU Lesser General Public License version 2.1 as published
973c2be1 10-- by the Free Software Foundation, with special exception defined in the file
11-- OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
12-- distribution for complete text of the license and disclaimer of any warranty.
7fd59977 13--
973c2be1 14-- Alternatively, this file may be used under the terms of Open CASCADE
15-- commercial license or contractual agreement.
7fd59977 16
17class FontMapEntry from Aspect
18
19 ---Version: 0.0
20
21 ---Purpose: This class defines a fontmap entry.
22 -- A fontmap entry is an association beetwen
23 -- a FontStyle object and an index in the fontmap.
24 ---Keywords:
25 ---Warning:
26 ---References:
27
28uses
29
30 FontStyle from Aspect
31
32raises
33
34 OutOfRange from Standard,
35 BadAccess from Aspect
36
37is
38
39 Create
40 returns FontMapEntry from Aspect;
41 ---Level: Public
42 ---Purpose: Creates an unallocated fontmap entry
43
44 Create ( index : Integer from Standard;
45 style : FontStyle from Aspect)
46 returns FontMapEntry;
47 ---Level: Public
48 ---Purpose: Creates an allocated fontmap entry
49
50 Create ( entry : FontMapEntry from Aspect )
51 returns FontMapEntry
52 ---Level: Public
53 ---Purpose: Creates an allocated fontmap entry.
54 -- Warning: Raises error if the fontmap entry <entry> is unallocated.
55 raises BadAccess from Aspect;
56
57 SetValue ( me: in out; index : Integer from Standard;
58 style : FontStyle from Aspect );
59 ---Level: Public
60 ---Purpose: Sets fontmap entry value and allocates it.
61
62 SetValue ( me: in out; entry : FontMapEntry from Aspect);
63 ---Level: Public
64 ---Purpose: Sets fontmap entry value and allocates it.
65 ---C++: alias operator =
66
67 SetType ( me: in out; Style : FontStyle from Aspect );
68 ---Level: Public
69 ---Purpose: Sets the line style of fontmap entry.
70
71 Type ( me ) returns FontStyle from Aspect
72 ---Warning: Raises error if the fontmap entry is unallocated .
73 raises BadAccess from Aspect;
74 ---C++: return const &
75
76 SetIndex ( me: in out; index : Integer from Standard);
77 ---Level: Public
78 ---Purpose: Sets index value of a fontmap entry.
79
80 Index ( me ) returns Integer from Standard
81 ---Warning: Raises error if the fontmap entry is unallocated .
82 raises BadAccess from Aspect;
83
84 Free ( me : in out );
85 ---Level: Public
86 ---Purpose: Unallocates the fontmap entry.
87
88 IsAllocated ( me ) returns Boolean from Standard;
89 ---Level: Public
90 ---Purpose: Returns True if the fontmap entry is allocated.
91 -- Warning: A fontmap entry is allocated when the font and
92 -- the index is defined.
93
94 Dump( me ) ;
95fields
96
97 MyType : FontStyle from Aspect;
98 MyIndex : Integer from Standard;
99 MyTypeIsDef : Boolean from Standard;
100 MyIndexIsDef : Boolean from Standard;
101
102end FontMapEntry from Aspect;