Integration of OCCT 6.5.0 from SVN
[occt.git] / src / XmlObjMgt / XmlObjMgt.cdl
CommitLineData
7fd59977 1-- File: XmlObjMgt.cdl
2-- Created: Tue Jul 17 12:30:46 2001
3-- Author: Julia DOROVSKIKH <jfa@hotdox.nnov.matra-dtv.fr>
4---Copyright: Matra Datavision 2001-2002
5-- History: AGV 150202: Add parameter isClearText to SetStringValue()
6
7package XmlObjMgt
8
9---Purpose: This package defines services to manage the storage
10-- grain of data produced by applications and those classes
11-- to manage persistent extern reference.
12
13uses
14 TCollection, TColStd, gp
15
16is
17 class Persistent;
18 ---Purpose: root for XML-persistence
19
20 class GP;
21 ---Purpose: translation of gp objects
22
23 imported DOMString;
24 imported Document;
25 imported Element;
26
27 -- Storage Relocation Table
28 alias SRelocationTable is IndexedMapOfTransient from TColStd;
29
30 -- Retrieval Relocation Table
31 alias RRelocationTable is DataMapOfIntegerTransient from TColStd;
32
33 generic class Array1;
34
35 -- Package methods
36 IdString returns DOMString from XmlObjMgt;
37 ---C++: return const &
38 ---Purpose: Define the name of XMLattribute 'ID' (to be used everywhere)
39
40 SetExtendedString (theElement: in out Element from XmlObjMgt;
41 theString : ExtendedString from TCollection)
42 returns Boolean from Standard;
43 ---Purpose: Add attribute <theElement extstring="theString" ...>
44
45 GetExtendedString (theElement: Element from XmlObjMgt;
46 theString : out ExtendedString from TCollection)
47 returns Boolean from Standard;
48 ---Purpose: Get attribute <theElement extstring="theString" ...>
49
50 GetStringValue (theElement : Element from XmlObjMgt)
51 returns DOMString from XmlObjMgt;
52 ---Purpose: Returns the first child text node
53
54 SetStringValue (theElement : in out Element from XmlObjMgt;
55 theData : DOMString from XmlObjMgt;
56 isClearText: Boolean from Standard = Standard_False);
57 ---Purpose: Add theData as the last child text node to theElement
58 -- isClearText(True) avoids analysis of the string and replacement
59 -- of characters like '<' and '&' during XML file storage.
60 -- Do NEVER set isClearText unless you have a hell of a reason
61
62 GetTagEntryString (theTarget : DOMString from XmlObjMgt;
63 theTagEntry: out AsciiString from TCollection)
64 returns Boolean from Standard;
65 ---Purpose: Convert XPath expression (DOMString) into TagEntry string
66 -- returns False on Error
67
68 SetTagEntryString (theSource : out DOMString from XmlObjMgt;
69 theTagEntry: AsciiString from TCollection);
70 ---Purpose: Convert XPath expression (DOMString) into TagEntry string
71 -- returns False on Error
72
73 FindChildElement (theSource: Element from XmlObjMgt;
74 theObjId : Integer from Standard)
75 returns Element from XmlObjMgt;
76
77 FindChildByRef (theSource : Element from XmlObjMgt;
78 theRefName: DOMString from XmlObjMgt)
79 returns Element from XmlObjMgt;
80
81 FindChildByName (theSource : Element from XmlObjMgt;
82 theName : DOMString from XmlObjMgt)
83 returns Element from XmlObjMgt;
84
85 GetInteger (theString : in out CString from Standard;
86 theValue : in out Integer from Standard)
87 returns Boolean from Standard;
88
89 GetReal (theString : in out CString from Standard;
90 theValue : in out Real from Standard)
91 returns Boolean from Standard;
92
93 GetReal (theString : DOMString from XmlObjMgt;
94 theValue : in out Real from Standard)
95 returns Boolean from Standard;
96
97end XmlObjMgt;