Language:

The Free and Open Productivity Suite
Apache OpenOffice 4.1.4 released

Developer's Guide

API

SDK

Tips 'n' Tricks

Miscellaneous


:: 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 (eg. "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 (eg. "text/html"). For PackageFolders, this is always an empty string.

 
Top of Page

Apache Software Foundation

Copyright & License | Privacy | Contact Us | Donate | Thanks

Apache and the Apache feather logo are trademarks of The Apache Software Foundation. OpenOffice, OpenOffice.org and the seagull logo are registered trademarks of The Apache Software Foundation. Other names appearing on the site may be trademarks of their respective owners.