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