offapi/com/sun/star/document/XBinaryStreamResolver.idl

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20
  21 module com {  module sun {  module star {  module document {
  22
  23
  24 /**
  25     <p>This interface encapsulates functionality to get/resolve binary data streams.
  26     It is used to transform binary data to a URL or to transform a URL to binary
  27     data. The binary data is represented through input and output streams.</p>
  28
  29     <p>In the case of transforming a URL to binary data, the <code>getInputStream</code>
  30     method is used. This returns a com::sun::star::io::XInputStream
  31     from which the binary data, transformed from the given URL, can be read.</p>
  32
  33     <p>In the case of transforming binary data to a URL, a
  34     com::sun::star::io::XOutputStream is created first to write
  35     the binary data to. After this, the <code>resolveOutputStream</code> method can
  36     be used to transform the binary data, represented through the
  37     com::sun::star::io::XOutputStream interface, to a URL.</p>
  38  */
  39 published interface XBinaryStreamResolver: com::sun::star::uno::XInterface
  40 {
  41     /** converts the given URL from the source URL namespace to an input stream,
  42         from which binary data can be read
  43     */
  44     com::sun::star::io::XInputStream getInputStream( [in] string aURL );
  45
  46     /** creates an output stream, to which binary data can be written.
  47         After writing, a URL can be retrieved by a call to
  48         XBinaryStreamResolver::resolveOutputStream().
  49     */
  50     com::sun::star::io::XOutputStream createOutputStream();
  51
  52     /** converts the output stream, data has been written to, to a URL in
  53         source URL namespace.
  54     */
  55     string resolveOutputStream( [in] com::sun::star::io::XOutputStream aBinaryStream );
  56 };
  57
  58
  59 }; }; }; };
  60
  61 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */