diff options
Diffstat (limited to 'offapi/com/sun/star/embed/StorageFactory.idl')
| -rw-r--r-- | offapi/com/sun/star/embed/StorageFactory.idl | 147 |
1 files changed, 71 insertions, 76 deletions
diff --git a/offapi/com/sun/star/embed/StorageFactory.idl b/offapi/com/sun/star/embed/StorageFactory.idl index c4480555d0b7..8a355cd87429 100644 --- a/offapi/com/sun/star/embed/StorageFactory.idl +++ b/offapi/com/sun/star/embed/StorageFactory.idl @@ -39,83 +39,78 @@ //============================================================================ /** The <type>StorageFactory</type> is a service that allows to create a storage based on either stream or URL. - */ + + <p> + In case + <method scope="com::sun::star::lang">XSingleServiceFactory::createInstance</method> + call is used the result storage will be open in read-write mode based + on an arbitrary medium. + </p> + + <p> + In case + <method scope="com::sun::star::lang">XSingleServiceFactory::createInstanceWithArguments</method> + call is used a sequence of the following parameters can be used: + </p> + + <dl> + <dt>parameter 1</dt> + <dd> + specifies source of the object, it can be a string + containing URL, an + <type scope="com::sun::star::io">XStream</type> + implementation or + <type scope="com::sun::star::io">XInputStream</type>; + in case of + <type scope="com::sun::star::io">XStream</type> + implementation + the <type scope="com::sun::star::io">XSeekable</type> + interface must be supported. + </dd> + + <dt>parameter 2</dt> + <dd> + specifies mode the storage should be open in, can take + values from <type>ElementModes</type> constant set. + </dd> + + <dt>parameter 3</dt> + <dd> + this parameter represents + <type scope="com::sun::star::uno">Any</type> + containing a sequence of + <type scope="com::sun::star::beans">PropertyValue</type>.<br> + The parameter can contain entries from + <type scope="com::sun::star::document">MediaDescryptor</type> + to transport some document info during the storage + initialization, it can be for example + <type scope="com::sun::star::task">XInteractionHandler</type> + implementation, password for the storage and repair + package flag.<br> + Additionally the parameter might contain property with the name + "StorageFormat" that can take values from + <type scope="com::sun::star::embed">StorageFormats</type>. + If the property is not provided a storage of package format + is created. + </dd> + </dl> + + <p> + The parameters are optional, that means that sequence can be empty or + contain only first parameter, or first and second one. In case + no parameters are provided the call works the same way as + <member scope="com::sun::star::lang">XSingleServiceFactory::createInstance</member>. + In case only first parameter is provided, the storage is opened in + readonly mode. + </p> + + <p> + The opened root storage can support read access in addition to + specified one. + </p> +*/ published service StorageFactory -{ - // ---------------------------------------------------------------------- - /** A storage can be created through this interface. - - <p> - In case - <method scope="com::sun::star::lang">XSingleServiceFactory::createInstance</method> - call is used the result storage will be open in read-write mode based - on an arbitrary medium. - </p> - - <p> - In case - <method scope="com::sun::star::lang">XSingleServiceFactory::createInstanceWithArguments</method> - call is used a sequence of the following parameters can be used: - </p> - - <dl> - <dt>parameter 1</dt> - <dd> - specifies source of the object, it can be a string - containing URL, an - <type scope="com::sun::star::io">XStream</type> - implementation or - <type scope="com::sun::star::io">XInputStream</type>; - in case of - <type scope="com::sun::star::io">XStream</type> - implementation - the <type scope="com::sun::star::io">XSeekable</type> - interface must be supported. - </dd> - - <dt>parameter 2</dt> - <dd> - specifies mode the storage should be open in, can take - values from <type>ElementModes</type> constant set. - </dd> - - <dt>parameter 3</dt> - <dd> - this parameter represents - <type scope="com::sun::star::uno">Any</type> - containing a sequence of - <type scope="com::sun::star::beans">PropertyValue</type>.<br> - The parameter can contain entries from - <type scope="com::sun::star::document">MediaDescryptor</type> - to transport some document info during the storage - initialization, it can be for example - <type scope="com::sun::star::task">XInteractionHandler</type> - implementation, password for the storage and repair - package flag.<br> - Additionally the parameter might contain property with the name - "StorageFormat" that can take values from - <type scope="com::sun::star::embed">StorageFormats</type>. - If the property is not provided a storage of package format - is created. - </dd> - </dl> - - <p> - The parameters are optional, that means that sequence can be empty or - contain only first parameter, or first and second one. In case - no parameters are provided the call works the same way as - <member scope="com::sun::star::lang">XSingleServiceFactory::createInstance</member>. - In case only first parameter is provided, the storage is opened in - readonly mode. - </p> - - <p> - The opened root storage can support read access in addition to - specified one. - </p> - */ - interface ::com::sun::star::lang::XSingleServiceFactory; -}; + : ::com::sun::star::lang::XSingleServiceFactory; //============================================================================ |