offapi/com/sun/star/xml/crypto/sax/XElementStackKeeper.idl

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