summaryrefslogtreecommitdiff
path: root/offapi/com/sun/star/xml/crypto/sax/XElementStackKeeper.idl
blob: 4d7764d2cdd70d7936520e8c1c67a3e776ce4f47 (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
/*************************************************************************
 *
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * Copyright 2008 by Sun Microsystems, Inc.
 *
 * OpenOffice.org - a multi-platform office productivity suite
 *
 * $RCSfile: XElementStackKeeper.idl,v $
 * $Revision: 1.5 $
 *
 * This file is part of OpenOffice.org.
 *
 * OpenOffice.org is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License version 3
 * only, as published by the Free Software Foundation.
 *
 * OpenOffice.org is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License version 3 for more details
 * (a copy is included in the LICENSE file that accompanied this code).
 *
 * You should have received a copy of the GNU Lesser General Public License
 * version 3 along with OpenOffice.org.  If not, see
 * <http://www.openoffice.org/license.html>
 * for a copy of the LGPLv3 License.
 *
 ************************************************************************/

//i20156 - new file for xmlsecurity module

/** -- idl definition -- **/

#ifndef __com_sun_star_xml_crypto_sax_xelementstackkeeper_idl_
#define __com_sun_star_xml_crypto_sax_xelementstackkeeper_idl_

#include <com/sun/star/uno/XInterface.idl>
#include <com/sun/star/uno/Exception.idl>
#include <com/sun/star/xml/sax/XDocumentHandler.idl>

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

/**
 * A struct to keep a startElement/endElement SAX event.
 */
struct ElementStackItem
{
    /**
     * whether it is a startElement event
     */
    boolean isStartElementEvent;

    /**
     * the name of the element
     */
    string elementName;

    /**
     * attribute list for a startElement event
     */
    com::sun::star::xml::sax::XAttributeList xAttributes;
};

/**
 * Manipulate the "key SAX events" in a SAX event stream.
 *
 * @see   XSecController
 */
interface XElementStackKeeper : com::sun::star::uno::XInterface
{
    /**
     * Starts to buffer key SAX events.
     */
    void start();

    /**
     * Stops buffering key SAX events.
     */
    void stop();

    /**
     * Transfers the bufferred key SAX events to a document handler.
     * <p>
     * All transferred events are removed from the buffer.
     *
     * @param handler                the document to receive key SAX events
     * @param includingTheLastEvent  whether to transfer the last key SAX event
     */
    void retrieve( [in] com::sun::star::xml::sax::XDocumentHandler handler, [in] boolean includingTheLastEvent);
};

} ; } ; } ; } ; } ; } ;


#endif