1/************************************************************************* 2 * 3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. 4 * 5 * Copyright 2000, 2010 Oracle and/or its affiliates. 6 * 7 * OpenOffice.org - a multi-platform office productivity suite 8 * 9 * This file is part of OpenOffice.org. 10 * 11 * OpenOffice.org is free software: you can redistribute it and/or modify 12 * it under the terms of the GNU Lesser General Public License version 3 13 * only, as published by the Free Software Foundation. 14 * 15 * OpenOffice.org is distributed in the hope that it will be useful, 16 * but WITHOUT ANY WARRANTY; without even the implied warranty of 17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 18 * GNU Lesser General Public License version 3 for more details 19 * (a copy is included in the LICENSE file that accompanied this code). 20 * 21 * You should have received a copy of the GNU Lesser General Public License 22 * version 3 along with OpenOffice.org. If not, see 23 * <http://www.openoffice.org/license.html> 24 * for a copy of the LGPLv3 License. 25 * 26 ************************************************************************/ 27#ifndef __com_sun_star_io_XSeekable_idl__ 28#define __com_sun_star_io_XSeekable_idl__ 29 30#ifndef __com_sun_star_uno_XInterface_idl__ 31#include <com/sun/star/uno/XInterface.idl> 32#endif 33 34#ifndef __com_sun_star_io_IOException_idl__ 35#include <com/sun/star/io/IOException.idl> 36#endif 37#ifndef __com_sun_star_lang_IllegalArgumentException_idl__ 38#include <com/sun/star/lang/IllegalArgumentException.idl> 39#endif 40 41//============================================================================= 42 43module com { module sun { module star { module io { 44 45//============================================================================= 46 47// DocMerge from xml: interface com::sun::star::io::XSeekable 48/** makes it possible to seek to a certain position within a stream. 49 50 <p>This interface should be supported, if it is possible to access the 51 data at the new position quickly. 52 You should not support this interface, if you have a continuous 53 stream, for example, a video stream. 54 */ 55published interface XSeekable: com::sun::star::uno::XInterface 56{ 57 58 // DocMerge from xml: method com::sun::star::io::XSeekable::seek 59 /** changes the seek pointer to a new location relative to the beginning of the stream. 60 61 62 <p> This method changes the seek pointer so subsequent reads and writes can take place at a different 63 location in the stream object. It is an error to seek before the beginning of the stream or after the 64 end of the stream. </p> 65 66 @throws com::sun::star::lang::IllegalArgumentException in case location is negative or greater than <member>XSeekable::getLength</member>. 67 */ 68 void seek( [in] hyper location ) 69 raises( com::sun::star::lang::IllegalArgumentException, com::sun::star::io::IOException ); 70 71 72 // DocMerge from xml: method com::sun::star::io::XSeekable::getPosition 73 /** returns the current offset of the stream. 74 @returns 75 the current offset in this stream. 76 */ 77 hyper getPosition() 78 raises( com::sun::star::io::IOException ); 79 80 81 // DocMerge from xml: method com::sun::star::io::XSeekable::getLength 82 /** returns the length of the stream. 83 @returns 84 the length of the storage medium on which the stream works. 85 */ 86 hyper getLength() 87 raises( com::sun::star::io::IOException ); 88}; 89 90//============================================================================= 91 92}; }; }; }; 93#endif 94