:: 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
- 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
- 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
- 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
- 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
- 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 © 2012, 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.