/*************************************************************************
 *
 *  OpenOffice.org - a multi-platform office productivity suite
 *
 *  $RCSfile: XTextOutputStream.idl,v $
 *
 *  $Revision: 1.10 $
 *
 *  last change: $Author: rt $ $Date: 2005-09-09 15:35:45 $
 *
 *  The Contents of this file are made available subject to
 *  the terms of GNU Lesser General Public License Version 2.1.
 *
 *
 *    GNU Lesser General Public License Version 2.1
 *    =============================================
 *    Copyright 2005 by Sun Microsystems, Inc.
 *    901 San Antonio Road, Palo Alto, CA 94303, USA
 *
 *    This library is free software; you can redistribute it and/or
 *    modify it under the terms of the GNU Lesser General Public
 *    License version 2.1, as published by the Free Software Foundation.
 *
 *    This library is distributed in the hope that it will be useful,
 *    but WITHOUT ANY WARRANTY; without even the implied warranty of
 *    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 *    Lesser General Public License for more details.
 *
 *    You should have received a copy of the GNU Lesser General Public
 *    License along with this library; if not, write to the Free Software
 *    Foundation, Inc., 59 Temple Place, Suite 330, Boston,
 *    MA  02111-1307  USA
 *
 ************************************************************************/
#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
