/*************************************************************************
 *
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 * 
 * Copyright 2000, 2010 Oracle and/or its affiliates.
 *
 * OpenOffice.org - a multi-platform office productivity suite
 *
 * This file is part of OpenOffice.org.
 *
 * OpenOffice.org is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License version 3
 * only, as published by the Free Software Foundation.
 *
 * OpenOffice.org is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License version 3 for more details
 * (a copy is included in the LICENSE file that accompanied this code).
 *
 * You should have received a copy of the GNU Lesser General Public License
 * version 3 along with OpenOffice.org.  If not, see
 * <http://www.openoffice.org/license.html>
 * for a copy of the LGPLv3 License.
 *
 ************************************************************************/
#if ! defined INCLUDED__com_sun_star_xml_input_XRoot_idl__
#define INCLUDED__com_sun_star_xml_input_XRoot_idl__

#include <com/sun/star/xml/input/XNamespaceMapping.idl>
#include <com/sun/star/xml/input/XElement.idl>
#include <com/sun/star/xml/input/XAttributes.idl>
#include <com/sun/star/xml/sax/SAXException.idl>
#include <com/sun/star/xml/sax/XLocator.idl>


module com { module sun { module star { module xml { module input {

/** Root interface being passed to SaxDocumentHandler service upon
    instantiation.
    
    @internal
*/
interface XRoot : com::sun::star::uno::XInterface
{
    /** Receives notification of the beginning of a document.
         
         @param xMapping
                mapping to obtain ids out of XML namespace URIs
                and vice versa
    */
    void startDocument(
        [in] XNamespaceMapping xMapping )
        raises (com::sun::star::xml::sax::SAXException);
    
    /** Receives notification of the end of a document.
     */
    void endDocument()
        raises (com::sun::star::xml::sax::SAXException);
    
    /** Receives notification of a processing instruction.

        @param target
               target
        @param data
               data
    */
    void processingInstruction(
        [in] string target, [in] string data )
        raises (com::sun::star::xml::sax::SAXException);
    
    /** Receives an object for locating the origin of SAX document events.

        @param locator
               locator
    */
    void setDocumentLocator(
        [in] com::sun::star::xml::sax::XLocator locator )
        raises (com::sun::star::xml::sax::SAXException);

    /** Called upon root element.

         @param uid
                namespace uid of element
         @param localName
                local name of element
         @param xAattributes
                attributes of element
     */
    XElement startRootElement(
        [in] long uid, [in] string localName, [in] XAttributes xAttributes )
        raises (com::sun::star::xml::sax::SAXException);
};

}; }; }; }; };

#endif
