offapi/com/sun/star/xml/dom/XDocumentBuilder.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_dom_XDocumentBuilder_idl__
  21 #define __com_sun_star_xml_dom_XDocumentBuilder_idl__
  22
  23 #include <com/sun/star/uno/XInterface.idl>
  24 #include <com/sun/star/xml/dom/XDocumentType.idl>
  25 #include <com/sun/star/xml/dom/XDOMImplementation.idl>
  26 #include <com/sun/star/io/XInputStream.idl>
  27 #include <com/sun/star/xml/sax/SAXException.idl>
  28 #include <com/sun/star/xml/sax/XErrorHandler.idl>
  29 #include <com/sun/star/xml/sax/XEntityResolver.idl>
  30
  31
  32 #include <com/sun/star/io/IOException.idl>
  33
  34 module com { module sun { module star { module xml { module dom {
  35
  36 interface XInputStream;
  37
  38 /**
  39 Builds a new dom tree
  40 */
  41 interface XDocumentBuilder : com::sun::star::uno::XInterface
  42 {
  43
  44     /**
  45     Obtain an instance of a DOMImplementation object.
  46     */
  47     XDOMImplementation getDOMImplementation();
  48
  49     /**
  50     Indicates whether or not this parser is configured to understand
  51     namespaces.
  52     */
  53     boolean isNamespaceAware();
  54
  55     /**
  56     Indicates whether or not this parser is configured to validate XML
  57     documents.
  58     */
  59     boolean isValidating();
  60
  61     /**
  62     Obtain a new instance of a DOM Document object to build a DOM tree
  63     with.
  64     */
  65     XDocument newDocument();
  66
  67     /**
  68     Parse the content of the given InputStream as an XML document and
  69     return a new DOM Document object.
  70     */
  71     XDocument parse([in] com::sun::star::io::XInputStream is)
  72             raises( com::sun::star::xml::sax::SAXException,
  73                     com::sun::star::io::IOException );
  74
  75     /**
  76     Parse the content of the given URI as an XML document and return
  77     a new DOM Document object.
  78     */
  79     XDocument parseURI([in] string uri)
  80             raises( com::sun::star::xml::sax::SAXException,
  81                     com::sun::star::io::IOException );
  82
  83     /**
  84     Specify the EntityResolver to be used to resolve entities present
  85     in the XML document to be parsed.
  86     */
  87     void setEntityResolver([in] com::sun::star::xml::sax::XEntityResolver er);
  88
  89     /**
  90     Specify the ErrorHandler to be used to report errors present in
  91     the XML document to be parsed.
  92     */
  93     void setErrorHandler([in] com::sun::star::xml::sax::XErrorHandler eh);
  94
  95 };
  96
  97 }; }; }; }; };
  98
  99 #endif
 100
 101 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */