ooodev.adapter.ui.ui_configuration_persistence_partial module
- class ooodev.adapter.ui.ui_configuration_persistence_partial.UIConfigurationPersistencePartial(component, interface=com.sun.star.ui.XUIConfigurationPersistence)[source]
Bases:
object
Partial Class for XUIConfigurationPersistence.
- Parameters:
component (XUIConfigurationPersistence) –
interface (UnoInterface | None) –
- __init__(component, interface=com.sun.star.ui.XUIConfigurationPersistence)[source]
Constructor
- Parameters:
component (XUIConfigurationPersistence) – UNO Component that implements
com.sun.star.ui.XUIConfigurationPersistence
.interface (UnoInterface, optional) – The interface to be validated. Defaults to
XUIConfigurationPersistence
.
- Return type:
None
- is_modified()[source]
Provides the current modify state of the configuration manager instance.
- Return type:
bool
- is_read_only()[source]
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.
- Return type:
bool
- reload()[source]
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.- Raises:
com.sun.star.uno.Exception –
Exception
- Return type:
None
- store()[source]
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
ifstore()
cannot store its data into the internal storage.- Raises:
com.sun.star.uno.Exception –
Exception
- Return type:
None
- store_to_storage(storage)[source]
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.
- Raises:
com.sun.star.uno.Exception –
Exception
- Return type:
None
- Parameters:
storage (com.sun.star.embed.XStorage) –