LibreOffice: PackageStreamContent Service Reference

LibreOffice LibreOffice 5.3 SDK API Reference

Exported Interfaces | List of all members
PackageStreamContent Service Referencepublished

A PCP Stream is a content which represents a file inside a package. More...

`import"PackageStreamContent.idl";`

Inheritance diagram for PackageStreamContent:

## Exported Interfaces
interface | com::sun::star::lang::XComponent
| This interface is implemented according to the specification of service Content. More...
interface | com::sun::star::ucb::XContent
| This interface is implemented according to the specification of service Content. More...
interface | com::sun::star::ucb::XCommandProcessor
| This interface is implemented according to the specification of service Content. More...
interface | com::sun::star::ucb::XCommandProcessor2
| is an enhanced version of XCommandProcessor that has an additional method for releasing command identifiers obtained via XCommandProcessor::createCommandIdentifier() to avoid resource leaks. More...
interface | com::sun::star::beans::XPropertiesChangeNotifier
| This interface is implemented according to the specification of service Content. More...
interface | com::sun::star::beans::XPropertyContainer
| This interface is implemented according to the specification of service Content. More...
interface | com::sun::star::beans::XPropertySetInfoChangeNotifier
| This interface is implemented according to the specification of service Content. More...
interface | com::sun::star::ucb::XCommandInfoChangeNotifier
| This interface is implemented according to the specification of service Content. More...
interface | com::sun::star::container::XChild
| This interface is implemented according to the specification of service Content. More...

## Additional Inherited Members
Public Member Functions inherited from XComponent
void | dispose ()
| The owner of an object calls this method to explicitly free all resources kept by this object and thus break cyclic references. More...
void | addEventListener ([in] XEventListener xListener)
| adds an event listener to the object. More...
void | removeEventListener ([in] XEventListener aListener)
| removes an event listener from the listener list. 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 XContent
com::sun::star::ucb::XContentIdentifier | getIdentifier ()
| returns the identifier of the content. More...
string | getContentType ()
| returns a type string, which is unique for that type of content (e.g. More...
void | addContentEventListener ([in] com::sun::star::ucb::XContentEventListener Listener)
| adds a listener for content events. More...
void | removeContentEventListener ([in] com::sun::star::ucb::XContentEventListener Listener)
| removes a listener for content events. More...
Public Member Functions inherited from XCommandProcessor
long | createCommandIdentifier ()
| creates a unique identifier for a command. More...
any | execute ([in] Command aCommand, [in] long CommandId, [in] XCommandEnvironment Environment) raises ( com::sun::star::uno::Exception, CommandAbortedException )
| executes a command. More...
void | abort ([in] long CommandId)
| ends the command associated with the given id. More...
Public Member Functions inherited from XPropertiesChangeNotifier
void | addPropertiesChangeListener ([in] sequence< string > PropertyNames, [in] com::sun::star::beans::XPropertiesChangeListener Listener)
| adds an XPropertiesChangeListener to the specified properties with the specified names. More...
void | removePropertiesChangeListener ([in] sequence< string > PropertyNames, [in] com::sun::star::beans::XPropertiesChangeListener Listener)
| removes an XPropertiesChangeListener from the listener list. More...
Public Member Functions inherited from XPropertyContainer
void | addProperty ([in] string Name, [in] short Attributes, [in] any DefaultValue) raises ( com::sun::star::beans::PropertyExistException, com::sun::star::beans::IllegalTypeException, com::sun::star::lang::IllegalArgumentException )
| adds a property to the object. More...
void | removeProperty ([in] string Name) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::beans::NotRemoveableException )
| removes a property from the object. More...
Public Member Functions inherited from XPropertySetInfoChangeNotifier
void | addPropertySetInfoChangeListener ([in] XPropertySetInfoChangeListener Listener)
| registers a listener for PropertySetInfoChangeEvents. More...
void | removePropertySetInfoChangeListener ([in] XPropertySetInfoChangeListener Listener)
| removes a listener for PropertySetInfoChangeEvents. More...
Public Member Functions inherited from XCommandInfoChangeNotifier
void | addCommandInfoChangeListener ([in] XCommandInfoChangeListener Listener)
| registers a listener for CommandInfoChangeEvents. More...
void | removeCommandInfoChangeListener ([in] XCommandInfoChangeListener Listener)
| removes a listener for CommandInfoChangeEvents. 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...
Protected Member Functions inherited from XCommandProcessor2
void | releaseCommandIdentifier ([in] long CommandId)
| releases a command identifier obtained through XCommandProcessor::createCommandIdentifier() when it is no longer used. More...
Protected Member Functions inherited from XPropertiesChangeNotifier
void | addPropertiesChangeListener ([in] sequence< string > PropertyNames, [in] com::sun::star::beans::XPropertiesChangeListener Listener)
| adds an XPropertiesChangeListener to the specified properties with the specified names. More...
void | removePropertiesChangeListener ([in] sequence< string > PropertyNames, [in] com::sun::star::beans::XPropertiesChangeListener Listener)
| removes an XPropertiesChangeListener from the listener list. More...
Protected Member Functions inherited from XPropertyContainer
void | addProperty ([in] string Name, [in] short Attributes, [in] any DefaultValue) raises ( com::sun::star::beans::PropertyExistException, com::sun::star::beans::IllegalTypeException, com::sun::star::lang::IllegalArgumentException )
| adds a property to the object. More...
void | removeProperty ([in] string Name) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::beans::NotRemoveableException )
| removes a property from the object. More...
Protected Member Functions inherited from XPropertySetInfoChangeNotifier
void | addPropertySetInfoChangeListener ([in] XPropertySetInfoChangeListener Listener)
| registers a listener for PropertySetInfoChangeEvents. More...
void | removePropertySetInfoChangeListener ([in] XPropertySetInfoChangeListener Listener)
| removes a listener for PropertySetInfoChangeEvents. More...
Protected Member Functions inherited from XCommandInfoChangeNotifier
void | addCommandInfoChangeListener ([in] XCommandInfoChangeListener Listener)
| registers a listener for CommandInfoChangeEvents. More...
void | removeCommandInfoChangeListener ([in] XCommandInfoChangeListener Listener)
| removes a listener for CommandInfoChangeEvents. More...
Protected 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...

