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_packages_PackageStream_idl__ 24*b1cdbd2cSJim Jagielski#define __com_sun_star_packages_PackageStream_idl__ 25*b1cdbd2cSJim Jagielski 26*b1cdbd2cSJim Jagielski 27*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_container_XNamed_idl__ 28*b1cdbd2cSJim Jagielski#include <com/sun/star/container/XNamed.idl> 29*b1cdbd2cSJim Jagielski#endif 30*b1cdbd2cSJim Jagielski 31*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_container_XChild_idl__ 32*b1cdbd2cSJim Jagielski#include <com/sun/star/container/XChild.idl> 33*b1cdbd2cSJim Jagielski#endif 34*b1cdbd2cSJim Jagielski 35*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_beans_XPropertySet_idl__ 36*b1cdbd2cSJim Jagielski#include <com/sun/star/beans/XPropertySet.idl> 37*b1cdbd2cSJim Jagielski#endif 38*b1cdbd2cSJim Jagielski 39*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_io_XActiveDataSink_idl__ 40*b1cdbd2cSJim Jagielski#include <com/sun/star/io/XActiveDataSink.idl> 41*b1cdbd2cSJim Jagielski#endif 42*b1cdbd2cSJim Jagielski 43*b1cdbd2cSJim Jagielski//============================================================================= 44*b1cdbd2cSJim Jagielski 45*b1cdbd2cSJim Jagielskimodule com { module sun { module star { module packages { 46*b1cdbd2cSJim Jagielski 47*b1cdbd2cSJim Jagielski//============================================================================= 48*b1cdbd2cSJim Jagielski 49*b1cdbd2cSJim Jagielski/**This service represents a stream contained within a Package. Instances of 50*b1cdbd2cSJim Jagielskithis class can only be constructed by the implementation of the Package 51*b1cdbd2cSJim Jagielskiservice. 52*b1cdbd2cSJim Jagielski*/ 53*b1cdbd2cSJim Jagielskipublished service PackageStream 54*b1cdbd2cSJim Jagielski{ 55*b1cdbd2cSJim Jagielski /** 56*b1cdbd2cSJim Jagielski This sets or gets the name of the Stream as contained within its parent 57*b1cdbd2cSJim Jagielski PackageFolder. 58*b1cdbd2cSJim Jagielski */ 59*b1cdbd2cSJim Jagielski interface com::sun::star::container::XNamed; 60*b1cdbd2cSJim Jagielski /** 61*b1cdbd2cSJim Jagielski getParent returns the PackageFolder that the PackageStream is in. This 62*b1cdbd2cSJim Jagielski may be the root PackageFolder. setParent moves a PackageStream. 63*b1cdbd2cSJim Jagielski */ 64*b1cdbd2cSJim Jagielski interface com::sun::star::container::XChild; 65*b1cdbd2cSJim Jagielski /** 66*b1cdbd2cSJim Jagielski getInputStream provides read access to the contents of this PackageStream. 67*b1cdbd2cSJim Jagielski If this PackageStream was a member of the Package when it was instantiated, 68*b1cdbd2cSJim Jagielski the XInputStream returned is a Reference to the stream of the whole Package, 69*b1cdbd2cSJim Jagielski with limits set on where it can seek to and read from. If the PackageStream 70*b1cdbd2cSJim Jagielski is a new addition to the package, then getInputStream returns a Reference 71*b1cdbd2cSJim Jagielski to the XInputStream which was specified with setInputStream. 72*b1cdbd2cSJim Jagielski 73*b1cdbd2cSJim Jagielski setInputStream - provides a stream to the data contained in the PackageStream 74*b1cdbd2cSJim Jagielski this must be specified for new PackageStreams added to the Package. If this 75*b1cdbd2cSJim Jagielski is called more than once, it will replace the existing stream. 76*b1cdbd2cSJim Jagielski */ 77*b1cdbd2cSJim Jagielski interface com::sun::star::io::XActiveDataSink; 78*b1cdbd2cSJim Jagielski /** 79*b1cdbd2cSJim Jagielski This interface provides access to the properties of the package entry. 80*b1cdbd2cSJim Jagielski Currently, this supports three entries: 81*b1cdbd2cSJim Jagielski 82*b1cdbd2cSJim Jagielski 1. Size, describing the uncompressed size of PackageStream. 83*b1cdbd2cSJim Jagielski 2. MediaType, a string describing the MIME type of the stream. 84*b1cdbd2cSJim Jagielski 3. Compress, a boolean flag to specify whether or not to compress 85*b1cdbd2cSJim Jagielski this PackageStream. 86*b1cdbd2cSJim Jagielski */ 87*b1cdbd2cSJim Jagielski interface com::sun::star::beans::XPropertySet; 88*b1cdbd2cSJim Jagielski}; 89*b1cdbd2cSJim Jagielski}; }; }; }; 90*b1cdbd2cSJim Jagielski 91*b1cdbd2cSJim Jagielski#endif 92