udkapi/com/sun/star/io/MarkableOutputStream.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: MarkableOutputStream.idl,v $
  10  * $Revision: 1.9 $
  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 #ifndef __com_sun_star_io_DataInputStream_idl__
  31 #define __com_sun_star_io_DataInputStream_idl__
  32
  33 #ifndef __com_sun_star_io_XMarkableStream_idl__
  34 #include <com/sun/star/io/XMarkableStream.idl>
  35 #endif
  36
  37 #ifndef __com_sun_star_io_XActiveDataSink_idl__
  38 #include <com/sun/star/io/XActiveDataSource.idl>
  39 #endif
  40
  41 #ifndef __com_sun_star_io_XConnectable_idl__
  42 #include <com/sun/star/io/XConnectable.idl>
  43 #endif
  44
  45
  46 module com {  module sun {  module star {  module io {
  47
  48 //==========================================================================
  49 /** allows to set marks in an outputstream and to later jump back to these
  50     marks.
  51     <p>The implementation stores the data as long as marks exists
  52     and later writes these data into the output stream,
  53     that has been set previously at the <type>XActiveDataSource</type>
  54     interface. </p>
  55  */
  56 published service MarkableOutputStream
  57 {
  58     /** allows to write data at the current position.
  59         <p> Flushing the outputstream will only flush data,
  60             which was written before the first non-deleted mark,
  61             because data after the first non-deleted mark
  62             may be modified by later jumpToMark()/writeBytes() calls.
  63      */
  64     interface com::sun::star::io::XOutputStream;
  65
  66     /** allows to create marks at the current position
  67         and to set the current position.
  68      */
  69     interface com::sun::star::io::XMarkableStream;
  70
  71     /** allows to access to the underlying sink
  72         of this stream.
  73      */
  74     interface com::sun::star::io::XActiveDataSource;
  75
  76     /** allows to navigate via a chain of streams */
  77     interface com::sun::star::io::XConnectable;
  78
  79 };
  80
  81
  82 }; }; }; };
  83
  84
  85
  86 #endif