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