offapi/com/sun/star/xml/dom/XDocumentBuilder.idl

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: XDocumentBuilder.idl,v $
  10  * $Revision: 1.5 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30
  31 #ifndef __com_sun_star_xml_dom_XDocumentBuilder_idl__
  32 #define __com_sun_star_xml_dom_XDocumentBuilder_idl__
  33
  34 #ifndef __com_sun_star_uno__XInterface_idl__
  35 #include <com/sun/star/uno/XInterface.idl>
  36 #endif
  37
  38 #ifndef __com_sun_star_xml_dom_XDocument_idl__
  39 #include <com/sun/star/xml/dom/XDocumentType.idl>
  40 #endif
  41 #ifndef __com_sun_star_xml_dom_XDOMImplementation_idl__
  42 #include <com/sun/star/xml/dom/XDOMImplementation.idl>
  43 #endif
  44 #ifndef __com_sun_star_io_XInputStream_idl__
  45 #include <com/sun/star/io/XInputStream.idl>
  46 #endif
  47
  48 #ifndef __com_sun_star_xml_sax_SAXException_idl__
  49 #include <com/sun/star/xml/sax/SAXException.idl>
  50 #endif
  51
  52 #ifndef __com_sun_star_xml_sax_XErrorHandler_idl__
  53 #include <com/sun/star/xml/sax/XErrorHandler.idl>
  54 #endif
  55 #ifndef __com_sun_star_xml_sax_XEntityResolver_idl__
  56 #include <com/sun/star/xml/sax/XEntityResolver.idl>
  57 #endif
  58
  59
  60 #ifndef __com_sun_star_io_IOException_idl__
  61 #include <com/sun/star/io/IOException.idl>
  62 #endif
  63
  64 module com { module sun { module star { module xml { module dom {
  65
  66 interface XInputStream;
  67
  68 /**
  69 Builds a new dom tree
  70 */
  71 interface XDocumentBuilder : com::sun::star::uno::XInterface
  72 {
  73
  74     /**
  75     Obtain an instance of a DOMImplementation object.
  76     */
  77     XDOMImplementation getDOMImplementation();
  78
  79     /**
  80     Indicates whether or not this parser is configured to understand
  81     namespaces.
  82     */
  83     boolean isNamespaceAware();
  84
  85     /**
  86     Indicates whether or not this parser is configured to validate XML
  87     documents.
  88     */
  89     boolean isValidating();
  90
  91     /**
  92     Obtain a new instance of a DOM Document object to build a DOM tree
  93     with.
  94     */
  95     XDocument newDocument();
  96
  97     /**
  98     Parse the content of the given InputStream as an XML document and
  99     return a new DOM Document object.
 100     */
 101     XDocument parse([in] com::sun::star::io::XInputStream is)
 102             raises( com::sun::star::xml::sax::SAXException,
 103                     com::sun::star::io::IOException );
 104
 105     /**
 106     Parse the content of the given URI as an XML document and return
 107     a new DOM Document object.
 108     */
 109     XDocument parseURI([in] string uri)
 110             raises( com::sun::star::xml::sax::SAXException,
 111                     com::sun::star::io::IOException );
 112
 113     /**
 114     Specify the EntityResolver to be used to resolve entities present
 115     in the XML document to be parsed.
 116     */
 117     void setEntityResolver([in] com::sun::star::xml::sax::XEntityResolver er);
 118
 119     /**
 120     Specify the ErrorHandler to be used to report errors present in
 121     the XML document to be parsed.
 122     */
 123     void setErrorHandler([in] com::sun::star::xml::sax::XErrorHandler eh);
 124
 125 };
 126
 127 }; }; }; }; };
 128
 129 #endif