LibreOffice
LibreOffice 6.4 SDK API Reference
Exported Interfaces | List of all members
XExtendedStorageStream Interface Referencepublished

This interface allows access to an extended storage stream that might be transacted. More...

import"XExtendedStorageStream.idl";

Inheritance diagram for XExtendedStorageStream:
XStream XComponent XSeekable XEncryptionProtectedSource XPropertySet XTransactedObject XTransactionBroadcaster XInterface XInterface XInterface XInterface XInterface XInterface XInterface

Exported Interfaces

interface ::com::sun::star::io::XStream
 Stream access. More...
 
interface ::com::sun::star::lang::XComponent
 allows to control object lifetime. More...
 
interface ::com::sun::star::io::XSeekable
 allows to seek to a specified position within the stream. More...
 
interface ::com::sun::star::embed::XEncryptionProtectedSource
 allows to set password to the stream. More...
 
interface ::com::sun::star::beans::XPropertySet
 allows to get access to stream properties. More...
 
interface ::com::sun::star::embed::XTransactedObject
 allows to have transacted access. More...
 
interface ::com::sun::star::embed::XTransactionBroadcaster
 allows to register a listener for transaction actions. More...
 

Additional Inherited Members

- Public Member Functions inherited from XStream
XInputStream getInputStream ()
 
XOutputStream getOutputStream ()
 
- 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 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...
 
- Protected Member Functions inherited from XSeekable
void seek ([in] hyper location) raises ( com::sun::star::lang::IllegalArgumentException, com::sun::star::io::IOException )
 changes the seek pointer to a new location relative to the beginning of the stream. More...
 
hyper getPosition () raises ( com::sun::star::io::IOException )
 returns the current offset of the stream. More...
 
hyper getLength () raises ( com::sun::star::io::IOException )
 returns the length of the stream. More...
 
- Protected Member Functions inherited from XEncryptionProtectedSource
void setEncryptionPassword ([in] string sPassword) raises ( ::com::sun::star::io::IOException )
 sets a password for the object. More...
 
void removeEncryption () raises ( ::com::sun::star::io::IOException )
 removes encryption from the object. More...
 
- Protected 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...
 
- Protected Member Functions inherited from XTransactedObject
void commit () raises ( ::com::sun::star::io::IOException, ::com::sun::star::lang::WrappedTargetException )
 commits the changes made for object. More...
 
void revert () raises ( ::com::sun::star::io::IOException, ::com::sun::star::lang::WrappedTargetException )
 removes all the changes made for the object after last commit or loading. More...
 
- Protected Member Functions inherited from XTransactionBroadcaster
void addTransactionListener ([in] com::sun::star::embed::XTransactionListener aListener)
 adds the specified listener to receive events about commits and reverts. More...
 
void removeTransactionListener ([in] com::sun::star::embed::XTransactionListener aListener)
 removes the specified listener. More...
 

Detailed Description

This interface allows access to an extended storage stream that might be transacted.

Exported Interfaces

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

allows to get access to stream properties.

◆ ::com::sun::star::embed::XEncryptionProtectedSource

allows to set password to the stream.

This interface must be supported by a stream with read-write access to allow to set a password that should be used next time the stream is stored if the encryption is supported.

If the password is set or changed by this interface and the stream is closed the new password should be used to get access to the stream next time.

◆ ::com::sun::star::embed::XTransactedObject

allows to have transacted access.

◆ ::com::sun::star::embed::XTransactionBroadcaster

allows to register a listener for transaction actions.

If XTransactedObject interface is implemented this interface must be implemented as well.

◆ ::com::sun::star::io::XSeekable

interface ::com::sun::star::io::XSeekable
optional

allows to seek to a specified position within the stream.

This interface must be supported in case either seekable readonly or read-write access is requested.

◆ ::com::sun::star::io::XStream

Stream access.

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

allows to control object lifetime.


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