1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61
|
/* -*- 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 document {
/**
<p>This interface encapsulates functionality to get/resolve binary data streams.
It is used to transform binary data to a URL or to transform a URL to binary
data. The binary data is represented through input and output streams.</p>
<p>In the case of transforming a URL to binary data, the <code>getInputStream</code>
method is used. This returns a com::sun::star::io::XInputStream
from which the binary data, transformed from the given URL, can be read.</p>
<p>In the case of transforming binary data to a URL, a
com::sun::star::io::XOutputStream 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
com::sun::star::io::XOutputStream interface, to a 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, a URL can be retrieved by a call to
XBinaryStreamResolver::resolveOutputStream().
*/
com::sun::star::io::XOutputStream createOutputStream();
/** converts the output stream, data has been written to, to a URL in
source URL namespace.
*/
string resolveOutputStream( [in] com::sun::star::io::XOutputStream aBinaryStream );
};
}; }; }; };
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|