offapi/com/sun/star/xml/dom/XDOMImplementation.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_XDOMImplementation_idl__
  21 #define __com_sun_star_xml_dom_XDOMImplementation_idl__
  22
  23 #include <com/sun/star/uno/XInterface.idl>
  24 #include <com/sun/star/xml/dom/DOMException.idl>
  25
  26
  27 module com { module sun { module star { module xml { module dom {
  28
  29 interface XDocument;
  30 interface XDocumentType;
  31
  32 interface XDOMImplementation : com::sun::star::uno::XInterface
  33 {
  34     /**
  35     Creates a DOM Document object of the specified type with its document element.
  36     Throws:
  37     DOMException - INVALID_CHARACTER_ERR: Raised if the specified qualified name contains an illegal character.
  38                    NAMESPACE_ERR: Raised if the qualifiedName is malformed, if the qualifiedName has a prefix
  39                       and the namespaceURI is null, or if the qualifiedName has a prefix that is "xml" and
  40                       the namespaceURI is different from " http://www.w3.org/XML/1998/namespace" , or if the
  41                       DOM implementation does not support the "XML" feature but a non-null namespace URI was
  42                       provided, since namespaces were defined by XML.
  43                    WRONG_DOCUMENT_ERR: Raised if doctype has already been used with a different document or
  44                       was created from a different implementation.
  45                    NOT_SUPPORTED_ERR: May be raised by DOM implementations which do not support the
  46                       "XML" feature, if they choose not to support this method. Other features introduced
  47                       in the future, by the DOM WG or in extensions defined by other groups, may also
  48                       demand support for this method; please consult the definition of the feature to see
  49                       if it requires this method.
  50     */
  51     XDocument createDocument([in] string namespaceURI, [in] string qualifiedName, [in] XDocumentType doctype)
  52         raises (DOMException);
  53
  54     /**
  55     Creates an empty DocumentType node.
  56     Throws:
  57     DOMException - INVALID_CHARACTER_ERR: Raised if the specified qualified name contains an illegal character.
  58                    NAMESPACE_ERR: Raised if the qualifiedName is malformed.
  59                    NOT_SUPPORTED_ERR: May be raised by DOM implementations which do not support the
  60                       "XML" feature, if they choose not to support this method. Other features introduced
  61                       in the future, by the DOM WG or in extensions defined by other groups, may also demand
  62                       support for this method; please consult the definition of the feature to see if it
  63                       requires this method.
  64     */
  65     XDocumentType createDocumentType([in] string qualifiedName, [in] string publicId, [in] string systemId)
  66         raises (DOMException);
  67
  68     /**
  69     Test if the DOM implementation implements a specific feature.
  70     */
  71     boolean hasFeature([in] string feature, [in] string ver);
  72 };
  73
  74 }; }; }; }; };
  75
  76 #endif
  77
  78 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */