1*d1766043SAndrew Rist/************************************************************** 2cdf0e10cSrcweir * 3*d1766043SAndrew Rist * Licensed to the Apache Software Foundation (ASF) under one 4*d1766043SAndrew Rist * or more contributor license agreements. See the NOTICE file 5*d1766043SAndrew Rist * distributed with this work for additional information 6*d1766043SAndrew Rist * regarding copyright ownership. The ASF licenses this file 7*d1766043SAndrew Rist * to you under the Apache License, Version 2.0 (the 8*d1766043SAndrew Rist * "License"); you may not use this file except in compliance 9*d1766043SAndrew Rist * with the License. You may obtain a copy of the License at 10*d1766043SAndrew Rist * 11*d1766043SAndrew Rist * http://www.apache.org/licenses/LICENSE-2.0 12*d1766043SAndrew Rist * 13*d1766043SAndrew Rist * Unless required by applicable law or agreed to in writing, 14*d1766043SAndrew Rist * software distributed under the License is distributed on an 15*d1766043SAndrew Rist * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 16*d1766043SAndrew Rist * KIND, either express or implied. See the License for the 17*d1766043SAndrew Rist * specific language governing permissions and limitations 18*d1766043SAndrew Rist * under the License. 19*d1766043SAndrew Rist * 20*d1766043SAndrew Rist *************************************************************/ 21*d1766043SAndrew Rist 22*d1766043SAndrew Rist 23cdf0e10cSrcweir#ifndef __com_sun_star_document_XBinaryStreamResolver_idl__ 24cdf0e10cSrcweir#define __com_sun_star_document_XBinaryStreamResolver_idl__ 25cdf0e10cSrcweir 26cdf0e10cSrcweir#ifndef __com_sun_star_uno_XInterface_idl__ 27cdf0e10cSrcweir#include <com/sun/star/uno/XInterface.idl> 28cdf0e10cSrcweir#endif 29cdf0e10cSrcweir#ifndef __com_sun_star_io_XInputStream_idl__ 30cdf0e10cSrcweir#include <com/sun/star/io/XInputStream.idl> 31cdf0e10cSrcweir#endif 32cdf0e10cSrcweir#ifndef __com_sun_star_io_XOututStream_idl__ 33cdf0e10cSrcweir#include <com/sun/star/io/XOutputStream.idl> 34cdf0e10cSrcweir#endif 35cdf0e10cSrcweir 36cdf0e10cSrcweir//============================================================================= 37cdf0e10cSrcweir 38cdf0e10cSrcweirmodule com { module sun { module star { module document { 39cdf0e10cSrcweir 40cdf0e10cSrcweir//============================================================================= 41cdf0e10cSrcweir 42cdf0e10cSrcweir/** 43cdf0e10cSrcweir <p>This interface encapsulates functionality to get/resolve binary data streams. 44cdf0e10cSrcweir It is used to transform binary data to an url or to transform an url to binary 45cdf0e10cSrcweir data. The binary data is represented through input and output streams.</p> 46cdf0e10cSrcweir 47cdf0e10cSrcweir <p>In the case of transforming an url to binary data, the <code>getInputStream</code> 48cdf0e10cSrcweir method is used. This returns a <type scope="com::sun::star::io">XInputStream</type> 49cdf0e10cSrcweir from which the binary data, transformed from the given url, can be read.</p> 50cdf0e10cSrcweir 51cdf0e10cSrcweir <p>In the case of transforming binary data to an url, a 52cdf0e10cSrcweir <type scope="com::sun::star::io">XOutputStream</type> is created first to write 53cdf0e10cSrcweir the binary data to. After this, the <code>resolveOutputStream</code> method can 54cdf0e10cSrcweir be used to transform the binary data, represented through the 55cdf0e10cSrcweir <type scope="com::sun::star::io">XOutputStream</type> interface, to an url.</p> 56cdf0e10cSrcweir */ 57cdf0e10cSrcweirpublished interface XBinaryStreamResolver: com::sun::star::uno::XInterface 58cdf0e10cSrcweir{ 59cdf0e10cSrcweir /** converts the given URL from the source URL namespace to an input stream, 60cdf0e10cSrcweir from which binary data can be read 61cdf0e10cSrcweir */ 62cdf0e10cSrcweir com::sun::star::io::XInputStream getInputStream( [in] string aURL ); 63cdf0e10cSrcweir 64cdf0e10cSrcweir /** creates an output stream, to which binary data can be written. 65cdf0e10cSrcweir After writing, an URL can be retrieved by a call to 66cdf0e10cSrcweir <method>XBinaryStreamResolver::resolveOutputStream</method>. 67cdf0e10cSrcweir */ 68cdf0e10cSrcweir com::sun::star::io::XOutputStream createOutputStream(); 69cdf0e10cSrcweir 70cdf0e10cSrcweir /** converts the output stream, data has been written to, to an URL in 71cdf0e10cSrcweir source URL namespace. 72cdf0e10cSrcweir */ 73cdf0e10cSrcweir string resolveOutputStream( [in] com::sun::star::io::XOutputStream aBinaryStream ); 74cdf0e10cSrcweir}; 75cdf0e10cSrcweir 76cdf0e10cSrcweir//============================================================================= 77cdf0e10cSrcweir 78cdf0e10cSrcweir}; }; }; }; 79cdf0e10cSrcweir 80cdf0e10cSrcweir#endif 81