Language

The Free and Open Productivity Suite
Released: Apache OpenOffice 4.1.15

API

SDK

Tips ‘n’ Tricks

Miscellaneous

Overview Module Use Devguide Index
Methods' Summary Attributes' Summary Methods' Details Attributes' Details

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

interface XUIConfigurationPersistence
Description
specifies a persistence interface which supports to load/store user interface configuration data to a storage and to retrieve information about the current state.
Since
OOo 2.0
Methods' Summary
reload reloads the configuration data from the storage and reinitialize the user interface configuration manager instance with this data.  
store stores the configuration data to the storage provided by setStorage from the storage and initialize the user interface configuration manager instance with the newly data. This call can throw an ::com::sun::star::io::IOException if store cannot store its data into the internal storage.  
storeToStorage stores the configuration data to the provided storage, ignoring the previously set storage by setStorage. Can be used to make copy of the current user interface configuration data to another storage. This call will throw an ::com::sun::star::io::IOException if the provided storage is in read-only mode.  
isModified provides the current modify state of the configuration manager instance.  
isReadOnly provides the current read-only state of the user configuration manager. Storing a user interface configuration to a read-only storage is not possible. A read-only configuration manager instance will also not support any changes to its configuration settings.  
Methods' Details
reload
void
reload()
raises( ::com::sun::star::uno::Exception );
Description
reloads the configuration data from the storage and reinitialize the user interface configuration manager instance with this data.

It is up to the implementation if it defers the first loading process until the first data request using XUIConfigurationManager interface.

store
void
store()
raises( ::com::sun::star::uno::Exception );
Description
stores the configuration data to the storage provided by setStorage from the storage and initialize the user interface configuration manager instance with the newly data. This call can throw an ::com::sun::star::io::IOException if store cannot store its data into the internal storage.
storeToStorage
void
storeToStorage( [in] ::com::sun::star::embed::XStorage  Storage )
raises( ::com::sun::star::uno::Exception );
Description
stores the configuration data to the provided storage, ignoring the previously set storage by setStorage. Can be used to make copy of the current user interface configuration data to another storage. This call will throw an ::com::sun::star::io::IOException if the provided storage is in read-only mode.
Parameter Storage
all configuration data will be stored to this storage.
isModified
boolean
isModified();
Description
provides the current modify state of the configuration manager instance.
Returns
true if the configuration manager has changed since the last store call. false if the configuration manager has not been changed.
isReadOnly
boolean
isReadOnly();
Description
provides the current read-only state of the user configuration manager. Storing a user interface configuration to a read-only storage is not possible. A read-only configuration manager instance will also not support any changes to its configuration settings.
Returns
true if the configuration manager storage is read-only otherwise false.
Top of Page

Copyright © 2013, The Apache Software Foundation, Licensed under the Apache License, Version 2.0. Apache, the Apache feather logo, Apache OpenOffice and OpenOffice.org are trademarks of The Apache Software Foundation. Other names may be trademarks of their respective owners.

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.