summaryrefslogtreecommitdiffstats
path: root/offapi/com/sun/star/xml/sax/XDocumentHandler.idl
blob: 9c5f7dc6b74bd7b5054778f0e07a10e229097ea2 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
 * This file is part of the LibreOffice project.
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
 *
 * This file incorporates work covered by the following license notice:
 *
 *   Licensed to the Apache Software Foundation (ASF) under one or more
 *   contributor license agreements. See the NOTICE file distributed
 *   with this work for additional information regarding copyright
 *   ownership. The ASF licenses this file to you under the Apache
 *   License, Version 2.0 (the "License"); you may not use this file
 *   except in compliance with the License. You may obtain a copy of
 *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
 */
#ifndef __com_sun_star_xml_sax_XDocumentHandler_idl__
#define __com_sun_star_xml_sax_XDocumentHandler_idl__

#include <com/sun/star/uno/XInterface.idl>

#include <com/sun/star/xml/sax/SAXException.idl>

#include <com/sun/star/xml/sax/XAttributeList.idl>

#include <com/sun/star/xml/sax/XLocator.idl>



module com {  module sun {  module star {  module xml {  module sax {


/** receives notification of general document events.

    <p>This interface is an IDL version of the Java interface
    <em>org.xml.sax.DocumentHandler</em> with some smaller
    adaptations.</p>
 */
published interface XDocumentHandler: com::sun::star::uno::XInterface
{

    /** receives notification of the beginning of a document.
     */
    void startDocument()
            raises( com::sun::star::xml::sax::SAXException );


    /** receives notification of the end of a document.
     */
    void endDocument()
            raises( com::sun::star::xml::sax::SAXException );


    /** receives notification of the beginning of an element .
     */
    void startElement( [in] string aName,
             [in] com::sun::star::xml::sax::XAttributeList xAttribs )
            raises( com::sun::star::xml::sax::SAXException );


    /** receives notification of the end of an element.
     */
    void endElement( [in] string aName )
            raises( com::sun::star::xml::sax::SAXException );


    /** receives notification of character data.
     */
    void characters( [in] string aChars )
            raises( com::sun::star::xml::sax::SAXException );


    /** receives notification of white space that can be ignored.
     */
    void ignorableWhitespace( [in] string aWhitespaces )
            raises( com::sun::star::xml::sax::SAXException );


    /** receives notification of a processing instruction.
     */
    void processingInstruction( [in] string aTarget,
             [in] string aData )
            raises( com::sun::star::xml::sax::SAXException );


    /** receives an object for locating the origin of SAX document events.
     */
    void setDocumentLocator( [in] com::sun::star::xml::sax::XLocator xLocator )
            raises( com::sun::star::xml::sax::SAXException );

};


}; }; }; }; };

#endif

/* vim:set shiftwidth=4 softtabstop=4 expandtab: */