0024784: Move documentation in CDL files to proper location
[occt.git] / src / XCAFApp / XCAFApp_Application.cdl
1 -- Created on: 2000-05-24
2 -- Created by: data exchange team
3 -- Copyright (c) 2000-2014 OPEN CASCADE SAS
4 --
5 -- This file is part of Open CASCADE Technology software library.
6 --
7 -- This library is free software; you can redistribute it and/or modify it under
8 -- the terms of the GNU Lesser General Public License version 2.1 as published
9 -- by the Free Software Foundation, with special exception defined in the file
10 -- OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
11 -- distribution for complete text of the license and disclaimer of any warranty.
12 --
13 -- Alternatively, this file may be used under the terms of Open CASCADE
14 -- commercial license or contractual agreement.
15
16 class Application from XCAFApp inherits Application from TDocStd
17
18     ---Purpose: Implements an Application for the DECAF documents
19
20 uses
21     SequenceOfExtendedString from TColStd,
22     Document from TDocStd
23
24 is
25
26     Create returns Application from XCAFApp is protected;
27
28
29     ---Purpose: methods from CDF_Application
30     --          ============================
31
32
33     Formats(me: mutable; Formats: out SequenceOfExtendedString from TColStd) 
34     is redefined;    
35
36
37     ResourcesName (me: mutable) returns CString from Standard is redefined;
38
39     ---Purpose: methods from TDocStd_Application
40     --          ================================
41
42     InitDocument (me; aDoc : Document from TDocStd) is redefined;
43     ---Purpose: Set XCAFDoc_DocumentTool attribute
44     
45     ---API: method for initialisation
46
47     GetApplication (myclass) returns Application from XCAFApp;
48     ---Purpose: Initializes (for the first time) and returns the 
49     --          static object (XCAFApp_Application)
50     --          This is the only valid method to get XCAFApp_Application
51     --          object, and it should be called at least once before
52     --          any actions with documents in order to init application
53
54 end Application;