xref: /trunk/main/udkapi/com/sun/star/io/XDataOutputStream.idl (revision cdf0e10c4e3984b49a9502b011690b615761d4a3) 
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_XDataOutputStream_idl__
28#define __com_sun_star_io_XDataOutputStream_idl__
29
30#ifndef __com_sun_star_io_XOutputStream_idl__
31#include <com/sun/star/io/XOutputStream.idl>
32#endif
33
34#ifndef __com_sun_star_io_IOException_idl__
35#include <com/sun/star/io/IOException.idl>
36#endif
37
38
39//=============================================================================
40
41module com {  module sun {  module star {  module io {
42
43//=============================================================================
44
45// DocMerge from xml: interface com::sun::star::io::XDataOutputStream
46/** makes it possible to write machine-independent simple data types to a
47    stream.
48    @see com::sun::star::io::XDataInputStream
49 */
50published interface XDataOutputStream: com::sun::star::io::XOutputStream
51{
52    //-------------------------------------------------------------------------
53
54    // DocMerge from xml: method com::sun::star::io::XDataOutputStream::writeBoolean
55    /** writes a boolean. It is an 8-bit value. 0 means FALSE; all other
56        values mean TRUE.
57     */
58    void writeBoolean( [in] boolean Value )
59            raises( com::sun::star::io::IOException );
60
61    //-------------------------------------------------------------------------
62
63    // DocMerge from xml: method com::sun::star::io::XDataOutputStream::writeByte
64    /** writes an 8-bit byte.
65     */
66    void writeByte( [in] byte Value )
67            raises( com::sun::star::io::IOException );
68
69    //-------------------------------------------------------------------------
70
71    // DocMerge from xml: method com::sun::star::io::XDataOutputStream::writeChar
72    /** writes a 16-bit character.
73     */
74    void writeChar( [in] char Value )
75            raises( com::sun::star::io::IOException );
76
77    //-------------------------------------------------------------------------
78
79    // DocMerge from xml: method com::sun::star::io::XDataOutputStream::writeShort
80    /** writes a 16-bit big endian integer.
81     */
82    void writeShort( [in] short Value )
83            raises( com::sun::star::io::IOException );
84
85    //-------------------------------------------------------------------------
86
87    // DocMerge from xml: method com::sun::star::io::XDataOutputStream::writeLong
88    /** writes a 32-bit big endian integer.
89     */
90    void writeLong( [in] long Value )
91            raises( com::sun::star::io::IOException );
92
93    //-------------------------------------------------------------------------
94
95    // DocMerge from xml: method com::sun::star::io::XDataOutputStream::writeHyper
96    /** writes a 64-bit big endian integer.
97     */
98    void writeHyper( [in] hyper Value )
99            raises( com::sun::star::io::IOException );
100
101    //-------------------------------------------------------------------------
102
103    // DocMerge from xml: method com::sun::star::io::XDataOutputStream::writeFloat
104    /** writes a 32-bit IEEE float.
105     */
106    void writeFloat( [in] float Value )
107            raises( com::sun::star::io::IOException );
108
109    //-------------------------------------------------------------------------
110
111    // DocMerge from xml: method com::sun::star::io::XDataOutputStream::writeDouble
112    /** writes a 64-bit IEEE double.
113     */
114    void writeDouble( [in] double Value )
115            raises( com::sun::star::io::IOException );
116
117    //-------------------------------------------------------------------------
118
119    // DocMerge from xml: method com::sun::star::io::XDataOutputStream::writeUTF
120    /** writes a string in UTF format.
121     */
122    void writeUTF( [in] string Value )
123            raises( com::sun::star::io::IOException );
124
125};
126
127//=============================================================================
128
129}; }; }; };
130
131/*=============================================================================
132
133=============================================================================*/
134#endif
135