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_XTextOutputStream_idl__
24#define __com_sun_star_io_XTextOutputStream_idl__
25
26#ifndef __com_sun_star_io_XOutputStream_idl__
27#include <com/sun/star/io/XOutputStream.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/** Interface to write strings to a stream using a special
41	character encoding.
42
43	<p>This interfaces allows to write strings to a stream.
44	The character encoding to be used can be set by <member>
45	setEncoding()</member>. Default encoding is "utf8".</p>
46 */
47published interface XTextOutputStream: com::sun::star::io::XOutputStream
48{
49	//-------------------------------------------------------------------------
50	/** writes a string to the stream using the encoding
51		defined by <member>setEncoding</member>.
52
53		<p>Line breaks or delimiters that may be necessary
54		to support <member>XTextInputStream::readLine</member>
55		and <member>XTextInputStream::readString</member>
56		have to be added manually to the parameter string.</p>
57
58		@see setEncoding
59		@see XTextInputStream::readLine
60		@see XTextInputStream::readString
61	 */
62	void writeString( [in] string aString )
63			raises( com::sun::star::io::IOException );
64
65	//-------------------------------------------------------------------------
66	/** sets character encoding.
67
68		@param Encoding
69			sets the character encoding that should be used.
70			The character encoding names refer to the document
71			http://www.iana.org/assignments/character-sets.
72			Which character sets are supported depends on
73			the implementation.
74	 */
75	void setEncoding( [in] string Encoding );
76};
77
78//=============================================================================
79
80}; }; }; };
81
82#endif
83