/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
 * This file is part of the LibreOffice project.
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
 *
 * This file incorporates work covered by the following license notice:
 *
 *   Licensed to the Apache Software Foundation (ASF) under one or more
 *   contributor license agreements. See the NOTICE file distributed
 *   with this work for additional information regarding copyright
 *   ownership. The ASF licenses this file to you under the Apache
 *   License, Version 2.0 (the "License"); you may not use this file
 *   except in compliance with the License. You may obtain a copy of
 *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
 */

//i20156 - new file for XML security 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>
#include <com/sun/star/xml/crypto/sax/ElementStackItem.idl>

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

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

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

    /**
     * Transfers the buffered 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

/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
