1/*************************************************************************
2 *
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * Copyright 2000, 2010 Oracle and/or its affiliates.
6 *
7 * OpenOffice.org - a multi-platform office productivity suite
8 *
9 * This file is part of OpenOffice.org.
10 *
11 * OpenOffice.org is free software: you can redistribute it and/or modify
12 * it under the terms of the GNU Lesser General Public License version 3
13 * only, as published by the Free Software Foundation.
14 *
15 * OpenOffice.org is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18 * GNU Lesser General Public License version 3 for more details
19 * (a copy is included in the LICENSE file that accompanied this code).
20 *
21 * You should have received a copy of the GNU Lesser General Public License
22 * version 3 along with OpenOffice.org.  If not, see
23 * <http://www.openoffice.org/license.html>
24 * for a copy of the LGPLv3 License.
25 *
26 ************************************************************************/
27
28//i20156 - new file for xmlsecurity module
29
30/** -- idl definition -- **/
31
32#ifndef __com_sun_star_xml_crypto_sax_xelementstackkeeper_idl_
33#define __com_sun_star_xml_crypto_sax_xelementstackkeeper_idl_
34
35#include <com/sun/star/uno/XInterface.idl>
36#include <com/sun/star/uno/Exception.idl>
37#include <com/sun/star/xml/sax/XDocumentHandler.idl>
38
39module com { module sun { module star { module xml { module crypto { module sax {
40
41/**
42 * A struct to keep a startElement/endElement SAX event.
43 */
44struct ElementStackItem
45{
46	/**
47	 * whether it is a startElement event
48	 */
49	boolean isStartElementEvent;
50
51	/**
52	 * the name of the element
53	 */
54	string elementName;
55
56	/**
57	 * attribute list for a startElement event
58	 */
59	com::sun::star::xml::sax::XAttributeList xAttributes;
60};
61
62/**
63 * Manipulate the "key SAX events" in a SAX event stream.
64 *
65 * @see   XSecController
66 */
67interface XElementStackKeeper : com::sun::star::uno::XInterface
68{
69	/**
70	 * Starts to buffer key SAX events.
71	 */
72	void start();
73
74	/**
75	 * Stops buffering key SAX events.
76	 */
77	void stop();
78
79	/**
80	 * Transfers the bufferred key SAX events to a document handler.
81	 * <p>
82	 * All transferred events are removed from the buffer.
83	 *
84	 * @param handler                the document to receive key SAX events
85	 * @param includingTheLastEvent  whether to transfer the last key SAX event
86	 */
87	void retrieve( [in] com::sun::star::xml::sax::XDocumentHandler handler, [in] boolean includingTheLastEvent);
88};
89
90} ; } ; } ; } ; } ; } ;
91
92
93#endif
94
95