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