2487f773f7f3f06cb102e1998e747cb4d8e6ec6c
[occt.git] / src / Xw / Xw.cdl
1 -- Created on: 1993-06-24
2 -- Created by: GG
3 -- Copyright (c) 1993-1999 Matra Datavision
4 -- Copyright (c) 1999-2012 OPEN CASCADE SAS
5 --
6 -- The content of this file is subject to the Open CASCADE Technology Public
7 -- License Version 6.5 (the "License"). You may not use the content of this file
8 -- except in compliance with the License. Please obtain a copy of the License
9 -- at http://www.opencascade.org and read it completely before using this file.
10 --
11 -- The Initial Developer of the Original Code is Open CASCADE S.A.S., having its
12 -- main offices at: 1, place des Freres Montgolfier, 78280 Guyancourt, France.
13 --
14 -- The Original Code and all software distributed under the License is
15 -- distributed on an "AS IS" basis, without warranty of any kind, and the
16 -- Initial Developer hereby disclaims all such warranties, including without
17 -- limitation, any warranties of merchantability, fitness for a particular
18 -- purpose or non-infringement. Please see the License for the specific terms
19 -- and conditions governing the rights and limitations under the License.
20
21
22 package Xw
23
24         ---Version:
25
26         ---Purpose: This package contains the common X graphic interface.
27         --  Warning: All the interface is described by a set of C routines.
28         --          All these C routines are stored in the library
29         --          of this package.
30
31         ---References:
32
33 uses
34
35         TCollection,
36         TShort,
37         Aspect,
38         Quantity,
39         Image,
40         TColQuantity,
41         MFT,
42         TColStd
43
44 is
45
46         --------------------
47         -- Category: Classes
48         --------------------
49
50         class Driver;
51         ---Purpose: Creates the X driver.
52         --          Activates the c routines of the X interface.
53         ---Category: Classes
54
55         class Window;
56         ---Purpose: Creates the X Window drawable.
57         ---Category: Classes
58
59         class PixMap;
60         ---Purpose: Creates a X pixmap
61         ---Category: Classes
62
63         class ColorMap;
64         ---Purpose: Creates the X Colormap
65         ---Category: Classes
66
67         class TypeMap;
68         ---Purpose: Creates the X Typemap
69         ---Category: Classes
70
71         class WidthMap;
72         ---Purpose: Creates the X Widthmap
73         ---Category: Classes
74
75         class FontMap;
76         ---Purpose: Creates the X Fontmap
77         ---Category: Classes
78
79         class MarkMap;
80         ---Purpose: Creates the X Markmap
81         ---Category: Classes
82
83         class GraphicDevice;
84         ---Purpose: Creates the X Device (Connexion & Visual)
85         ---Category: Classes
86
87         class IconBox;
88         ---Purpose: Creates the X Icon Box
89         ---Category: Classes
90
91         class TextManager;
92         ---Purpose: Creates a text manager for MFT fonts.
93         ---Category: Classes
94
95         -------------------------
96         -- Category: Enumerations
97         -------------------------
98
99         enumeration WindowQuality is    WQ_3DQUALITY,
100                                         WQ_PICTUREQUALITY,
101                                         WQ_DRAWINGQUALITY,
102                                         WQ_SAMEQUALITY,
103                                         WQ_TRANSPARENT,
104                                         WQ_OVERLAY
105         end WindowQuality ;
106         ---Purpose: Definition of the Window graphic quality
107
108         enumeration TypeOfVisual is     TOV_STATICGRAY,
109                                         TOV_GRAYSCALE,
110                                         TOV_STATICCOLOR,
111                                         TOV_PSEUDOCOLOR,
112                                         TOV_TRUECOLOR,
113                                         TOV_DIRECTCOLOR,
114                                         TOV_DEFAULT,
115                                         TOV_PREFERRED_PSEUDOCOLOR,
116                                         TOV_PREFERRED_TRUECOLOR,
117                                         TOV_PREFERRED_OVERLAY,
118                                         TOV_OVERLAY
119         end TypeOfVisual from Xw;
120         ---Purpose: Definition of the visual type
121
122         enumeration TypeOfMapping is    TOM_HARDRAMP,
123                                         TOM_SIMPLERAMP,
124                                         TOM_BESTRAMP,
125                                         TOM_COLORCUBE,
126                                         TOM_READONLY
127         end TypeOfMapping from Xw;
128         ---Purpose: Definition of the colormap type
129
130         ---------------------------------
131         -- Category: Instantiated classes
132         ---------------------------------
133
134         class ListOfMFTFonts instantiates
135                 Array1 from TCollection (FontManager from MFT);
136         class HListOfMFTFonts instantiates
137                 HArray1 from TCollection (FontManager from MFT, ListOfMFTFonts);
138
139         -----------------------------
140         -- Category: Trace management
141         -----------------------------
142
143         SetTrace( TraceLevel,ErrorLevel : Integer ) ;
144         ---Purpose: Global Trace Level for Maintenance Only
145         ---Category: Trace management
146
147         TraceLevel returns Integer is private ;
148         ---Purpose: Return current global Trace level .
149         ---Category: Trace management
150
151         ErrorLevel returns Integer is private ;
152         ---Purpose: Return current global Error level .
153         ---Category: Trace management
154
155 end Xw;