Language

The Free and Open Productivity Suite
Released: Apache OpenOffice 4.1.10

API

SDK

Tips ‘n’ Tricks

Miscellaneous


:: com :: sun :: star :: ui ::

unpublished interface XUIConfigurationStorage
Usage Restrictions
not published
Description
supplies functions to change or get information about the storage of a user interface configuration manager.
Since
OOo 2.0

Methods' Summary
setStorage connects a storage to the user interface configuration manager which is used on subsequent calls of load and store.  
hasStorage checks if an instance has already a storage to load/store its data.  
Methods' Details
setStorage
void
setStorage( [in] ::com::sun::star::embed::XStorage  Storage );

Description
connects a storage to the user interface configuration manager which is used on subsequent calls of load and store.
Parameter Storage
all configuration data is loaded/stored from/into this storage. If the storage is in read/write mode load and store can be used otherwise only load is possible.

This call needs careful usage as data loss can occur. If the implementation has modified data and a new storage is set the implementation is not allowed to write back the data to the old storage. This must be done explicitly with store. In general a user interface configuration manager instance is created and initialize by the document model or the module user interface configuration supplier. Normally there is no need to set a storage for a user interface configuration manager. If a copy of the configuration data to another storage should be made, use storeToStorage.

hasStorage
boolean
hasStorage();

Description
checks if an instance has already a storage to load/store its data.
Returns
true if the instance has a storage otherwise false.
Top of Page

Apache Software Foundation

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

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