offapi/com/sun/star/xml/xpath/XXPathAPI.idl

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20 #ifndef __com_sun_star_xml_XPath_XXPathAPI_idl__
  21 #define __com_sun_star_xml_XPath_XXPathAPI_idl__
  22
  23 #include <com/sun/star/uno/XInterface.idl>
  24 #include <com/sun/star/xml/dom/XNode.idl>
  25 #include <com/sun/star/xml/dom/XNodeList.idl>
  26 #include <com/sun/star/xml/xpath/XXPathObject.idl>
  27 #include <com/sun/star/xml/xpath/XXPathExtension.idl>
  28 #include <com/sun/star/xml/xpath/XPathException.idl>
  29
  30
  31 module com { module sun { module star { module xml { module xpath {
  32
  33
  34 interface XXPathAPI : com::sun::star::uno::XInterface
  35 {
  36
  37     void registerNS(
  38             [in] string prefix,
  39             [in] string url);
  40
  41     void unregisterNS(
  42             [in] string prefix,
  43             [in] string url);
  44
  45     void registerExtension( [in] string serviceName );
  46     void registerExtensionInstance(
  47             [in] com::sun::star::xml::xpath::XXPathExtension aExtension);
  48
  49     /** Evaluate XPath Expression.
  50
  51         @param contextNode
  52             the context node (expression is relative to this node)
  53
  54         @param expr
  55             the XPath expression
  56
  57         @throws XPathException
  58             if the expression is malformed, or evaluation fails
  59
  60         @returns
  61             an object representing the result of the XPath evaluation
  62
  63         @see XXPathObject
  64      */
  65     XXPathObject eval(
  66             [in] com::sun::star::xml::dom::XNode contextNode,
  67             [in] string expr)
  68         raises( com::sun::star::xml::xpath::XPathException );
  69
  70     /** Evaluate XPath Expression.
  71
  72         @param contextNode
  73             the context node (expression is relative to this node)
  74
  75         @param expr
  76             the XPath expression
  77
  78         @param namespaceNode
  79             all namespaces declared on this node will be registered
  80
  81         @throws XPathException
  82             if the expression is malformed, or evaluation fails
  83
  84         @returns
  85             an object representing the result of the XPath evaluation
  86
  87         @see XXPathObject
  88      */
  89     XXPathObject evalNS(
  90             [in] com::sun::star::xml::dom::XNode contextNode,
  91             [in] string expr,
  92             [in] com::sun::star::xml::dom::XNode namespaceNode)
  93         raises( com::sun::star::xml::xpath::XPathException );
  94
  95     /** Evaluate an XPath expression to select a list of nodes.
  96
  97         @param contextNode
  98             the context node (expression is relative to this node)
  99
 100         @param expr
 101             the XPath expression
 102
 103         @throws XPathException
 104             if the expression is malformed, or evaluation fails
 105
 106         @returns
 107             result of the XPath evaluation: a list of nodes
 108
 109         @see XNodeList
 110      */
 111     com::sun::star::xml::dom::XNodeList selectNodeList(
 112             [in] com::sun::star::xml::dom::XNode contextNode,
 113             [in] string expr)
 114         raises( com::sun::star::xml::xpath::XPathException );
 115
 116     /** Evaluate an XPath expression to select a list of nodes.
 117
 118         @param contextNode
 119             the context node (expression is relative to this node)
 120
 121         @param expr
 122             the XPath expression
 123
 124         @param namespaceNode
 125             all namespaces declared on this node will be registered
 126
 127         @throws XPathException
 128             if the expression is malformed, or evaluation fails
 129
 130         @returns
 131             result of the XPath evaluation: a list of nodes
 132
 133         @see XNodeList
 134      */
 135     com::sun::star::xml::dom::XNodeList selectNodeListNS(
 136             [in] com::sun::star::xml::dom::XNode contextNode,
 137             [in] string expr,
 138             [in] com::sun::star::xml::dom::XNode namespaceNode)
 139         raises( com::sun::star::xml::xpath::XPathException );
 140
 141     /** Evaluate an XPath expression to select a single node.
 142
 143         @param contextNode
 144             the context node (expression is relative to this node)
 145
 146         @param expr
 147             the XPath expression
 148
 149         @throws XPathException
 150             if the expression is malformed, or evaluation fails
 151
 152         @returns
 153             result of the XPath evaluation: a single node
 154     */
 155     com::sun::star::xml::dom::XNode selectSingleNode(
 156             [in] com::sun::star::xml::dom::XNode contextNode,
 157             [in] string expr)
 158         raises( com::sun::star::xml::xpath::XPathException );
 159
 160     /** Evaluate an XPath expression to select a single node.
 161
 162         @param contextNode
 163             the context node (expression is relative to this node)
 164
 165         @param expr
 166             the XPath expression
 167
 168         @param namespaceNode
 169             all namespaces declared on this node will be registered
 170
 171         @throws XPathException
 172             if the expression is malformed, or evaluation fails
 173
 174         @returns
 175             result of the XPath evaluation: a single node
 176     */
 177     com::sun::star::xml::dom::XNode selectSingleNodeNS(
 178             [in] com::sun::star::xml::dom::XNode contextNode,
 179             [in] string expr,
 180             [in] com::sun::star::xml::dom::XNode namespaceNode)
 181         raises( com::sun::star::xml::xpath::XPathException );
 182
 183 };
 184
 185 }; }; }; }; };
 186
 187 #endif
 188
 189 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */