udkapi/com/sun/star/io/MarkableInputStream.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 #ifndef __com_sun_star_io_MarkableInputStream_idl__
  20 #define __com_sun_star_io_MarkableInputStream_idl__
  21
  22 #include <com/sun/star/io/XMarkableStream.idl>
  23
  24 #include <com/sun/star/io/XActiveDataSink.idl>
  25
  26 #include <com/sun/star/io/XConnectable.idl>
  27
  28
  29 module com {  module sun {  module star {  module io {
  30
  31 /** allows to set marks in an inputstream and to later jump back to these
  32     marks.
  33     <p>The implementation reads the original data from the input stream,
  34     that has been set previously at the XActiveDataSink
  35     interface. In general the implementation must buffer the data. </p>
  36  */
  37 published service MarkableInputStream
  38 {
  39     /** allows to access the data of this stream
  40      */
  41     interface com::sun::star::io::XInputStream;
  42
  43     /** allows to create marks at the current position
  44         and to set the current position.
  45      */
  46     interface com::sun::star::io::XMarkableStream;
  47
  48     /** allows to access to the underlying source
  49         of this stream.
  50      */
  51     interface com::sun::star::io::XActiveDataSink;
  52
  53     /** allows to navigate via a chain of streams */
  54     interface com::sun::star::io::XConnectable;
  55
  56 };
  57
  58
  59 }; }; }; };
  60
  61
  62
  63 #endif
  64
  65 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */