offapi/com/sun/star/xml/input/XRoot.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 #ifndef __com_sun_star_xml_input_XRoot_idl__
  20 #define __com_sun_star_xml_input_XRoot_idl__
  21
  22 #include <com/sun/star/xml/input/XNamespaceMapping.idl>
  23 #include <com/sun/star/xml/input/XElement.idl>
  24 #include <com/sun/star/xml/input/XAttributes.idl>
  25 #include <com/sun/star/xml/sax/SAXException.idl>
  26 #include <com/sun/star/xml/sax/XLocator.idl>
  27
  28
  29 module com { module sun { module star { module xml { module input {
  30
  31 /** Root interface being passed to SaxDocumentHandler service upon
  32     instantiation.
  33
  34     @internal
  35 */
  36 interface XRoot : com::sun::star::uno::XInterface
  37 {
  38     /** Receives notification of the beginning of a document.
  39
  40          @param xMapping
  41                 mapping to obtain ids out of XML namespace URIs
  42                 and vice versa
  43     */
  44     void startDocument(
  45         [in] XNamespaceMapping xMapping )
  46         raises (com::sun::star::xml::sax::SAXException);
  47
  48     /** Receives notification of the end of a document.
  49      */
  50     void endDocument()
  51         raises (com::sun::star::xml::sax::SAXException);
  52
  53     /** Receives notification of a processing instruction.
  54
  55         @param target
  56                target
  57         @param data
  58                data
  59     */
  60     void processingInstruction(
  61         [in] string target, [in] string data )
  62         raises (com::sun::star::xml::sax::SAXException);
  63
  64     /** Receives an object for locating the origin of SAX document events.
  65
  66         @param locator
  67                locator
  68     */
  69     void setDocumentLocator(
  70         [in] com::sun::star::xml::sax::XLocator locator )
  71         raises (com::sun::star::xml::sax::SAXException);
  72
  73     /** Called upon root element.
  74
  75          @param uid
  76                 namespace uid of element
  77          @param localName
  78                 local name of element
  79          @param xAttributes
  80                 attributes of element
  81      */
  82     XElement startRootElement(
  83         [in] long uid, [in] string localName, [in] XAttributes xAttributes )
  84         raises (com::sun::star::xml::sax::SAXException);
  85 };
  86
  87 }; }; }; }; };
  88
  89 #endif
  90
  91 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */