xref: /aoo4110/main/offapi/com/sun/star/xml/input/XRoot.idl (revision b1cdbd2c)
1*b1cdbd2cSJim Jagielski/**************************************************************
2*b1cdbd2cSJim Jagielski *
3*b1cdbd2cSJim Jagielski * Licensed to the Apache Software Foundation (ASF) under one
4*b1cdbd2cSJim Jagielski * or more contributor license agreements.  See the NOTICE file
5*b1cdbd2cSJim Jagielski * distributed with this work for additional information
6*b1cdbd2cSJim Jagielski * regarding copyright ownership.  The ASF licenses this file
7*b1cdbd2cSJim Jagielski * to you under the Apache License, Version 2.0 (the
8*b1cdbd2cSJim Jagielski * "License"); you may not use this file except in compliance
9*b1cdbd2cSJim Jagielski * with the License.  You may obtain a copy of the License at
10*b1cdbd2cSJim Jagielski *
11*b1cdbd2cSJim Jagielski *   http://www.apache.org/licenses/LICENSE-2.0
12*b1cdbd2cSJim Jagielski *
13*b1cdbd2cSJim Jagielski * Unless required by applicable law or agreed to in writing,
14*b1cdbd2cSJim Jagielski * software distributed under the License is distributed on an
15*b1cdbd2cSJim Jagielski * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16*b1cdbd2cSJim Jagielski * KIND, either express or implied.  See the License for the
17*b1cdbd2cSJim Jagielski * specific language governing permissions and limitations
18*b1cdbd2cSJim Jagielski * under the License.
19*b1cdbd2cSJim Jagielski *
20*b1cdbd2cSJim Jagielski *************************************************************/
21*b1cdbd2cSJim Jagielski
22*b1cdbd2cSJim Jagielski
23*b1cdbd2cSJim Jagielski#if ! defined INCLUDED__com_sun_star_xml_input_XRoot_idl__
24*b1cdbd2cSJim Jagielski#define INCLUDED__com_sun_star_xml_input_XRoot_idl__
25*b1cdbd2cSJim Jagielski
26*b1cdbd2cSJim Jagielski#include <com/sun/star/xml/input/XNamespaceMapping.idl>
27*b1cdbd2cSJim Jagielski#include <com/sun/star/xml/input/XElement.idl>
28*b1cdbd2cSJim Jagielski#include <com/sun/star/xml/input/XAttributes.idl>
29*b1cdbd2cSJim Jagielski#include <com/sun/star/xml/sax/SAXException.idl>
30*b1cdbd2cSJim Jagielski#include <com/sun/star/xml/sax/XLocator.idl>
31*b1cdbd2cSJim Jagielski
32*b1cdbd2cSJim Jagielski
33*b1cdbd2cSJim Jagielskimodule com { module sun { module star { module xml { module input {
34*b1cdbd2cSJim Jagielski
35*b1cdbd2cSJim Jagielski/** Root interface being passed to SaxDocumentHandler service upon
36*b1cdbd2cSJim Jagielski    instantiation.
37*b1cdbd2cSJim Jagielski
38*b1cdbd2cSJim Jagielski    @internal
39*b1cdbd2cSJim Jagielski*/
40*b1cdbd2cSJim Jagielskiinterface XRoot : com::sun::star::uno::XInterface
41*b1cdbd2cSJim Jagielski{
42*b1cdbd2cSJim Jagielski    /** Receives notification of the beginning of a document.
43*b1cdbd2cSJim Jagielski
44*b1cdbd2cSJim Jagielski         @param xMapping
45*b1cdbd2cSJim Jagielski                mapping to obtain ids out of XML namespace URIs
46*b1cdbd2cSJim Jagielski                and vice versa
47*b1cdbd2cSJim Jagielski    */
48*b1cdbd2cSJim Jagielski    void startDocument(
49*b1cdbd2cSJim Jagielski        [in] XNamespaceMapping xMapping )
50*b1cdbd2cSJim Jagielski        raises (com::sun::star::xml::sax::SAXException);
51*b1cdbd2cSJim Jagielski
52*b1cdbd2cSJim Jagielski    /** Receives notification of the end of a document.
53*b1cdbd2cSJim Jagielski     */
54*b1cdbd2cSJim Jagielski    void endDocument()
55*b1cdbd2cSJim Jagielski        raises (com::sun::star::xml::sax::SAXException);
56*b1cdbd2cSJim Jagielski
57*b1cdbd2cSJim Jagielski    /** Receives notification of a processing instruction.
58*b1cdbd2cSJim Jagielski
59*b1cdbd2cSJim Jagielski        @param target
60*b1cdbd2cSJim Jagielski               target
61*b1cdbd2cSJim Jagielski        @param data
62*b1cdbd2cSJim Jagielski               data
63*b1cdbd2cSJim Jagielski    */
64*b1cdbd2cSJim Jagielski    void processingInstruction(
65*b1cdbd2cSJim Jagielski        [in] string target, [in] string data )
66*b1cdbd2cSJim Jagielski        raises (com::sun::star::xml::sax::SAXException);
67*b1cdbd2cSJim Jagielski
68*b1cdbd2cSJim Jagielski    /** Receives an object for locating the origin of SAX document events.
69*b1cdbd2cSJim Jagielski
70*b1cdbd2cSJim Jagielski        @param locator
71*b1cdbd2cSJim Jagielski               locator
72*b1cdbd2cSJim Jagielski    */
73*b1cdbd2cSJim Jagielski    void setDocumentLocator(
74*b1cdbd2cSJim Jagielski        [in] com::sun::star::xml::sax::XLocator locator )
75*b1cdbd2cSJim Jagielski        raises (com::sun::star::xml::sax::SAXException);
76*b1cdbd2cSJim Jagielski
77*b1cdbd2cSJim Jagielski    /** Called upon root element.
78*b1cdbd2cSJim Jagielski
79*b1cdbd2cSJim Jagielski         @param uid
80*b1cdbd2cSJim Jagielski                namespace uid of element
81*b1cdbd2cSJim Jagielski         @param localName
82*b1cdbd2cSJim Jagielski                localname of element
83*b1cdbd2cSJim Jagielski         @param xAattributes
84*b1cdbd2cSJim Jagielski                attributes of element
85*b1cdbd2cSJim Jagielski     */
86*b1cdbd2cSJim Jagielski    XElement startRootElement(
87*b1cdbd2cSJim Jagielski        [in] long uid, [in] string localName, [in] XAttributes xAttributes )
88*b1cdbd2cSJim Jagielski        raises (com::sun::star::xml::sax::SAXException);
89*b1cdbd2cSJim Jagielski};
90*b1cdbd2cSJim Jagielski
91*b1cdbd2cSJim Jagielski}; }; }; }; };
92*b1cdbd2cSJim Jagielski
93*b1cdbd2cSJim Jagielski#endif
94