ooodev.adapter.ui.module_ui_configuration_manager_comp module

class ooodev.adapter.ui.module_ui_configuration_manager_comp.ModuleUIConfigurationManagerComp(component)[source]

Class for managing ModuleUIConfigurationManager Component.

__init__(component)[source]

Constructor

Parameters:: component (ModuleUIConfigurationManager) – UNO ModuleUIConfigurationManager Component that supports com.sun.star.ui.ModuleUIConfigurationManager service.
Return type:: None

create_default(module_short_name, module_identifier)[source]

Provides a function to initialize a module user interface configuration manager instance.

A module user interface configuration manager instance needs the following arguments as com.sun.star.beans.PropertyValue to be in a working state:

DefaultConfigStorage a reference to a com.sun.star.embed.Storage that contains the default module user interface configuration settings.
UserConfigStorage a reference to a com.sun.star.embed.Storage that contains the user-defined module user interface configuration settings.
ModuleIdentifier string that provides the module identifier.
UserRootCommit a reference to a com.sun.star.embed.XTransactedObject which represents the customizable root storage. Every implementation must use this reference to commit its changes also at the root storage.

A non-initialized module user interface configuration manager cannot be used, it is treated as a read-only container.

Raises:

com.sun.star.configuration.CorruptedUIConfigurationException – CorruptedUIConfigurationException
com.sun.star.beans.UnknownPropertyException – UnknownPropertyException
com.sun.star.lang.WrappedTargetException – WrappedTargetException

Return type:

None

Parameters:

has_settings(resource_url)[source]

Determines if the settings of a user interface element is part the user interface configuration manager.

property component: com.sun.star.ui.ModuleUIConfigurationManager

ModuleUIConfigurationManager Component