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