ooodev.adapter.ui.ui_configuration_storage_partial module

class ooodev.adapter.ui.ui_configuration_storage_partial.UIConfigurationStoragePartial(component, interface=com.sun.star.ui.XUIConfigurationStorage)[source]

Bases: object

Partial Class for XUIConfigurationStorage.

Parameters:
  • component (XUIConfigurationStorage) –

  • interface (UnoInterface | None) –

__init__(component, interface=com.sun.star.ui.XUIConfigurationStorage)[source]

Constructor

Parameters:
  • component (XUIConfigurationStorage) – UNO Component that implements com.sun.star.ui.XUIConfigurationStorage.

  • interface (UnoInterface, optional) – The interface to be validated. Defaults to XUIConfigurationStorage.

Return type:

None

has_storage()[source]

Checks if an instance has already a storage to load/store its data.

Return type:

bool

set_storage(storage)[source]

Connects a storage to the user interface configuration manager which is used on subsequent calls of load() and store().

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().

Return type:

None

Parameters:

storage (com.sun.star.embed.XStorage) –

ooodev.adapter.ui.ui_configuration_storage_partial.get_builder(component)[source]

Get the builder for the component.

Parameters:

component (Any) – The component.

Returns:

Builder instance.

Return type:

DefaultBuilder