xref: /aoo41x/main/udkapi/com/sun/star/io/XTextOutputStream.idl (revision 408a4873)

/**************************************************************
 *
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 *
 *************************************************************/


#ifndef __com_sun_star_io_XTextOutputStream_idl__
#define __com_sun_star_io_XTextOutputStream_idl__

#ifndef __com_sun_star_io_XOutputStream_idl__
#include <com/sun/star/io/XOutputStream.idl>
#endif

#ifndef __com_sun_star_io_IOException_idl__
#include <com/sun/star/io/IOException.idl>
#endif


//=============================================================================

module com {  module sun {  module star {  module io {

//=============================================================================
/** Interface to write strings to a stream using a special
	character encoding.

	<p>This interfaces allows to write strings to a stream.
	The character encoding to be used can be set by <member>
	setEncoding()</member>. Default encoding is "utf8".</p>
 */
published interface XTextOutputStream: com::sun::star::io::XOutputStream
{
	//-------------------------------------------------------------------------
	/** writes a string to the stream using the encoding
		defined by <member>setEncoding</member>.

		<p>Line breaks or delimiters that may be neccessary
		to support <member>XTextInputStream::readLine</member>
		and <member>XTextInputStream::readString</member>
		have to be added manually to the parameter string.</p>

		@see setEncoding
		@see XTextInputStream::readLine
		@see XTextInputStream::readString
	 */
	void writeString( [in] string aString )
			raises( com::sun::star::io::IOException );

	//-------------------------------------------------------------------------
	/** sets character encoding.

		@param Encoding
			sets the character encoding that should be used.
			The character encoding names refer to the document
			http://www.iana.org/assignments/character-sets.
			Which character sets are supported depends on
			the implementation.
	 */
	void setEncoding( [in] string Encoding );
};

//=============================================================================

}; }; }; };

#endif