1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
|
/*************************************************************************
*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* Copyright 2008 by Sun Microsystems, Inc.
*
* OpenOffice.org - a multi-platform office productivity suite
*
* $RCSfile: XFastAttributeList.idl,v $
* $Revision: 1.3 $
*
* This file is part of OpenOffice.org.
*
* OpenOffice.org is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License version 3
* only, as published by the Free Software Foundation.
*
* OpenOffice.org is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License version 3 for more details
* (a copy is included in the LICENSE file that accompanied this code).
*
* You should have received a copy of the GNU Lesser General Public License
* version 3 along with OpenOffice.org. If not, see
* <http://www.openoffice.org/license.html>
* for a copy of the LGPLv3 License.
*
************************************************************************/
#ifndef __com_sun_star_xml_sax_XFastAttributeList_idl__
#define __com_sun_star_xml_sax_XFastAttributeList_idl__
#ifndef __com_sun_star_uno_XInterface_idl__
#include <com/sun/star/uno/XInterface.idl>
#endif
#ifndef __com_sun_star_xml_Attribute_idl__
#include <com/sun/star/xml/Attribute.idl>
#endif
#ifndef __com_sun_star_xml_FastAttribute_idl__
#include <com/sun/star/xml/FastAttribute.idl>
#endif
#ifndef __com_sun_star_xml_sax_SAXException_idl__
#include <com/sun/star/xml/sax/SAXException.idl>
#endif
//=============================================================================
module com { module sun { module star { module xml { module sax {
//=============================================================================
/** a container for the attributes of an xml element.
<br>Attributes are seperated into known attributes and unknown attributes.
<p>Known attributes have a local name that is known to the <type>XFastTokenHandler</token>
registered at the <type>XFastParser</type> which created the sax event containing
this attributes. If an attribute also has a namespace, that must be registered
at the <type>XFastParser</type>, else this attribute is also unknown even if
the local name is known.
*/
interface XFastAttributeList: com::sun::star::uno::XInterface
{
/** checks if an attribute is available.<br>
@param Token
contains the integer token from the <type>XFastTokenHandler</type>
registered at the <type>XFastParser</type>.<br>
If the attribute name has a namespace that was registered with the
<type>XFastParser</type>, Token contains the integer token of the
attributes local name from the <type>XFastTokenHandler</type> and
the integer token of the namespace combined with an arithmetic
<b>or</b> operation.
@returns
<TRUE/>, if the attribute is available
*/
boolean hasAttribute( [in] long Token );
/** retrieves the token of an attributes value.<br>
@param Token
contains the integer token from the <type>XFastTokenHandler</type>
registered at the <type>XFastParser</type>.<br>
If the attribute name has a namespace that was registered with the
<type>XFastParser</type>, Token contains the integer token of the
attributes local name from the <type>XFastTokenHandler</type> and
the integer token of the namespace combined with an arithmetic
<b>or</b> operation.
@returns
The integer token of the value from the attribute or <const>FastToken::Invalid</const>
@raises SAXEXception
if the attribute is not available
*/
long getValueToken( [in] long Token )
raises( SAXException );
/**retrieves the token of an attributes value.<br>
@param Token
contains the integer token from the <type>XFastTokenHandler</type>
registered at the <type>XFastParser</type>.<br>
If the attribute name has a namespace that was registered with the
<type>XFastParser</type>, Token contains the integer token of the
attributes local name from the <type>XFastTokenHandler</type> and
the integer token of the namespace combined with an arithmetic
<b>or</b> operation.
@param Default
This value will be returned if the attribute is not available
@returns
If the attribute is available it returns the integer token of the value
from the attribute or <const>FastToken::Invalid</const>.
If not the value of <param>Default</param> is returned.
*/
long getOptionalValueToken( [in] long Token, [in] long Default );
/** retrieves the value of an attributes.<br>
@param Token
contains the integer token from the <type>XFastTokenHandler</type>
registered at the <type>XFastParser</type>.<br>
If the attribute name has a namespace that was registered with the
<type>XFastParser</type>, Token contains the integer token of the
attributes local name from the <type>XFastTokenHandler</type> and
the integer token of the namespace combined with an arithmetic
<b>or</b> operation.
@returns
The string value from the attribute.
@raises SAXEXception
if the attribute is not available
*/
string getValue( [in] long Token )
raises( SAXException );
/** retrieves the value of an attributes.<br>
@param Token
contains the integer token from the <type>XFastTokenHandler</type>
registered at the <type>XFastParser</type>.<br>
If the attribute name has a namespace that was registered with the
<type>XFastParser</type>, Token contains the integer token of the
attributes local name from the <type>XFastTokenHandler</type> and
the integer token of the namespace combined with an arithmetic
<b>or</b> operation.
@returns
The string value from the attribute or an empty string if the
attribute is not available.
*/
string getOptionalValue( [in] long Token );
/** returns a sequence of attributes which names and or namespaces URLS
can not be translated to tokens.
*/
sequence< ::com::sun::star::xml::Attribute > getUnknownAttributes();
/** returns a sequence of attributes which names and or namespaces URLS
are translated to tokens.
*/
sequence< ::com::sun::star::xml::FastAttribute > getFastAttributes();
};
//=============================================================================
}; }; }; }; };
#endif
|
