udkapi/com/sun/star/io/XTextOutputStream.idl

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: XTextOutputStream.idl,v $
  10  * $Revision: 1.11 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30 #ifndef __com_sun_star_io_XTextOutputStream_idl__
  31 #define __com_sun_star_io_XTextOutputStream_idl__
  32
  33 #ifndef __com_sun_star_io_XOutputStream_idl__
  34 #include <com/sun/star/io/XOutputStream.idl>
  35 #endif
  36
  37 #ifndef __com_sun_star_io_IOException_idl__
  38 #include <com/sun/star/io/IOException.idl>
  39 #endif
  40
  41
  42 //=============================================================================
  43
  44 module com {  module sun {  module star {  module io {
  45
  46 //=============================================================================
  47 /** Interface to write strings to a stream using a special
  48     character encoding.
  49
  50     <p>This interfaces allows to write strings to a stream.
  51     The character encoding to be used can be set by <member>
  52     setEncoding()</member>. Default encoding is "utf8".</p>
  53  */
  54 published interface XTextOutputStream: com::sun::star::io::XOutputStream
  55 {
  56     //-------------------------------------------------------------------------
  57     /** writes a string to the stream using the encoding
  58         defined by <member>setEncoding</member>.
  59
  60         <p>Line breaks or delimiters that may be neccessary
  61         to support <member>XTextInputStream::readLine</member>
  62         and <member>XTextInputStream::readString</member>
  63         have to be added manually to the parameter string.</p>
  64
  65         @see setEncoding
  66         @see XTextInputStream::readLine
  67         @see XTextInputStream::readString
  68      */
  69     void writeString( [in] string aString )
  70             raises( com::sun::star::io::IOException );
  71
  72     //-------------------------------------------------------------------------
  73     /** sets character encoding.
  74
  75         @param Encoding
  76             sets the character encoding that should be used.
  77             The character encoding names refer to the document
  78             http://www.iana.org/assignments/character-sets.
  79             Which character sets are supported depends on
  80             the implementation.
  81      */
  82     void setEncoding( [in] string Encoding );
  83 };
  84
  85 //=============================================================================
  86
  87 }; }; }; };
  88
  89 #endif