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 24//i20156 - new file for xmlsecurity module 25 26/** -- idl definition -- **/ 27 28#ifndef __com_sun_star_xml_crypto_sax_xelementstackkeeper_idl_ 29#define __com_sun_star_xml_crypto_sax_xelementstackkeeper_idl_ 30 31#include <com/sun/star/uno/XInterface.idl> 32#include <com/sun/star/uno/Exception.idl> 33#include <com/sun/star/xml/sax/XDocumentHandler.idl> 34 35module com { module sun { module star { module xml { module crypto { module sax { 36 37/** 38 * A struct to keep a startElement/endElement SAX event. 39 */ 40struct ElementStackItem 41{ 42 /** 43 * whether it is a startElement event 44 */ 45 boolean isStartElementEvent; 46 47 /** 48 * the name of the element 49 */ 50 string elementName; 51 52 /** 53 * attribute list for a startElement event 54 */ 55 com::sun::star::xml::sax::XAttributeList xAttributes; 56}; 57 58/** 59 * Manipulate the "key SAX events" in a SAX event stream. 60 * 61 * @see XSecController 62 */ 63interface XElementStackKeeper : com::sun::star::uno::XInterface 64{ 65 /** 66 * Starts to buffer key SAX events. 67 */ 68 void start(); 69 70 /** 71 * Stops buffering key SAX events. 72 */ 73 void stop(); 74 75 /** 76 * Transfers the bufferred key SAX events to a document handler. 77 * <p> 78 * All transferred events are removed from the buffer. 79 * 80 * @param handler the document to receive key SAX events 81 * @param includingTheLastEvent whether to transfer the last key SAX event 82 */ 83 void retrieve( [in] com::sun::star::xml::sax::XDocumentHandler handler, [in] boolean includingTheLastEvent); 84}; 85 86} ; } ; } ; } ; } ; } ; 87 88 89#endif 90 91