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

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19 #ifndef __com_sun_star_io_XTextOutputStream_idl__
  20 #define __com_sun_star_io_XTextOutputStream_idl__
  21
  22 #include <com/sun/star/io/XOutputStream.idl>
  23
  24 #include <com/sun/star/io/IOException.idl>
  25
  26
  27
  28 module com {  module sun {  module star {  module io {
  29
  30 /** Interface to write strings to a stream using a special
  31     character encoding.
  32
  33     <p>This interfaces allows to write strings to a stream.
  34     The character encoding to be used can be set by
  35     setEncoding(). Default encoding is "utf8".</p>
  36  */
  37 published interface XTextOutputStream: com::sun::star::io::XOutputStream
  38 {
  39     /** writes a string to the stream using the encoding
  40         defined by setEncoding().
  41
  42         <p>Line breaks or delimiters that may be necessary
  43         to support XTextInputStream::readLine()
  44         and XTextInputStream::readString()
  45         have to be added manually to the parameter string.</p>
  46
  47         @see setEncoding
  48         @see XTextInputStream::readLine
  49         @see XTextInputStream::readString
  50      */
  51     void writeString( [in] string aString )
  52             raises( com::sun::star::io::IOException );
  53
  54     /** sets character encoding.
  55
  56         @param Encoding
  57             sets the character encoding that should be used.
  58             The character encoding names refer to the document
  59             http://www.iana.org/assignments/character-sets.
  60             Which character sets are supported depends on
  61             the implementation.
  62      */
  63     void setEncoding( [in] string Encoding );
  64 };
  65
  66
  67 }; }; }; };
  68
  69 #endif
  70
  71 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */