xref: /AOO41X/main/oovbaapi/genconstidl/ApiSymbols.dtd (revision 1ecadb572e7010ff3b3382ad9bf179dbc6efadbb)
1<!-- =====================================================================
2
3  DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4
5  Copyright 2000, 2010 Oracle and/or its affiliates.
6
7  OpenOffice.org - a multi-platform office productivity suite
8
9  This file is part of OpenOffice.org.
10
11  OpenOffice.org is free software: you can redistribute it and/or modify
12  it under the terms of the GNU Lesser General Public License version 3
13  only, as published by the Free Software Foundation.
14
15  OpenOffice.org is distributed in the hope that it will be useful,
16  but WITHOUT ANY WARRANTY; without even the implied warranty of
17  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18  GNU Lesser General Public License version 3 for more details
19  (a copy is included in the LICENSE file that accompanied this code).
20
21  You should have received a copy of the GNU Lesser General Public License
22  version 3 along with OpenOffice.org.  If not, see
23  <http://www.openoffice.org/license.html>
24  for a copy of the LGPLv3 License.
25
26====================================================================== -->
27
28<!ELEMENT api (element)+>
29	<!ATTLIST api
30		library-name         CDATA #REQUIRED
31		library-identifier   CDATA #REQUIRED
32		library-majorversion CDATA #IMPLIED
33		library-minorversion CDATA #IMPLIED
34		library-type         CDATA #IMPLIED
35		library-GUID         CDATA #IMPLIED
36		library-filename     CDATA #IMPLIED
37		author               CDATA #REQUIRED
38		date-created         CDATA #REQUIRED
39   >
40
41<!ELEMENT element (source, destination?)>
42	<!ATTLIST element
43		type       (class|method|property|enumeration|constant|event)  #REQUIRED
44		collection (true|false)                                        "false"
45		platform   CDATA                                               #IMPLIED
46	>
47
48<!ELEMENT source (context?, name?, type?, value?, parameter-list?)>
49	<!ATTLIST source
50		id           CDATA  #REQUIRED
51		start-index  CDATA  #IMPLIED
52	>
53
54<!ELEMENT context (#PCDATA)>
55	<!ATTLIST context
56		kind  (library|class|module|enumeration)  #REQUIRED
57	>
58
59<!ELEMENT name (#PCDATA)>
60	<!ATTLIST name
61		default  (true|false)  "false"
62	>
63
64<!ELEMENT type (#PCDATA | choice)*>
65	<!ATTLIST type
66		array CDATA #IMPLIED
67	>
68
69<!ELEMENT choice (#PCDATA)>
70
71<!ELEMENT value (#PCDATA)>
72
73<!ELEMENT parameter-list (parameter+)>
74
75<!ELEMENT parameter (type?, name)>
76	<!ATTLIST parameter
77		optional   (true|false)  "false"
78		reference  (true|false)  "false"
79	>
80
81<!ELEMENT destination (((inplace-code | property-access-code), localdecl-code*, module-code*, comment*)?)>
82    <!ATTLIST destination designation (identity|not-yet-implemented)  "not-yet-implemented">
83
84<!ELEMENT inplace-code (context-code? , name-code, parameter-code*)>
85
86<!ELEMENT context-code EMPTY>
87
88<!ELEMENT name-code (#PCDATA)>
89
90<!ELEMENT parameter-code (#PCDATA | context-code | rvalue-code | default-code)*>
91
92<!ELEMENT rvalue-code EMPTY>
93
94<!ELEMENT default-code (#PCDATA)>
95
96<!ELEMENT property-access-code (getter-code?, setter-code?)>
97
98<!ELEMENT getter-code (context-code? , name-code, parameter-code*)>
99
100<!ELEMENT module-code (#PCDATA)>
101	<!ATTLIST module-code
102		module-name  CDATA  #IMPLIED
103	>
104<!ELEMENT comment (#PCDATA)>
105	<!ATTLIST comment
106		apistatus (todo|so7|so8|noapi) #REQUIRED
107		forparams CDATA  #IMPLIED
108	>
109
110<!ELEMENT localdecl-code (#PCDATA | context-code)*>
111
112<!ELEMENT setter-code (context-code? , name-code, parameter-code*)>
113
114
115