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
184
185
186
187
188
189
|
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
* This file is part of the LibreOffice project.
*
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
*
* This file incorporates work covered by the following license notice:
*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed
* with this work for additional information regarding copyright
* ownership. The ASF licenses this file to you under the Apache
* License, Version 2.0 (the "License"); you may not use this file
* except in compliance with the License. You may obtain a copy of
* the License at http://www.apache.org/licenses/LICENSE-2.0 .
*/
#ifndef __com_sun_star_xml_XPath_XXPathAPI_idl__
#define __com_sun_star_xml_XPath_XXPathAPI_idl__
#include <com/sun/star/uno/XInterface.idl>
#include <com/sun/star/xml/dom/XNode.idl>
#include <com/sun/star/xml/dom/XNodeList.idl>
#include <com/sun/star/xml/xpath/XXPathObject.idl>
#include <com/sun/star/xml/xpath/XXPathExtension.idl>
#include <com/sun/star/xml/xpath/XPathException.idl>
module com { module sun { module star { module xml { module xpath {
interface XXPathAPI : com::sun::star::uno::XInterface
{
void registerNS(
[in] string prefix,
[in] string url);
void unregisterNS(
[in] string prefix,
[in] string url);
void registerExtension( [in] string serviceName );
void registerExtensionInstance(
[in] com::sun::star::xml::xpath::XXPathExtension aExtension);
/** Evaluate XPath Expression.
@param contextNode
the context node (expression is relative to this node)
@param expr
the XPath expression
@throws XPathException
if the expression is malformed, or evaluation fails
@returns
an object representing the result of the XPath evaluation
@see XXPathObject
*/
XXPathObject eval(
[in] com::sun::star::xml::dom::XNode contextNode,
[in] string expr)
raises( com::sun::star::xml::xpath::XPathException );
/** Evaluate XPath Expression.
@param contextNode
the context node (expression is relative to this node)
@param expr
the XPath expression
@param namespaceNode
all namespaces declared on this node will be registered
@throws XPathException
if the expression is malformed, or evaluation fails
@returns
an object representing the result of the XPath evaluation
@see XXPathObject
*/
XXPathObject evalNS(
[in] com::sun::star::xml::dom::XNode contextNode,
[in] string expr,
[in] com::sun::star::xml::dom::XNode namespaceNode)
raises( com::sun::star::xml::xpath::XPathException );
/** Evaluate an XPath expression to select a list of nodes.
@param contextNode
the context node (expression is relative to this node)
@param expr
the XPath expression
@throws XPathException
if the expression is malformed, or evaluation fails
@returns
result of the XPath evaluation: a list of nodes
@see XNodeList
*/
com::sun::star::xml::dom::XNodeList selectNodeList(
[in] com::sun::star::xml::dom::XNode contextNode,
[in] string expr)
raises( com::sun::star::xml::xpath::XPathException );
/** Evaluate an XPath expression to select a list of nodes.
@param contextNode
the context node (expression is relative to this node)
@param expr
the XPath expression
@param namespaceNode
all namespaces declared on this node will be registered
@throws XPathException
if the expression is malformed, or evaluation fails
@returns
result of the XPath evaluation: a list of nodes
@see XNodeList
*/
com::sun::star::xml::dom::XNodeList selectNodeListNS(
[in] com::sun::star::xml::dom::XNode contextNode,
[in] string expr,
[in] com::sun::star::xml::dom::XNode namespaceNode)
raises( com::sun::star::xml::xpath::XPathException );
/** Evaluate an XPath expression to select a single node.
@param contextNode
the context node (expression is relative to this node)
@param expr
the XPath expression
@throws XPathException
if the expression is malformed, or evaluation fails
@returns
result of the XPath evaluation: a single node
*/
com::sun::star::xml::dom::XNode selectSingleNode(
[in] com::sun::star::xml::dom::XNode contextNode,
[in] string expr)
raises( com::sun::star::xml::xpath::XPathException );
/** Evaluate an XPath expression to select a single node.
@param contextNode
the context node (expression is relative to this node)
@param expr
the XPath expression
@param namespaceNode
all namespaces declared on this node will be registered
@throws XPathException
if the expression is malformed, or evaluation fails
@returns
result of the XPath evaluation: a single node
*/
com::sun::star::xml::dom::XNode selectSingleNodeNS(
[in] com::sun::star::xml::dom::XNode contextNode,
[in] string expr,
[in] com::sun::star::xml::dom::XNode namespaceNode)
raises( com::sun::star::xml::xpath::XPathException );
};
}; }; }; }; };
#endif
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|