LibreOffice LibreOffice 25.2 SDK API Reference

Exported Interfaces | List of all members
PackageStream Service Referencepublished

This service represents a stream contained within a Package. More...

`import"PackageStream.idl";`

Inheritance diagram for PackageStream:

## Exported Interfaces
interface | com::sun::star::container::XNamed
| This sets or gets the name of the Stream as contained within its parent PackageFolder. More...
interface | com::sun::star::container::XChild
| getParent returns the PackageFolder that the PackageStream is in. More...
interface | com::sun::star::io::XActiveDataSink
| getInputStream provides read access to the contents of this PackageStream. More...
interface | com::sun::star::beans::XPropertySet
| This interface provides access to the properties of the package entry. More...

## Additional Inherited Members
Public Member Functions inherited from XNamed
string | getName ()
void | setName ([in] string aName)
| sets the programmatic name of the object. More...
Public Member Functions inherited from XInterface
any | queryInterface ([in] type aType)
| queries for a new interface to an existing UNO object. More...
void | acquire ()
| increases the reference counter by one. More...
void | release ()
| decreases the reference counter by one. More...
Public Member Functions inherited from XChild
com::sun::star::uno::XInterface | getParent ()
| grants access to the object containing this content. More...
void | setParent ([in] com::sun::star::uno::XInterface Parent) raises ( com::sun::star::lang::NoSupportException )
| sets the parent to this object. More...
Public Member Functions inherited from XActiveDataSink
void | setInputStream ([in] com::sun::star::io::XInputStream aStream)
| plugs the input stream. More...
com::sun::star::io::XInputStream | getInputStream ()
Public Member Functions inherited from XPropertySet
com::sun::star::beans::XPropertySetInfo | getPropertySetInfo ()
void | setPropertyValue ([in] string aPropertyName, [in] any aValue) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::beans::PropertyVetoException, com::sun::star::lang::IllegalArgumentException, com::sun::star::lang::WrappedTargetException )
| sets the value of the property with the specified name. More...
any | getPropertyValue ([in] string PropertyName) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::lang::WrappedTargetException )
void | addPropertyChangeListener ([in] string aPropertyName, [in] com::sun::star::beans::XPropertyChangeListener xListener) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::lang::WrappedTargetException )
| adds an XPropertyChangeListener to the specified property. More...
void | removePropertyChangeListener ([in] string aPropertyName, [in] com::sun::star::beans::XPropertyChangeListener aListener) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::lang::WrappedTargetException )
| removes an XPropertyChangeListener from the listener list. More...
void | addVetoableChangeListener ([in] string PropertyName, [in] com::sun::star::beans::XVetoableChangeListener aListener) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::lang::WrappedTargetException )
| adds an XVetoableChangeListener to the specified property with the name PropertyName. More...
void | removeVetoableChangeListener ([in] string PropertyName, [in] com::sun::star::beans::XVetoableChangeListener aListener) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::lang::WrappedTargetException )
| removes an XVetoableChangeListener from the listener list. More...

## Detailed Description

This service represents a stream contained within a Package.

Instances of this class can only be constructed by the implementation of the Package service.

## Exported Interfaces

## ◆ com::sun::star::beans::XPropertySet

interface com::sun::star::beans::XPropertySet

This interface provides access to the properties of the package entry.

Currently, this supports three entries:

1. Size, describing the uncompressed size of PackageStream.
2. MediaType, a string describing the MIME type of the stream.
3. Compress, a boolean flag to specify whether or not to compress this PackageStream.

## ◆ com::sun::star::container::XChild

interface com::sun::star::container::XChild

getParent returns the PackageFolder that the PackageStream is in.

This may be the root PackageFolder. setParent moves a PackageStream.

## ◆ com::sun::star::container::XNamed

interface com::sun::star::container::XNamed

This sets or gets the name of the Stream as contained within its parent PackageFolder.

## ◆ com::sun::star::io::XActiveDataSink

interface com::sun::star::io::XActiveDataSink

getInputStream provides read access to the contents of this PackageStream.

If this PackageStream was a member of the Package when it was instantiated, the XInputStream returned is a Reference to the stream of the whole Package, with limits set on where it can seek to and read from. If the PackageStream is a new addition to the package, then getInputStream returns a Reference to the XInputStream which was specified with setInputStream.

setInputStream - provides a stream to the data contained in the PackageStream this must be specified for new PackageStreams added to the Package. If this is called more than once, it will replace the existing stream.

The documentation for this service was generated from the following file:

- com/sun/star/packages/PackageStream.idl