1*cdf0e10cSrcweir/************************************************************************* 2*cdf0e10cSrcweir * 3*cdf0e10cSrcweir * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. 4*cdf0e10cSrcweir * 5*cdf0e10cSrcweir * Copyright 2000, 2010 Oracle and/or its affiliates. 6*cdf0e10cSrcweir * 7*cdf0e10cSrcweir * OpenOffice.org - a multi-platform office productivity suite 8*cdf0e10cSrcweir * 9*cdf0e10cSrcweir * This file is part of OpenOffice.org. 10*cdf0e10cSrcweir * 11*cdf0e10cSrcweir * OpenOffice.org is free software: you can redistribute it and/or modify 12*cdf0e10cSrcweir * it under the terms of the GNU Lesser General Public License version 3 13*cdf0e10cSrcweir * only, as published by the Free Software Foundation. 14*cdf0e10cSrcweir * 15*cdf0e10cSrcweir * OpenOffice.org is distributed in the hope that it will be useful, 16*cdf0e10cSrcweir * but WITHOUT ANY WARRANTY; without even the implied warranty of 17*cdf0e10cSrcweir * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 18*cdf0e10cSrcweir * GNU Lesser General Public License version 3 for more details 19*cdf0e10cSrcweir * (a copy is included in the LICENSE file that accompanied this code). 20*cdf0e10cSrcweir * 21*cdf0e10cSrcweir * You should have received a copy of the GNU Lesser General Public License 22*cdf0e10cSrcweir * version 3 along with OpenOffice.org. If not, see 23*cdf0e10cSrcweir * <http://www.openoffice.org/license.html> 24*cdf0e10cSrcweir * for a copy of the LGPLv3 License. 25*cdf0e10cSrcweir * 26*cdf0e10cSrcweir ************************************************************************/ 27*cdf0e10cSrcweir#ifndef __com_sun_star_packages_PackageFolder_idl__ 28*cdf0e10cSrcweir#define __com_sun_star_packages_PackageFolder_idl__ 29*cdf0e10cSrcweir 30*cdf0e10cSrcweir#ifndef __com_sun_star_container_XNamed_idl__ 31*cdf0e10cSrcweir#include <com/sun/star/container/XNamed.idl> 32*cdf0e10cSrcweir#endif 33*cdf0e10cSrcweir 34*cdf0e10cSrcweir#ifndef __com_sun_star_container_XChild_idl__ 35*cdf0e10cSrcweir#include <com/sun/star/container/XChild.idl> 36*cdf0e10cSrcweir#endif 37*cdf0e10cSrcweir 38*cdf0e10cSrcweir#ifndef __com_sun_star_container_XNameContainer_idl__ 39*cdf0e10cSrcweir#include <com/sun/star/container/XNameContainer.idl> 40*cdf0e10cSrcweir#endif 41*cdf0e10cSrcweir 42*cdf0e10cSrcweir#ifndef __com_sun_star_beans_XPropertySet_idl__ 43*cdf0e10cSrcweir#include <com/sun/star/beans/XPropertySet.idl> 44*cdf0e10cSrcweir#endif 45*cdf0e10cSrcweir 46*cdf0e10cSrcweir#ifndef __com_sun_star_container_XEnumerationAccess_udl__ 47*cdf0e10cSrcweir#include <com/sun/star/container/XEnumerationAccess.idl> 48*cdf0e10cSrcweir#endif 49*cdf0e10cSrcweir//============================================================================= 50*cdf0e10cSrcweir 51*cdf0e10cSrcweirmodule com { module sun { module star { module packages { 52*cdf0e10cSrcweir 53*cdf0e10cSrcweir//============================================================================= 54*cdf0e10cSrcweir/** 55*cdf0e10cSrcweir The PackageFolder service represents a single folder or directory within 56*cdf0e10cSrcweir a Package. Instances of this service can only be constructed by an 57*cdf0e10cSrcweir implementation of the Package service and not via the service manager. 58*cdf0e10cSrcweir*/ 59*cdf0e10cSrcweirpublished service PackageFolder 60*cdf0e10cSrcweir{ 61*cdf0e10cSrcweir /** 62*cdf0e10cSrcweir This interface is used to get or set the name of the folder. 63*cdf0e10cSrcweir */ 64*cdf0e10cSrcweir interface com::sun::star::container::XNamed; 65*cdf0e10cSrcweir /** 66*cdf0e10cSrcweir The getParent method of XChild will return the PackageFolder that 67*cdf0e10cSrcweir contains this PackageFolder or nothing if this PackageFolder is 68*cdf0e10cSrcweir the root PackageFolder. 69*cdf0e10cSrcweir 70*cdf0e10cSrcweir setParent will move the PackageFolder. 71*cdf0e10cSrcweir */ 72*cdf0e10cSrcweir interface com::sun::star::container::XChild; 73*cdf0e10cSrcweir /** 74*cdf0e10cSrcweir This interface describes all of the PackageFolders and PackageStreams 75*cdf0e10cSrcweir which are contained within this instance of the PackageFolder service. 76*cdf0e10cSrcweir 77*cdf0e10cSrcweir XElementAccess::getElementType returns service PackageStream 78*cdf0e10cSrcweir XNameAccess::getByName returns either a PackageFolder or a PackageStream 79*cdf0e10cSrcweir as a css::uno::Any 80*cdf0e10cSrcweir XNameAccess::getElementNames returns an uno::Sequence of strings containing 81*cdf0e10cSrcweir the names of all children stored in the PackageFolder 82*cdf0e10cSrcweir */ 83*cdf0e10cSrcweir interface com::sun::star::container::XNameContainer; 84*cdf0e10cSrcweir /** 85*cdf0e10cSrcweir This interface will return an implementation of service 86*cdf0e10cSrcweir PackageFolderEnumeration, which represents an iterator over the children 87*cdf0e10cSrcweir of the PackageFolder, or the PackageStreams and PackageFolders contained 88*cdf0e10cSrcweir within this instance of the PackageFolder service. 89*cdf0e10cSrcweir 90*cdf0e10cSrcweir This provides a "snapshot" of the contents of the 91*cdf0e10cSrcweir PackageFolder at the time of construction. It is the responsibility of the 92*cdf0e10cSrcweir caller to ensure that any given member of the enumeration refers to a valid 93*cdf0e10cSrcweir PackageStream or PackageFolder. 94*cdf0e10cSrcweir 95*cdf0e10cSrcweir */ 96*cdf0e10cSrcweir interface com::sun::star::container::XEnumerationAccess; 97*cdf0e10cSrcweir 98*cdf0e10cSrcweir /** 99*cdf0e10cSrcweir This interface provides access to the properties of the package entry. 100*cdf0e10cSrcweir Currently, this only supports one entry which is a string called 101*cdf0e10cSrcweir MediaType. This contains the MIME type of the stream (eg. "text/html"). 102*cdf0e10cSrcweir For PackageFolders, this is always an empty string. 103*cdf0e10cSrcweir */ 104*cdf0e10cSrcweir interface com::sun::star::beans::XPropertySet; 105*cdf0e10cSrcweir}; 106*cdf0e10cSrcweir}; }; }; }; 107*cdf0e10cSrcweir 108*cdf0e10cSrcweir#endif 109