xref: /trunk/main/offapi/com/sun/star/xml/input/XRoot.idl (revision cdf0e10c) 
1/*************************************************************************
2 *
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * Copyright 2000, 2010 Oracle and/or its affiliates.
6 *
7 * OpenOffice.org - a multi-platform office productivity suite
8 *
9 * This file is part of OpenOffice.org.
10 *
11 * OpenOffice.org is free software: you can redistribute it and/or modify
12 * it under the terms of the GNU Lesser General Public License version 3
13 * only, as published by the Free Software Foundation.
14 *
15 * OpenOffice.org is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18 * GNU Lesser General Public License version 3 for more details
19 * (a copy is included in the LICENSE file that accompanied this code).
20 *
21 * You should have received a copy of the GNU Lesser General Public License
22 * version 3 along with OpenOffice.org.  If not, see
23 * <http://www.openoffice.org/license.html>
24 * for a copy of the LGPLv3 License.
25 *
26 ************************************************************************/
27#if ! defined INCLUDED__com_sun_star_xml_input_XRoot_idl__
28#define INCLUDED__com_sun_star_xml_input_XRoot_idl__
29
30#include <com/sun/star/xml/input/XNamespaceMapping.idl>
31#include <com/sun/star/xml/input/XElement.idl>
32#include <com/sun/star/xml/input/XAttributes.idl>
33#include <com/sun/star/xml/sax/SAXException.idl>
34#include <com/sun/star/xml/sax/XLocator.idl>
35
36
37module com { module sun { module star { module xml { module input {
38
39/** Root interface being passed to SaxDocumentHandler service upon
40    instantiation.
41
42    @internal
43*/
44interface XRoot : com::sun::star::uno::XInterface
45{
46    /** Receives notification of the beginning of a document.
47
48         @param xMapping
49                mapping to obtain ids out of XML namespace URIs
50                and vice versa
51    */
52    void startDocument(
53        [in] XNamespaceMapping xMapping )
54        raises (com::sun::star::xml::sax::SAXException);
55
56    /** Receives notification of the end of a document.
57     */
58    void endDocument()
59        raises (com::sun::star::xml::sax::SAXException);
60
61    /** Receives notification of a processing instruction.
62
63        @param target
64               target
65        @param data
66               data
67    */
68    void processingInstruction(
69        [in] string target, [in] string data )
70        raises (com::sun::star::xml::sax::SAXException);
71
72    /** Receives an object for locating the origin of SAX document events.
73
74        @param locator
75               locator
76    */
77    void setDocumentLocator(
78        [in] com::sun::star::xml::sax::XLocator locator )
79        raises (com::sun::star::xml::sax::SAXException);
80
81    /** Called upon root element.
82
83         @param uid
84                namespace uid of element
85         @param localName
86                localname of element
87         @param xAattributes
88                attributes of element
89     */
90    XElement startRootElement(
91        [in] long uid, [in] string localName, [in] XAttributes xAttributes )
92        raises (com::sun::star::xml::sax::SAXException);
93};
94
95}; }; }; }; };
96
97#endif
98