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