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