/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
* This file is part of the LibreOffice project.
*
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at
http://mozilla.org/MPL/2.0/.
*
* This file incorporates work covered by the following license notice:
*
* 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 .
*/
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
setEncoding(). Default encoding is "utf8".</p>
*/
published interface XTextOutputStream: com::sun::star::io::XOutputStream
{
/** writes a string to the stream using the encoding
defined by setEncoding().
<p>Line breaks or delimiters that may be necessary
to support XTextInputStream::readLine()
and XTextInputStream::readString()
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 );
};
}; }; }; };
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
