offapi/com/sun/star/xml/input/XRoot.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: XRoot.idl,v $
  10  * $Revision: 1.6 $
  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 #if ! defined INCLUDED__com_sun_star_xml_input_XRoot_idl__
  31 #define INCLUDED__com_sun_star_xml_input_XRoot_idl__
  32
  33 #include <com/sun/star/xml/input/XNamespaceMapping.idl>
  34 #include <com/sun/star/xml/input/XElement.idl>
  35 #include <com/sun/star/xml/input/XAttributes.idl>
  36 #include <com/sun/star/xml/sax/SAXException.idl>
  37 #include <com/sun/star/xml/sax/XLocator.idl>
  38
  39
  40 module com { module sun { module star { module xml { module input {
  41
  42 /** Root interface being passed to SaxDocumentHandler service upon
  43     instantiation.
  44
  45     @internal
  46 */
  47 interface XRoot : com::sun::star::uno::XInterface
  48 {
  49     /** Receives notification of the beginning of a document.
  50
  51          @param xMapping
  52                 mapping to obtain ids out of XML namespace URIs
  53                 and vice versa
  54     */
  55     void startDocument(
  56         [in] XNamespaceMapping xMapping )
  57         raises (com::sun::star::xml::sax::SAXException);
  58
  59     /** Receives notification of the end of a document.
  60      */
  61     void endDocument()
  62         raises (com::sun::star::xml::sax::SAXException);
  63
  64     /** Receives notification of a processing instruction.
  65
  66         @param target
  67                target
  68         @param data
  69                data
  70     */
  71     void processingInstruction(
  72         [in] string target, [in] string data )
  73         raises (com::sun::star::xml::sax::SAXException);
  74
  75     /** Receives an object for locating the origin of SAX document events.
  76
  77         @param locator
  78                locator
  79     */
  80     void setDocumentLocator(
  81         [in] com::sun::star::xml::sax::XLocator locator )
  82         raises (com::sun::star::xml::sax::SAXException);
  83
  84     /** Called upon root element.
  85
  86          @param uid
  87                 namespace uid of element
  88          @param localName
  89                 localname of element
  90          @param xAattributes
  91                 attributes of element
  92      */
  93     XElement startRootElement(
  94         [in] long uid, [in] string localName, [in] XAttributes xAttributes )
  95         raises (com::sun::star::xml::sax::SAXException);
  96 };
  97
  98 }; }; }; }; };
  99
 100 #endif