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