1*b1cdbd2cSJim Jagielski/************************************************************** 2*b1cdbd2cSJim Jagielski * 3*b1cdbd2cSJim Jagielski * Licensed to the Apache Software Foundation (ASF) under one 4*b1cdbd2cSJim Jagielski * or more contributor license agreements. See the NOTICE file 5*b1cdbd2cSJim Jagielski * distributed with this work for additional information 6*b1cdbd2cSJim Jagielski * regarding copyright ownership. The ASF licenses this file 7*b1cdbd2cSJim Jagielski * to you under the Apache License, Version 2.0 (the 8*b1cdbd2cSJim Jagielski * "License"); you may not use this file except in compliance 9*b1cdbd2cSJim Jagielski * with the License. You may obtain a copy of the License at 10*b1cdbd2cSJim Jagielski * 11*b1cdbd2cSJim Jagielski * http://www.apache.org/licenses/LICENSE-2.0 12*b1cdbd2cSJim Jagielski * 13*b1cdbd2cSJim Jagielski * Unless required by applicable law or agreed to in writing, 14*b1cdbd2cSJim Jagielski * software distributed under the License is distributed on an 15*b1cdbd2cSJim Jagielski * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 16*b1cdbd2cSJim Jagielski * KIND, either express or implied. See the License for the 17*b1cdbd2cSJim Jagielski * specific language governing permissions and limitations 18*b1cdbd2cSJim Jagielski * under the License. 19*b1cdbd2cSJim Jagielski * 20*b1cdbd2cSJim Jagielski *************************************************************/ 21*b1cdbd2cSJim Jagielski 22*b1cdbd2cSJim Jagielski 23*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_io_XMarkableStream_idl__ 24*b1cdbd2cSJim Jagielski#define __com_sun_star_io_XMarkableStream_idl__ 25*b1cdbd2cSJim Jagielski 26*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_uno_XInterface_idl__ 27*b1cdbd2cSJim Jagielski#include <com/sun/star/uno/XInterface.idl> 28*b1cdbd2cSJim Jagielski#endif 29*b1cdbd2cSJim Jagielski 30*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_io_IOException_idl__ 31*b1cdbd2cSJim Jagielski#include <com/sun/star/io/IOException.idl> 32*b1cdbd2cSJim Jagielski#endif 33*b1cdbd2cSJim Jagielski 34*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_lang_IllegalArgumentException_idl__ 35*b1cdbd2cSJim Jagielski#include <com/sun/star/lang/IllegalArgumentException.idl> 36*b1cdbd2cSJim Jagielski#endif 37*b1cdbd2cSJim Jagielski 38*b1cdbd2cSJim Jagielski 39*b1cdbd2cSJim Jagielski//============================================================================= 40*b1cdbd2cSJim Jagielski 41*b1cdbd2cSJim Jagielskimodule com { module sun { module star { module io { 42*b1cdbd2cSJim Jagielski 43*b1cdbd2cSJim Jagielski//============================================================================= 44*b1cdbd2cSJim Jagielski 45*b1cdbd2cSJim Jagielski// DocMerge from xml: interface com::sun::star::io::XMarkableStream 46*b1cdbd2cSJim Jagielski/** makes it possible to set and remove seekable marks to a stream. 47*b1cdbd2cSJim Jagielski */ 48*b1cdbd2cSJim Jagielskipublished interface XMarkableStream: com::sun::star::uno::XInterface 49*b1cdbd2cSJim Jagielski{ 50*b1cdbd2cSJim Jagielski //------------------------------------------------------------------------- 51*b1cdbd2cSJim Jagielski 52*b1cdbd2cSJim Jagielski // DocMerge from xml: method com::sun::star::io::XMarkableStream::createMark 53*b1cdbd2cSJim Jagielski /** creates a mark of the current postion and returns an identifier to it. 54*b1cdbd2cSJim Jagielski */ 55*b1cdbd2cSJim Jagielski long createMark() 56*b1cdbd2cSJim Jagielski raises( com::sun::star::io::IOException ); 57*b1cdbd2cSJim Jagielski 58*b1cdbd2cSJim Jagielski //------------------------------------------------------------------------- 59*b1cdbd2cSJim Jagielski 60*b1cdbd2cSJim Jagielski // DocMerge from xml: method com::sun::star::io::XMarkableStream::deleteMark 61*b1cdbd2cSJim Jagielski /** deletes the mark that you previously created with 62*b1cdbd2cSJim Jagielski <member>XMarkableStream::createMark</member>. 63*b1cdbd2cSJim Jagielski 64*b1cdbd2cSJim Jagielski <p>It is an error to delete a mark if other marks after this 65*b1cdbd2cSJim Jagielski exist. In this case, for reasons of robustness, the 66*b1cdbd2cSJim Jagielski implementation must delete this mark and all others after 67*b1cdbd2cSJim Jagielski this mark. </p> 68*b1cdbd2cSJim Jagielski */ 69*b1cdbd2cSJim Jagielski void deleteMark( [in] long Mark ) 70*b1cdbd2cSJim Jagielski raises( com::sun::star::io::IOException, 71*b1cdbd2cSJim Jagielski com::sun::star::lang::IllegalArgumentException ); 72*b1cdbd2cSJim Jagielski 73*b1cdbd2cSJim Jagielski //------------------------------------------------------------------------- 74*b1cdbd2cSJim Jagielski 75*b1cdbd2cSJim Jagielski // DocMerge from xml: method com::sun::star::io::XMarkableStream::jumpToMark 76*b1cdbd2cSJim Jagielski /** jumps to a previously created mark. 77*b1cdbd2cSJim Jagielski */ 78*b1cdbd2cSJim Jagielski void jumpToMark( [in] long nMark ) 79*b1cdbd2cSJim Jagielski raises( com::sun::star::io::IOException, 80*b1cdbd2cSJim Jagielski com::sun::star::lang::IllegalArgumentException ); 81*b1cdbd2cSJim Jagielski 82*b1cdbd2cSJim Jagielski //------------------------------------------------------------------------- 83*b1cdbd2cSJim Jagielski 84*b1cdbd2cSJim Jagielski /** jumps to the furthest position of the stream. 85*b1cdbd2cSJim Jagielski <p> In the inputstream case, a subsequent read call returns 86*b1cdbd2cSJim Jagielski data, that was never read or skipped over before. In the 87*b1cdbd2cSJim Jagielski outputstream case, a subsequent write call will add 88*b1cdbd2cSJim Jagielski new data at the end of the stream without overwriting existing data. 89*b1cdbd2cSJim Jagielski */ 90*b1cdbd2cSJim Jagielski void jumpToFurthest() 91*b1cdbd2cSJim Jagielski raises( com::sun::star::io::IOException ); 92*b1cdbd2cSJim Jagielski 93*b1cdbd2cSJim Jagielski //------------------------------------------------------------------------- 94*b1cdbd2cSJim Jagielski 95*b1cdbd2cSJim Jagielski // DocMerge from idl: method com::sun::star::io::XMarkableStream::offsetToMark 96*b1cdbd2cSJim Jagielski /** @returns 97*b1cdbd2cSJim Jagielski the offset from the current stream position to the 98*b1cdbd2cSJim Jagielski mark ("current position" - "mark position"). 99*b1cdbd2cSJim Jagielski 100*b1cdbd2cSJim Jagielski @param nMark 101*b1cdbd2cSJim Jagielski identifies the mark which is used as a base 102*b1cdbd2cSJim Jagielski to calculate the offset of the current position. 103*b1cdbd2cSJim Jagielski 104*b1cdbd2cSJim Jagielski @throws IllegalArgumentException 105*b1cdbd2cSJim Jagielski if the mark does not exist or is deleted. 106*b1cdbd2cSJim Jagielski 107*b1cdbd2cSJim Jagielski @throws IOException 108*b1cdbd2cSJim Jagielski if an I/O error has occurred. 109*b1cdbd2cSJim Jagielski */ 110*b1cdbd2cSJim Jagielski long offsetToMark( [in] long nMark ) 111*b1cdbd2cSJim Jagielski raises( com::sun::star::io::IOException, 112*b1cdbd2cSJim Jagielski com::sun::star::lang::IllegalArgumentException ); 113*b1cdbd2cSJim Jagielski 114*b1cdbd2cSJim Jagielski}; 115*b1cdbd2cSJim Jagielski 116*b1cdbd2cSJim Jagielski//============================================================================= 117*b1cdbd2cSJim Jagielski 118*b1cdbd2cSJim Jagielski}; }; }; }; 119*b1cdbd2cSJim Jagielski 120*b1cdbd2cSJim Jagielski/*============================================================================= 121*b1cdbd2cSJim Jagielski 122*b1cdbd2cSJim Jagielski=============================================================================*/ 123*b1cdbd2cSJim Jagielski#endif 124