## Detailed Description

A PCP Stream is a content which represents a file inside a package.

It is always contained in a PCP Folder. A PCP Stream has no children.

See also
  com::sun::star::ucb::PackageContentProvider
  com::sun::star::ucb::PackageFolderContent

## Exported Interfaces

## ◆ com::sun::star::beans::XPropertiesChangeNotifier

interface com::sun::star::beans::XPropertiesChangeNotifier

This interface is implemented according to the specification of service Content.

## ◆ com::sun::star::beans::XPropertyContainer

interface com::sun::star::beans::XPropertyContainer

This interface is implemented according to the specification of service Content.

## ◆ com::sun::star::beans::XPropertySetInfoChangeNotifier

interface com::sun::star::beans::XPropertySetInfoChangeNotifier

This interface is implemented according to the specification of service Content.

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

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

This interface is implemented according to the specification of service Content.

## ◆ com::sun::star::lang::XComponent

interface com::sun::star::lang::XComponent

This interface is implemented according to the specification of service Content.

## ◆ com::sun::star::ucb::XCommandInfoChangeNotifier

interface com::sun::star::ucb::XCommandInfoChangeNotifier

This interface is implemented according to the specification of service Content.

## ◆ com::sun::star::ucb::XCommandProcessor

interface com::sun::star::ucb::XCommandProcessor

This interface is implemented according to the specification of service Content.

Supported Commands

- getCommandInfo
- getPropertySetInfo
- getPropertyValues
- setPropertyValues
- insert ( makes a newly created stream persistent )
- delete
- open

Supported Properties

- string ContentType ( read-only, always "application/vnd.sun.star.pkg-stream" )
- boolean IsDocument ( read-only, always true )
- boolean IsFolder ( read-only, always false )
- string MediaType
- string Size ( read-only )
- string Title
- boolean Compressed ( allows you to explicitly state whether you want a stream to be compressed or not. The default value of this property will be determined according to the value of the property "MediaType". If it is empty or prefixed by "text/", the value of "Compressed" is set to true. Otherwise the value will be false. )
- boolean Encrypted ( are the stream data encrypted or not ).

## ◆ com::sun::star::ucb::XCommandProcessor2

interface com::sun::star::ucb::XCommandProcessor2
| optional

is an enhanced version of XCommandProcessor that has an additional method for releasing command identifiers obtained via XCommandProcessor::createCommandIdentifier() to avoid resource leaks.

For a detailed description of the problem refer to XCommandProcessor2::releaseCommandIdentifier().

Where many existing Content implementations do not (yet), every new implementation should support this interface.

## ◆ com::sun::star::ucb::XContent

interface com::sun::star::ucb::XContent

This interface is implemented according to the specification of service Content.

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

- com/sun/star/ucb/PackageStreamContent.idl