Overview | Module | Use | Devguide | Index

Services' Summary | Interfaces' Summary | Properties' Summary | Services' Details | Interfaces' Details | Properties' Details

:: com :: sun :: star :: packages ::
service PackageFolder
Description The PackageFolder service represents a single folder or directory within a Package. Instances of this service can only be constructed by an implementation of the Package service and not via the service manager.

Exported Interfaces - Summary
::com::sun::star::container::XNamed | This interface is used to get or set the name of the folder.
::com::sun::star::container::XChild | The getParent method of XChild will return the PackageFolder that contains this PackageFolder or nothing if this PackageFolder is the root PackageFolder. setParent will move the PackageFolder.
::com::sun::star::container::XNameContainer | This interface describes all of the PackageFolders and PackageStreams which are contained within this instance of the PackageFolder service. XElementAccess::getElementType returns service PackageStream XNameAccess::getByName returns either a PackageFolder or a PackageStream as a css::uno::Any XNameAccess::getElementNames returns an uno::Sequence of strings containing the names of all children stored in the PackageFolder
::com::sun::star::container::XEnumerationAccess | This interface will return an implementation of service PackageFolderEnumeration, which represents an iterator over the children of the PackageFolder, or the PackageStreams and PackageFolders contained within this instance of the PackageFolder service. This provides a "snapshot" of the contents of the PackageFolder at the time of construction. It is the responsibility of the caller to ensure that any given member of the enumeration refers to a valid PackageStream or PackageFolder.
::com::sun::star::beans::XPropertySet | This interface provides access to the properties of the package entry. Currently, this only supports one entry which is a string called MediaType. This contains the MIME type of the stream (e.g. "text/html"). For PackageFolders, this is always an empty string.

Exported Interfaces - Details
::com::sun::star::container::XNamed
Description This interface is used to get or set the name of the folder.
::com::sun::star::container::XChild
Description The getParent method of XChild will return the PackageFolder that contains this PackageFolder or nothing if this PackageFolder is the root PackageFolder. setParent will move the PackageFolder.
::com::sun::star::container::XNameContainer
Description This interface describes all of the PackageFolders and PackageStreams which are contained within this instance of the PackageFolder service. XElementAccess::getElementType returns service PackageStream XNameAccess::getByName returns either a PackageFolder or a PackageStream as a css::uno::Any XNameAccess::getElementNames returns an uno::Sequence of strings containing the names of all children stored in the PackageFolder
::com::sun::star::container::XEnumerationAccess
Description This interface will return an implementation of service PackageFolderEnumeration, which represents an iterator over the children of the PackageFolder, or the PackageStreams and PackageFolders contained within this instance of the PackageFolder service. This provides a "snapshot" of the contents of the PackageFolder at the time of construction. It is the responsibility of the caller to ensure that any given member of the enumeration refers to a valid PackageStream or PackageFolder.
::com::sun::star::beans::XPropertySet
Description This interface provides access to the properties of the package entry. Currently, this only supports one entry which is a string called MediaType. This contains the MIME type of the stream (e.g. "text/html"). For PackageFolders, this is always an empty string.

Top of Page

Copyright © 2000, 2014 LibreOffice contributors and/or their affiliates. All rights reserved.

LibreOffice was created by The Document Foundation, based on OpenOffice.org, which is Copyright 2000, 2010 Oracle and/or its affiliates.

The Document Foundation acknowledges all community members, please find more info at our website.

Privacy Policy | Impressum (Legal Info) | Copyright information: The source code of LibreOffice is licensed under the GNU Lesser General Public License (LGPLv3). "LibreOffice" and "The Document Foundation" are registered trademarks of their corresponding registered owners or are in actual use as trademarks in one or more countries. Their respective logos and icons are also subject to international copyright laws. Use thereof is explained in our trademark policy.