offapi/com/sun/star/packages/PackageStream.idl

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: PackageStream.idl,v $
  10  * $Revision: 1.5 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30 #ifndef __com_sun_star_packages_PackageStream_idl__
  31 #define __com_sun_star_packages_PackageStream_idl__
  32
  33
  34 #ifndef __com_sun_star_container_XNamed_idl__
  35 #include <com/sun/star/container/XNamed.idl>
  36 #endif
  37
  38 #ifndef __com_sun_star_container_XChild_idl__
  39 #include <com/sun/star/container/XChild.idl>
  40 #endif
  41
  42 #ifndef __com_sun_star_beans_XPropertySet_idl__
  43 #include <com/sun/star/beans/XPropertySet.idl>
  44 #endif
  45
  46 #ifndef __com_sun_star_io_XActiveDataSink_idl__
  47 #include <com/sun/star/io/XActiveDataSink.idl>
  48 #endif
  49
  50 //=============================================================================
  51
  52 module com {  module sun {  module star {   module packages {
  53
  54 //=============================================================================
  55
  56 /**This service represents a stream contained within a Package. Instances of
  57 this class can only be constructed by the implementation of the Package
  58 service.
  59 */
  60 published service PackageStream
  61 {
  62     /**
  63     This sets or gets the name of the Stream as contained within its parent
  64     PackageFolder.
  65     */
  66     interface com::sun::star::container::XNamed;
  67     /**
  68     getParent returns the PackageFolder that the PackageStream is in. This
  69     may be the root PackageFolder. setParent moves a PackageStream.
  70     */
  71     interface com::sun::star::container::XChild;
  72     /**
  73     getInputStream provides read access to the contents of this PackageStream.
  74     If this PackageStream was a member of the Package when it was instantiated,
  75     the XInputStream returned is a Reference to the stream of the whole Package,
  76     with limits set on where it can seek to and read from. If the PackageStream
  77     is a new addition to the package, then getInputStream returns a Reference
  78     to the XInputStream which was specified with setInputStream.
  79
  80     setInputStream - provides a stream to the data contained in the PackageStream
  81     this must be specified for new PackageStreams added to the Package. If this
  82     is called more than once, it will replace the existing stream.
  83     */
  84     interface com::sun::star::io::XActiveDataSink;
  85     /**
  86     This interface provides access to the properties of the package entry.
  87     Currently, this supports three entries:
  88
  89     1. Size, describing the uncompressed size of PackageStream.
  90     2. MediaType, a string describing the MIME type of the stream.
  91     3. Compress, a boolean flag to specify whether or not to compress
  92        this PackageStream.
  93     */
  94     interface com::sun::star::beans::XPropertySet;
  95 };
  96 }; }; }; };
  97
  98 #endif