diff options
Diffstat (limited to 'udkapi/com/sun/star/io/XTextOutputStream.idl')
-rw-r--r-- | udkapi/com/sun/star/io/XTextOutputStream.idl | 82 |
1 files changed, 0 insertions, 82 deletions
diff --git a/udkapi/com/sun/star/io/XTextOutputStream.idl b/udkapi/com/sun/star/io/XTextOutputStream.idl deleted file mode 100644 index 3ec30be2f..000000000 --- a/udkapi/com/sun/star/io/XTextOutputStream.idl +++ /dev/null @@ -1,82 +0,0 @@ -/************************************************************************* - * - * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * - * Copyright 2000, 2010 Oracle and/or its affiliates. - * - * OpenOffice.org - a multi-platform office productivity suite - * - * This file is part of OpenOffice.org. - * - * OpenOffice.org is free software: you can redistribute it and/or modify - * it under the terms of the GNU Lesser General Public License version 3 - * only, as published by the Free Software Foundation. - * - * OpenOffice.org 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 version 3 for more details - * (a copy is included in the LICENSE file that accompanied this code). - * - * You should have received a copy of the GNU Lesser General Public License - * version 3 along with OpenOffice.org. If not, see - * <http://www.openoffice.org/license.html> - * for a copy of the LGPLv3 License. - * - ************************************************************************/ -#ifndef __com_sun_star_io_XTextOutputStream_idl__ -#define __com_sun_star_io_XTextOutputStream_idl__ - -#include <com/sun/star/io/XOutputStream.idl> - -#include <com/sun/star/io/IOException.idl> - - -//============================================================================= - -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 |