1*d1766043SAndrew Rist/************************************************************** 2cdf0e10cSrcweir * 3*d1766043SAndrew Rist * Licensed to the Apache Software Foundation (ASF) under one 4*d1766043SAndrew Rist * or more contributor license agreements. See the NOTICE file 5*d1766043SAndrew Rist * distributed with this work for additional information 6*d1766043SAndrew Rist * regarding copyright ownership. The ASF licenses this file 7*d1766043SAndrew Rist * to you under the Apache License, Version 2.0 (the 8*d1766043SAndrew Rist * "License"); you may not use this file except in compliance 9*d1766043SAndrew Rist * with the License. You may obtain a copy of the License at 10*d1766043SAndrew Rist * 11*d1766043SAndrew Rist * http://www.apache.org/licenses/LICENSE-2.0 12*d1766043SAndrew Rist * 13*d1766043SAndrew Rist * Unless required by applicable law or agreed to in writing, 14*d1766043SAndrew Rist * software distributed under the License is distributed on an 15*d1766043SAndrew Rist * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 16*d1766043SAndrew Rist * KIND, either express or implied. See the License for the 17*d1766043SAndrew Rist * specific language governing permissions and limitations 18*d1766043SAndrew Rist * under the License. 19*d1766043SAndrew Rist * 20*d1766043SAndrew Rist *************************************************************/ 21*d1766043SAndrew Rist 22*d1766043SAndrew Rist 23cdf0e10cSrcweir#ifndef __com_sun_star_packages_PackageFolder_idl__ 24cdf0e10cSrcweir#define __com_sun_star_packages_PackageFolder_idl__ 25cdf0e10cSrcweir 26cdf0e10cSrcweir#ifndef __com_sun_star_container_XNamed_idl__ 27cdf0e10cSrcweir#include <com/sun/star/container/XNamed.idl> 28cdf0e10cSrcweir#endif 29cdf0e10cSrcweir 30cdf0e10cSrcweir#ifndef __com_sun_star_container_XChild_idl__ 31cdf0e10cSrcweir#include <com/sun/star/container/XChild.idl> 32cdf0e10cSrcweir#endif 33cdf0e10cSrcweir 34cdf0e10cSrcweir#ifndef __com_sun_star_container_XNameContainer_idl__ 35cdf0e10cSrcweir#include <com/sun/star/container/XNameContainer.idl> 36cdf0e10cSrcweir#endif 37cdf0e10cSrcweir 38cdf0e10cSrcweir#ifndef __com_sun_star_beans_XPropertySet_idl__ 39cdf0e10cSrcweir#include <com/sun/star/beans/XPropertySet.idl> 40cdf0e10cSrcweir#endif 41cdf0e10cSrcweir 42cdf0e10cSrcweir#ifndef __com_sun_star_container_XEnumerationAccess_udl__ 43cdf0e10cSrcweir#include <com/sun/star/container/XEnumerationAccess.idl> 44cdf0e10cSrcweir#endif 45cdf0e10cSrcweir//============================================================================= 46cdf0e10cSrcweir 47cdf0e10cSrcweirmodule com { module sun { module star { module packages { 48cdf0e10cSrcweir 49cdf0e10cSrcweir//============================================================================= 50cdf0e10cSrcweir/** 51cdf0e10cSrcweir The PackageFolder service represents a single folder or directory within 52cdf0e10cSrcweir a Package. Instances of this service can only be constructed by an 53cdf0e10cSrcweir implementation of the Package service and not via the service manager. 54cdf0e10cSrcweir*/ 55cdf0e10cSrcweirpublished service PackageFolder 56cdf0e10cSrcweir{ 57cdf0e10cSrcweir /** 58cdf0e10cSrcweir This interface is used to get or set the name of the folder. 59cdf0e10cSrcweir */ 60cdf0e10cSrcweir interface com::sun::star::container::XNamed; 61cdf0e10cSrcweir /** 62cdf0e10cSrcweir The getParent method of XChild will return the PackageFolder that 63cdf0e10cSrcweir contains this PackageFolder or nothing if this PackageFolder is 64cdf0e10cSrcweir the root PackageFolder. 65cdf0e10cSrcweir 66cdf0e10cSrcweir setParent will move the PackageFolder. 67cdf0e10cSrcweir */ 68cdf0e10cSrcweir interface com::sun::star::container::XChild; 69cdf0e10cSrcweir /** 70cdf0e10cSrcweir This interface describes all of the PackageFolders and PackageStreams 71cdf0e10cSrcweir which are contained within this instance of the PackageFolder service. 72cdf0e10cSrcweir 73cdf0e10cSrcweir XElementAccess::getElementType returns service PackageStream 74cdf0e10cSrcweir XNameAccess::getByName returns either a PackageFolder or a PackageStream 75cdf0e10cSrcweir as a css::uno::Any 76cdf0e10cSrcweir XNameAccess::getElementNames returns an uno::Sequence of strings containing 77cdf0e10cSrcweir the names of all children stored in the PackageFolder 78cdf0e10cSrcweir */ 79cdf0e10cSrcweir interface com::sun::star::container::XNameContainer; 80cdf0e10cSrcweir /** 81cdf0e10cSrcweir This interface will return an implementation of service 82cdf0e10cSrcweir PackageFolderEnumeration, which represents an iterator over the children 83cdf0e10cSrcweir of the PackageFolder, or the PackageStreams and PackageFolders contained 84cdf0e10cSrcweir within this instance of the PackageFolder service. 85cdf0e10cSrcweir 86cdf0e10cSrcweir This provides a "snapshot" of the contents of the 87cdf0e10cSrcweir PackageFolder at the time of construction. It is the responsibility of the 88cdf0e10cSrcweir caller to ensure that any given member of the enumeration refers to a valid 89cdf0e10cSrcweir PackageStream or PackageFolder. 90cdf0e10cSrcweir 91cdf0e10cSrcweir */ 92cdf0e10cSrcweir interface com::sun::star::container::XEnumerationAccess; 93cdf0e10cSrcweir 94cdf0e10cSrcweir /** 95cdf0e10cSrcweir This interface provides access to the properties of the package entry. 96cdf0e10cSrcweir Currently, this only supports one entry which is a string called 97cdf0e10cSrcweir MediaType. This contains the MIME type of the stream (eg. "text/html"). 98cdf0e10cSrcweir For PackageFolders, this is always an empty string. 99cdf0e10cSrcweir */ 100cdf0e10cSrcweir interface com::sun::star::beans::XPropertySet; 101cdf0e10cSrcweir}; 102cdf0e10cSrcweir}; }; }; }; 103cdf0e10cSrcweir 104cdf0e10cSrcweir#endif 105