1
0
Fork 0
libreoffice/offapi/com/sun/star/xml/xpath/XXPathAPI.idl
Daniel Baumann 8e63e14cf6
Adding upstream version 4:25.2.3.
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
2025-06-22 16:20:04 +02:00

177 lines
5.4 KiB
Text

/* -*- 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 .
*/
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 );
};
}; }; }; }; };
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */