xref: /AOO41X/main/udkapi/com/sun/star/io/XDataInputStream.idl (revision 408a4873fc8bcc602c90ea4598886bb71abf0675) 
1/**************************************************************
2 *
3 * Licensed to the Apache Software Foundation (ASF) under one
4 * or more contributor license agreements.  See the NOTICE file
5 * distributed with this work for additional information
6 * regarding copyright ownership.  The ASF licenses this file
7 * to you under the Apache License, Version 2.0 (the
8 * "License"); you may not use this file except in compliance
9 * with the License.  You may obtain a copy of the License at
10 *
11 *   http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing,
14 * software distributed under the License is distributed on an
15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16 * KIND, either express or implied.  See the License for the
17 * specific language governing permissions and limitations
18 * under the License.
19 *
20 *************************************************************/
21
22
23#ifndef __com_sun_star_io_XDataInputStream_idl__
24#define __com_sun_star_io_XDataInputStream_idl__
25
26#ifndef __com_sun_star_io_XInputStream_idl__
27#include <com/sun/star/io/XInputStream.idl>
28#endif
29
30#ifndef __com_sun_star_io_IOException_idl__
31#include <com/sun/star/io/IOException.idl>
32#endif
33
34
35//=============================================================================
36
37module com {  module sun {  module star {  module io {
38
39//=============================================================================
40
41// DocMerge from xml: interface com::sun::star::io::XDataInputStream
42/** makes it possible to read machine-independent simple data types from a
43    stream.
44    @see com::sun::star::io::XDataOutputStream
45 */
46published interface XDataInputStream: com::sun::star::io::XInputStream
47{
48    //-------------------------------------------------------------------------
49
50    // DocMerge from xml: method com::sun::star::io::XDataInputStream::readBoolean
51    /** reads in a boolean. It is an 8-bit value. 0 means FALSE; all
52        other values mean TRUE.
53     */
54    byte readBoolean()
55            raises( com::sun::star::io::IOException );
56
57    //-------------------------------------------------------------------------
58
59    // DocMerge from xml: method com::sun::star::io::XDataInputStream::readByte
60    /** reads an 8-bit byte.
61     */
62    byte readByte()
63            raises( com::sun::star::io::IOException );
64
65    //-------------------------------------------------------------------------
66
67    // DocMerge from xml: method com::sun::star::io::XDataInputStream::readChar
68    /** reads a 16-bit unicode character.
69     */
70    char readChar()
71            raises( com::sun::star::io::IOException );
72
73    //-------------------------------------------------------------------------
74
75    // DocMerge from xml: method com::sun::star::io::XDataInputStream::readShort
76    /** reads a 16-bit big endian integer.
77     */
78    short readShort()
79            raises( com::sun::star::io::IOException );
80
81    //-------------------------------------------------------------------------
82
83    // DocMerge from xml: method com::sun::star::io::XDataInputStream::readLong
84    /** reads a 32-bit big endian integer.
85     */
86    long readLong()
87            raises( com::sun::star::io::IOException );
88
89    //-------------------------------------------------------------------------
90
91    // DocMerge from xml: method com::sun::star::io::XDataInputStream::readHyper
92    /** reads a 64-bit big endian integer.
93     */
94    hyper readHyper()
95            raises( com::sun::star::io::IOException );
96
97    //-------------------------------------------------------------------------
98
99    // DocMerge from xml: method com::sun::star::io::XDataInputStream::readFloat
100    /** reads a 32-bit IEEE float.
101     */
102    float readFloat()
103            raises( com::sun::star::io::IOException );
104
105    //-------------------------------------------------------------------------
106
107    // DocMerge from xml: method com::sun::star::io::XDataInputStream::readDouble
108    /** reads a 64-bit IEEE double.
109     */
110    double readDouble()
111            raises( com::sun::star::io::IOException );
112
113    //-------------------------------------------------------------------------
114
115    // DocMerge from xml: method com::sun::star::io::XDataInputStream::readUTF
116    /** reads a string of UTF encoded characters.
117     */
118    string readUTF()
119            raises( com::sun::star::io::IOException );
120
121};
122
123//=============================================================================
124
125}; }; }; };
126
127/*=============================================================================
128
129=============================================================================*/
130#endif
131