offapi/com/sun/star/packages/PackageStream.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
  22 module com {  module sun {  module star {   module packages {
  23
  24
  25 /**This service represents a stream contained within a Package. Instances of
  26 this class can only be constructed by the implementation of the Package
  27 service.
  28 */
  29 published service PackageStream
  30 {
  31     /**
  32     This sets or gets the name of the Stream as contained within its parent
  33     PackageFolder.
  34     */
  35     interface com::sun::star::container::XNamed;
  36     /**
  37     getParent returns the PackageFolder that the PackageStream is in. This
  38     may be the root PackageFolder. setParent moves a PackageStream.
  39     */
  40     interface com::sun::star::container::XChild;
  41     /**
  42     getInputStream provides read access to the contents of this PackageStream.
  43     If this PackageStream was a member of the Package when it was instantiated,
  44     the XInputStream returned is a Reference to the stream of the whole Package,
  45     with limits set on where it can seek to and read from. If the PackageStream
  46     is a new addition to the package, then getInputStream returns a Reference
  47     to the XInputStream which was specified with setInputStream.
  48
  49     setInputStream - provides a stream to the data contained in the PackageStream
  50     this must be specified for new PackageStreams added to the Package. If this
  51     is called more than once, it will replace the existing stream.
  52     */
  53     interface com::sun::star::io::XActiveDataSink;
  54     /**
  55     This interface provides access to the properties of the package entry.
  56     Currently, this supports three entries:
  57
  58     1. Size, describing the uncompressed size of PackageStream.
  59     2. MediaType, a string describing the MIME type of the stream.
  60     3. Compress, a boolean flag to specify whether or not to compress
  61        this PackageStream.
  62     */
  63     interface com::sun::star::beans::XPropertySet;
  64 };
  65 }; }; }; };
  66
  67 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */