diff options
Diffstat (limited to 'offapi/com/sun/star/document/XBinaryStreamResolver.idl')
-rw-r--r-- | offapi/com/sun/star/document/XBinaryStreamResolver.idl | 50 |
1 files changed, 25 insertions, 25 deletions
diff --git a/offapi/com/sun/star/document/XBinaryStreamResolver.idl b/offapi/com/sun/star/document/XBinaryStreamResolver.idl index 5b754eba3670..4c9a9e1cfeb3 100644 --- a/offapi/com/sun/star/document/XBinaryStreamResolver.idl +++ b/offapi/com/sun/star/document/XBinaryStreamResolver.idl @@ -1,7 +1,7 @@ /************************************************************************* * * 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 @@ -37,48 +37,48 @@ #include <com/sun/star/io/XOutputStream.idl> #endif -//============================================================================= - -module com { module sun { module star { module document { - -//============================================================================= - -/** +//============================================================================= + +module com { module sun { module star { module document { + +//============================================================================= + +/** <p>This interface encapsulates functionality to get/resolve binary data streams. It is used to transform binary data to an URL or to transform an URL to binary - data. The binary data is represented through input and output streams.</p> - + data. The binary data is represented through input and output streams.</p> + <p>In the case of transforming an URL to binary data, the <code>getInputStream</code> - method is used. This returns a <type scope="com::sun::star::io">XInputStream</type> + method is used. This returns a <type scope="com::sun::star::io">XInputStream</type> from which the binary data, transformed from the given URL, can be read.</p> - + <p>In the case of transforming binary data to an URL, a - <type scope="com::sun::star::io">XOutputStream</type> is created first to write - the binary data to. After this, the <code>resolveOutputStream</code> method can - be used to transform the binary data, represented through the + <type scope="com::sun::star::io">XOutputStream</type> is created first to write + the binary data to. After this, the <code>resolveOutputStream</code> method can + be used to transform the binary data, represented through the <type scope="com::sun::star::io">XOutputStream</type> interface, to an URL.</p> */ published interface XBinaryStreamResolver: com::sun::star::uno::XInterface -{ +{ /** converts the given URL from the source URL namespace to an input stream, from which binary data can be read */ com::sun::star::io::XInputStream getInputStream( [in] string aURL ); /** creates an output stream, to which binary data can be written. - After writing, an URL can be retrieved by a call to + After writing, an URL can be retrieved by a call to <method>XBinaryStreamResolver::resolveOutputStream</method>. */ com::sun::star::io::XOutputStream createOutputStream(); - /** converts the output stream, data has been written to, to an URL in + /** converts the output stream, data has been written to, to an URL in source URL namespace. */ string resolveOutputStream( [in] com::sun::star::io::XOutputStream aBinaryStream ); -}; - -//============================================================================= - -}; }; }; }; - -#endif +}; + +//============================================================================= + +}; }; }; }; + +#endif |