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

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20 module com { module sun { module star { module xml { module crypto { module sax {
  21
  22 /**
  23  * Manipulate the "key SAX events" in a SAX event stream.
  24  */
  25 interface XElementStackKeeper : com::sun::star::uno::XInterface
  26 {
  27     /**
  28      * Starts to buffer key SAX events.
  29      */
  30     void start();
  31
  32     /**
  33      * Stops buffering key SAX events.
  34      */
  35     void stop();
  36
  37     /**
  38      * Transfers the buffered key SAX events to a document handler.
  39      * <p>
  40      * All transferred events are removed from the buffer.
  41      *
  42      * @param handler                the document to receive key SAX events
  43      * @param includingTheLastEvent  whether to transfer the last key SAX event
  44      */
  45     void retrieve( [in] com::sun::star::xml::sax::XDocumentHandler handler, [in] boolean includingTheLastEvent);
  46 };
  47
  48 } ; } ; } ; } ; } ; } ;
  49
  50 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */