1*b1cdbd2cSJim Jagielski/**************************************************************
2*b1cdbd2cSJim Jagielski *
3*b1cdbd2cSJim Jagielski * Licensed to the Apache Software Foundation (ASF) under one
4*b1cdbd2cSJim Jagielski * or more contributor license agreements.  See the NOTICE file
5*b1cdbd2cSJim Jagielski * distributed with this work for additional information
6*b1cdbd2cSJim Jagielski * regarding copyright ownership.  The ASF licenses this file
7*b1cdbd2cSJim Jagielski * to you under the Apache License, Version 2.0 (the
8*b1cdbd2cSJim Jagielski * "License"); you may not use this file except in compliance
9*b1cdbd2cSJim Jagielski * with the License.  You may obtain a copy of the License at
10*b1cdbd2cSJim Jagielski *
11*b1cdbd2cSJim Jagielski *   http://www.apache.org/licenses/LICENSE-2.0
12*b1cdbd2cSJim Jagielski *
13*b1cdbd2cSJim Jagielski * Unless required by applicable law or agreed to in writing,
14*b1cdbd2cSJim Jagielski * software distributed under the License is distributed on an
15*b1cdbd2cSJim Jagielski * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16*b1cdbd2cSJim Jagielski * KIND, either express or implied.  See the License for the
17*b1cdbd2cSJim Jagielski * specific language governing permissions and limitations
18*b1cdbd2cSJim Jagielski * under the License.
19*b1cdbd2cSJim Jagielski *
20*b1cdbd2cSJim Jagielski *************************************************************/
21*b1cdbd2cSJim Jagielski
22*b1cdbd2cSJim Jagielski
23*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_io_XTextOutputStream_idl__
24*b1cdbd2cSJim Jagielski#define __com_sun_star_io_XTextOutputStream_idl__
25*b1cdbd2cSJim Jagielski
26*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_io_XOutputStream_idl__
27*b1cdbd2cSJim Jagielski#include <com/sun/star/io/XOutputStream.idl>
28*b1cdbd2cSJim Jagielski#endif
29*b1cdbd2cSJim Jagielski
30*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_io_IOException_idl__
31*b1cdbd2cSJim Jagielski#include <com/sun/star/io/IOException.idl>
32*b1cdbd2cSJim Jagielski#endif
33*b1cdbd2cSJim Jagielski
34*b1cdbd2cSJim Jagielski
35*b1cdbd2cSJim Jagielski//=============================================================================
36*b1cdbd2cSJim Jagielski
37*b1cdbd2cSJim Jagielskimodule com {  module sun {  module star {  module io {
38*b1cdbd2cSJim Jagielski
39*b1cdbd2cSJim Jagielski//=============================================================================
40*b1cdbd2cSJim Jagielski/** Interface to write strings to a stream using a special
41*b1cdbd2cSJim Jagielski	character encoding.
42*b1cdbd2cSJim Jagielski
43*b1cdbd2cSJim Jagielski	<p>This interfaces allows to write strings to a stream.
44*b1cdbd2cSJim Jagielski	The character encoding to be used can be set by <member>
45*b1cdbd2cSJim Jagielski	setEncoding()</member>. Default encoding is "utf8".</p>
46*b1cdbd2cSJim Jagielski */
47*b1cdbd2cSJim Jagielskipublished interface XTextOutputStream: com::sun::star::io::XOutputStream
48*b1cdbd2cSJim Jagielski{
49*b1cdbd2cSJim Jagielski	//-------------------------------------------------------------------------
50*b1cdbd2cSJim Jagielski	/** writes a string to the stream using the encoding
51*b1cdbd2cSJim Jagielski		defined by <member>setEncoding</member>.
52*b1cdbd2cSJim Jagielski
53*b1cdbd2cSJim Jagielski		<p>Line breaks or delimiters that may be neccessary
54*b1cdbd2cSJim Jagielski		to support <member>XTextInputStream::readLine</member>
55*b1cdbd2cSJim Jagielski		and <member>XTextInputStream::readString</member>
56*b1cdbd2cSJim Jagielski		have to be added manually to the parameter string.</p>
57*b1cdbd2cSJim Jagielski
58*b1cdbd2cSJim Jagielski		@see setEncoding
59*b1cdbd2cSJim Jagielski		@see XTextInputStream::readLine
60*b1cdbd2cSJim Jagielski		@see XTextInputStream::readString
61*b1cdbd2cSJim Jagielski	 */
62*b1cdbd2cSJim Jagielski	void writeString( [in] string aString )
63*b1cdbd2cSJim Jagielski			raises( com::sun::star::io::IOException );
64*b1cdbd2cSJim Jagielski
65*b1cdbd2cSJim Jagielski	//-------------------------------------------------------------------------
66*b1cdbd2cSJim Jagielski	/** sets character encoding.
67*b1cdbd2cSJim Jagielski
68*b1cdbd2cSJim Jagielski		@param Encoding
69*b1cdbd2cSJim Jagielski			sets the character encoding that should be used.
70*b1cdbd2cSJim Jagielski			The character encoding names refer to the document
71*b1cdbd2cSJim Jagielski			http://www.iana.org/assignments/character-sets.
72*b1cdbd2cSJim Jagielski			Which character sets are supported depends on
73*b1cdbd2cSJim Jagielski			the implementation.
74*b1cdbd2cSJim Jagielski	 */
75*b1cdbd2cSJim Jagielski	void setEncoding( [in] string Encoding );
76*b1cdbd2cSJim Jagielski};
77*b1cdbd2cSJim Jagielski
78*b1cdbd2cSJim Jagielski//=============================================================================
79*b1cdbd2cSJim Jagielski
80*b1cdbd2cSJim Jagielski}; }; }; };
81*b1cdbd2cSJim Jagielski
82*b1cdbd2cSJim Jagielski#endif
83