udkapi/com/sun/star/io/XDataInputStream.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: XDataInputStream.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_XDataInputStream_idl__
  31 #define __com_sun_star_io_XDataInputStream_idl__
  32
  33 #ifndef __com_sun_star_io_XInputStream_idl__
  34 #include <com/sun/star/io/XInputStream.idl>
  35 #endif
  36
  37 #ifndef __com_sun_star_io_IOException_idl__
  38 #include <com/sun/star/io/IOException.idl>
  39 #endif
  40
  41
  42 //=============================================================================
  43
  44 module com {  module sun {  module star {  module io {
  45
  46 //=============================================================================
  47
  48 // DocMerge from xml: interface com::sun::star::io::XDataInputStream
  49 /** makes it possible to read machine-independent simple data types from a
  50     stream.
  51     @see com::sun::star::io::XDataOutputStream
  52  */
  53 published interface XDataInputStream: com::sun::star::io::XInputStream
  54 {
  55     //-------------------------------------------------------------------------
  56
  57     // DocMerge from xml: method com::sun::star::io::XDataInputStream::readBoolean
  58     /** reads in a boolean. It is an 8-bit value. 0 means FALSE; all
  59         other values mean TRUE.
  60      */
  61     byte readBoolean()
  62             raises( com::sun::star::io::IOException );
  63
  64     //-------------------------------------------------------------------------
  65
  66     // DocMerge from xml: method com::sun::star::io::XDataInputStream::readByte
  67     /** reads an 8-bit byte.
  68      */
  69     byte readByte()
  70             raises( com::sun::star::io::IOException );
  71
  72     //-------------------------------------------------------------------------
  73
  74     // DocMerge from xml: method com::sun::star::io::XDataInputStream::readChar
  75     /** reads a 16-bit unicode character.
  76      */
  77     char readChar()
  78             raises( com::sun::star::io::IOException );
  79
  80     //-------------------------------------------------------------------------
  81
  82     // DocMerge from xml: method com::sun::star::io::XDataInputStream::readShort
  83     /** reads a 16-bit big endian integer.
  84      */
  85     short readShort()
  86             raises( com::sun::star::io::IOException );
  87
  88     //-------------------------------------------------------------------------
  89
  90     // DocMerge from xml: method com::sun::star::io::XDataInputStream::readLong
  91     /** reads a 32-bit big endian integer.
  92      */
  93     long readLong()
  94             raises( com::sun::star::io::IOException );
  95
  96     //-------------------------------------------------------------------------
  97
  98     // DocMerge from xml: method com::sun::star::io::XDataInputStream::readHyper
  99     /** reads a 64-bit big endian integer.
 100      */
 101     hyper readHyper()
 102             raises( com::sun::star::io::IOException );
 103
 104     //-------------------------------------------------------------------------
 105
 106     // DocMerge from xml: method com::sun::star::io::XDataInputStream::readFloat
 107     /** reads a 32-bit IEEE float.
 108      */
 109     float readFloat()
 110             raises( com::sun::star::io::IOException );
 111
 112     //-------------------------------------------------------------------------
 113
 114     // DocMerge from xml: method com::sun::star::io::XDataInputStream::readDouble
 115     /** reads a 64-bit IEEE double.
 116      */
 117     double readDouble()
 118             raises( com::sun::star::io::IOException );
 119
 120     //-------------------------------------------------------------------------
 121
 122     // DocMerge from xml: method com::sun::star::io::XDataInputStream::readUTF
 123     /** reads a string of UTF encoded characters.
 124      */
 125     string readUTF()
 126             raises( com::sun::star::io::IOException );
 127
 128 };
 129
 130 //=============================================================================
 131
 132 }; }; }; };
 133
 134 /*=============================================================================
 135
 136 =============================================================================*/
 137 #endif