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