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