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_XSeekable_idl__ 24*b1cdbd2cSJim Jagielski#define __com_sun_star_io_XSeekable_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#ifndef __com_sun_star_lang_IllegalArgumentException_idl__ 34*b1cdbd2cSJim Jagielski#include <com/sun/star/lang/IllegalArgumentException.idl> 35*b1cdbd2cSJim Jagielski#endif 36*b1cdbd2cSJim Jagielski 37*b1cdbd2cSJim Jagielski//============================================================================= 38*b1cdbd2cSJim Jagielski 39*b1cdbd2cSJim Jagielskimodule com { module sun { module star { module io { 40*b1cdbd2cSJim Jagielski 41*b1cdbd2cSJim Jagielski//============================================================================= 42*b1cdbd2cSJim Jagielski 43*b1cdbd2cSJim Jagielski// DocMerge from xml: interface com::sun::star::io::XSeekable 44*b1cdbd2cSJim Jagielski/** makes it possible to seek to a certain position within a stream. 45*b1cdbd2cSJim Jagielski 46*b1cdbd2cSJim Jagielski <p>This interface should be supported, if it is possible to access the 47*b1cdbd2cSJim Jagielski data at the new position quickly. 48*b1cdbd2cSJim Jagielski You should not support this interface, if you have a continuous 49*b1cdbd2cSJim Jagielski stream, for example, a video stream. 50*b1cdbd2cSJim Jagielski */ 51*b1cdbd2cSJim Jagielskipublished interface XSeekable: com::sun::star::uno::XInterface 52*b1cdbd2cSJim Jagielski{ 53*b1cdbd2cSJim Jagielski 54*b1cdbd2cSJim Jagielski // DocMerge from xml: method com::sun::star::io::XSeekable::seek 55*b1cdbd2cSJim Jagielski /** changes the seek pointer to a new location relative to the beginning of the stream. 56*b1cdbd2cSJim Jagielski 57*b1cdbd2cSJim Jagielski 58*b1cdbd2cSJim Jagielski <p> This method changes the seek pointer so subsequent reads and writes can take place at a different 59*b1cdbd2cSJim Jagielski location in the stream object. It is an error to seek before the beginning of the stream or after the 60*b1cdbd2cSJim Jagielski end of the stream. </p> 61*b1cdbd2cSJim Jagielski 62*b1cdbd2cSJim Jagielski @throws com::sun::star::lang::IllegalArgumentException in case location is negative or greater than <member>XSeekable::getLength</member>. 63*b1cdbd2cSJim Jagielski */ 64*b1cdbd2cSJim Jagielski void seek( [in] hyper location ) 65*b1cdbd2cSJim Jagielski raises( com::sun::star::lang::IllegalArgumentException, com::sun::star::io::IOException ); 66*b1cdbd2cSJim Jagielski 67*b1cdbd2cSJim Jagielski 68*b1cdbd2cSJim Jagielski // DocMerge from xml: method com::sun::star::io::XSeekable::getPosition 69*b1cdbd2cSJim Jagielski /** returns the current offset of the stream. 70*b1cdbd2cSJim Jagielski @returns 71*b1cdbd2cSJim Jagielski the current offset in this stream. 72*b1cdbd2cSJim Jagielski */ 73*b1cdbd2cSJim Jagielski hyper getPosition() 74*b1cdbd2cSJim Jagielski raises( com::sun::star::io::IOException ); 75*b1cdbd2cSJim Jagielski 76*b1cdbd2cSJim Jagielski 77*b1cdbd2cSJim Jagielski // DocMerge from xml: method com::sun::star::io::XSeekable::getLength 78*b1cdbd2cSJim Jagielski /** returns the length of the stream. 79*b1cdbd2cSJim Jagielski @returns 80*b1cdbd2cSJim Jagielski the length of the storage medium on which the stream works. 81*b1cdbd2cSJim Jagielski */ 82*b1cdbd2cSJim Jagielski hyper getLength() 83*b1cdbd2cSJim Jagielski raises( com::sun::star::io::IOException ); 84*b1cdbd2cSJim Jagielski}; 85*b1cdbd2cSJim Jagielski 86*b1cdbd2cSJim Jagielski//============================================================================= 87*b1cdbd2cSJim Jagielski 88*b1cdbd2cSJim Jagielski}; }; }; }; 89*b1cdbd2cSJim Jagielski#endif 90