udkapi/com/sun/star/io/XMarkableStream.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: XMarkableStream.idl,v $
  10  * $Revision: 1.13 $
  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_XMarkableStream_idl__
  31 #define __com_sun_star_io_XMarkableStream_idl__
  32
  33 #ifndef __com_sun_star_uno_XInterface_idl__
  34 #include <com/sun/star/uno/XInterface.idl>
  35 #endif
  36
  37 #ifndef __com_sun_star_io_IOException_idl__
  38 #include <com/sun/star/io/IOException.idl>
  39 #endif
  40
  41 #ifndef __com_sun_star_lang_IllegalArgumentException_idl__
  42 #include <com/sun/star/lang/IllegalArgumentException.idl>
  43 #endif
  44
  45
  46 //=============================================================================
  47
  48 module com {  module sun {  module star {  module io {
  49
  50 //=============================================================================
  51
  52 // DocMerge from xml: interface com::sun::star::io::XMarkableStream
  53 /** makes it possible to set and remove seekable marks to a stream.
  54  */
  55 published interface XMarkableStream: com::sun::star::uno::XInterface
  56 {
  57     //-------------------------------------------------------------------------
  58
  59     // DocMerge from xml: method com::sun::star::io::XMarkableStream::createMark
  60     /** creates a mark of the current postion and returns an identifier to it.
  61      */
  62     long createMark()
  63             raises( com::sun::star::io::IOException );
  64
  65     //-------------------------------------------------------------------------
  66
  67     // DocMerge from xml: method com::sun::star::io::XMarkableStream::deleteMark
  68     /** deletes the mark that you previously created with
  69         <member>XMarkableStream::createMark</member>.
  70
  71         <p>It is an error to delete a mark if other marks after this
  72         exist.  In this case, for reasons of robustness, the
  73         implementation must delete this mark and all others after
  74         this mark.  </p>
  75      */
  76     void deleteMark( [in] long Mark )
  77             raises( com::sun::star::io::IOException,
  78                     com::sun::star::lang::IllegalArgumentException );
  79
  80     //-------------------------------------------------------------------------
  81
  82     // DocMerge from xml: method com::sun::star::io::XMarkableStream::jumpToMark
  83     /** jumps to a previously created mark.
  84      */
  85     void jumpToMark( [in] long nMark )
  86             raises( com::sun::star::io::IOException,
  87                     com::sun::star::lang::IllegalArgumentException );
  88
  89     //-------------------------------------------------------------------------
  90
  91     /** jumps to the furthest position of the stream.
  92         <p> In the inputstream case, a subsequent read call returns
  93         data, that was never read or skipped over before. In the
  94         outputstream case, a subsequent write call will add
  95         new data at the end of the stream without overwriting existing data.
  96      */
  97     void jumpToFurthest()
  98             raises( com::sun::star::io::IOException );
  99
 100     //-------------------------------------------------------------------------
 101
 102     // DocMerge from idl: method com::sun::star::io::XMarkableStream::offsetToMark
 103     /** @returns
 104             the offset from the current stream position to the
 105             mark ("current position" - "mark position").
 106
 107         @param nMark
 108             identifies the mark which is used as a base
 109             to calculate the offset of the current position.
 110
 111         @throws IllegalArgumentException
 112             if the mark does not exist or is deleted.
 113
 114         @throws IOException
 115             if an I/O error has occurred.
 116      */
 117     long offsetToMark( [in] long nMark )
 118             raises( com::sun::star::io::IOException,
 119                     com::sun::star::lang::IllegalArgumentException );
 120
 121 };
 122
 123 //=============================================================================
 124
 125 }; }; }; };
 126
 127 /*=============================================================================
 128
 129 =============================================================================*/
 130 #endif