ooodev.adapter.ui.ui_configuration_partial module

class ooodev.adapter.ui.ui_configuration_partial.UIConfigurationPartial(component, interface=com.sun.star.ui.XUIConfiguration)[source]

Bases: object

Partial Class for XUIConfiguration.

Parameters:

  • component (XUIConfiguration) –

  • interface (UnoInterface | None) –

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

Constructor

Parameters:

  • component (XUIConfiguration) – UNO Component that implements com.sun.star.ui.XUIConfiguration.

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

Return type:

None

add_configuration_listener(listener)[source]

adds the specified listener to receive events when elements are changed, inserted or removed.

It is suggested to allow multiple registration of the same listener, thus for each time a listener is added, it has to be removed.

Return type:

None

Parameters:

listener (com.sun.star.ui.XUIConfigurationListener) –

remove_configuration_listener(listener)[source]

removes the specified listener so it does not receive any events from this user interface configuration manager.

It is suggested to allow multiple registration of the same listener, thus for each time a listener is added, it has to be removed.

Return type:

None

Parameters:

listener (com.sun.star.ui.XUIConfigurationListener) –

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

Get the builder for the component.

Parameters:

component (Any) – The component.

Returns:

Builder instance.

Return type:

DefaultBuilder