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_PackageFolder_idl__ 24*b1cdbd2cSJim Jagielski#define __com_sun_star_packages_PackageFolder_idl__ 25*b1cdbd2cSJim Jagielski 26*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_container_XNamed_idl__ 27*b1cdbd2cSJim Jagielski#include <com/sun/star/container/XNamed.idl> 28*b1cdbd2cSJim Jagielski#endif 29*b1cdbd2cSJim Jagielski 30*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_container_XChild_idl__ 31*b1cdbd2cSJim Jagielski#include <com/sun/star/container/XChild.idl> 32*b1cdbd2cSJim Jagielski#endif 33*b1cdbd2cSJim Jagielski 34*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_container_XNameContainer_idl__ 35*b1cdbd2cSJim Jagielski#include <com/sun/star/container/XNameContainer.idl> 36*b1cdbd2cSJim Jagielski#endif 37*b1cdbd2cSJim Jagielski 38*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_beans_XPropertySet_idl__ 39*b1cdbd2cSJim Jagielski#include <com/sun/star/beans/XPropertySet.idl> 40*b1cdbd2cSJim Jagielski#endif 41*b1cdbd2cSJim Jagielski 42*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_container_XEnumerationAccess_udl__ 43*b1cdbd2cSJim Jagielski#include <com/sun/star/container/XEnumerationAccess.idl> 44*b1cdbd2cSJim Jagielski#endif 45*b1cdbd2cSJim Jagielski//============================================================================= 46*b1cdbd2cSJim Jagielski 47*b1cdbd2cSJim Jagielskimodule com { module sun { module star { module packages { 48*b1cdbd2cSJim Jagielski 49*b1cdbd2cSJim Jagielski//============================================================================= 50*b1cdbd2cSJim Jagielski/** 51*b1cdbd2cSJim Jagielski The PackageFolder service represents a single folder or directory within 52*b1cdbd2cSJim Jagielski a Package. Instances of this service can only be constructed by an 53*b1cdbd2cSJim Jagielski implementation of the Package service and not via the service manager. 54*b1cdbd2cSJim Jagielski*/ 55*b1cdbd2cSJim Jagielskipublished service PackageFolder 56*b1cdbd2cSJim Jagielski{ 57*b1cdbd2cSJim Jagielski /** 58*b1cdbd2cSJim Jagielski This interface is used to get or set the name of the folder. 59*b1cdbd2cSJim Jagielski */ 60*b1cdbd2cSJim Jagielski interface com::sun::star::container::XNamed; 61*b1cdbd2cSJim Jagielski /** 62*b1cdbd2cSJim Jagielski The getParent method of XChild will return the PackageFolder that 63*b1cdbd2cSJim Jagielski contains this PackageFolder or nothing if this PackageFolder is 64*b1cdbd2cSJim Jagielski the root PackageFolder. 65*b1cdbd2cSJim Jagielski 66*b1cdbd2cSJim Jagielski setParent will move the PackageFolder. 67*b1cdbd2cSJim Jagielski */ 68*b1cdbd2cSJim Jagielski interface com::sun::star::container::XChild; 69*b1cdbd2cSJim Jagielski /** 70*b1cdbd2cSJim Jagielski This interface describes all of the PackageFolders and PackageStreams 71*b1cdbd2cSJim Jagielski which are contained within this instance of the PackageFolder service. 72*b1cdbd2cSJim Jagielski 73*b1cdbd2cSJim Jagielski XElementAccess::getElementType returns service PackageStream 74*b1cdbd2cSJim Jagielski XNameAccess::getByName returns either a PackageFolder or a PackageStream 75*b1cdbd2cSJim Jagielski as a css::uno::Any 76*b1cdbd2cSJim Jagielski XNameAccess::getElementNames returns an uno::Sequence of strings containing 77*b1cdbd2cSJim Jagielski the names of all children stored in the PackageFolder 78*b1cdbd2cSJim Jagielski */ 79*b1cdbd2cSJim Jagielski interface com::sun::star::container::XNameContainer; 80*b1cdbd2cSJim Jagielski /** 81*b1cdbd2cSJim Jagielski This interface will return an implementation of service 82*b1cdbd2cSJim Jagielski PackageFolderEnumeration, which represents an iterator over the children 83*b1cdbd2cSJim Jagielski of the PackageFolder, or the PackageStreams and PackageFolders contained 84*b1cdbd2cSJim Jagielski within this instance of the PackageFolder service. 85*b1cdbd2cSJim Jagielski 86*b1cdbd2cSJim Jagielski This provides a "snapshot" of the contents of the 87*b1cdbd2cSJim Jagielski PackageFolder at the time of construction. It is the responsibility of the 88*b1cdbd2cSJim Jagielski caller to ensure that any given member of the enumeration refers to a valid 89*b1cdbd2cSJim Jagielski PackageStream or PackageFolder. 90*b1cdbd2cSJim Jagielski 91*b1cdbd2cSJim Jagielski */ 92*b1cdbd2cSJim Jagielski interface com::sun::star::container::XEnumerationAccess; 93*b1cdbd2cSJim Jagielski 94*b1cdbd2cSJim Jagielski /** 95*b1cdbd2cSJim Jagielski This interface provides access to the properties of the package entry. 96*b1cdbd2cSJim Jagielski Currently, this only supports one entry which is a string called 97*b1cdbd2cSJim Jagielski MediaType. This contains the MIME type of the stream (eg. "text/html"). 98*b1cdbd2cSJim Jagielski For PackageFolders, this is always an empty string. 99*b1cdbd2cSJim Jagielski */ 100*b1cdbd2cSJim Jagielski interface com::sun::star::beans::XPropertySet; 101*b1cdbd2cSJim Jagielski}; 102*b1cdbd2cSJim Jagielski}; }; }; }; 103*b1cdbd2cSJim Jagielski 104*b1cdbd2cSJim Jagielski#endif 105