ooodev.adapter.ui.ui_configuration_events module

class ooodev.adapter.ui.ui_configuration_events.UIConfigurationEvents(trigger_args=None, cb=None, listener=None, subscriber=None)[source]

Bases: object

Class for managing UI Configuration Events.

Parameters:

trigger_args (GenericArgs | None) –
cb (ListenerEventCallbackT | None) –
listener (UIConfigurationListener | None) –
subscriber (XUIConfiguration | None) –

__init__(trigger_args=None, cb=None, listener=None, subscriber=None)[source]

Constructor

Parameters:

trigger_args (GenericArgs, optional) – Args that are passed to events when they are triggered. This only applies if the listener is not passed.
cb (ListenerEventCallbackT | None, optional) – Callback that is invoked when an event is added or removed.
listener (UIConfigurationListener | None, optional) – Listener that is used to manage events.
subscriber (XUIConfiguration, optional) – An UNO object that implements com.sun.star.ui.XUIConfiguration. If passed in then this instance listener is automatically added to it.

Return type:

None

add_event_element_inserted(cb)[source]

Adds a listener for an event.

Event is when a configuration has inserted an user interface element.

The callback EventArgs.event_data will contain a UNO com.sun.star.ui.ConfigurationEvent struct.

Return type:: None
Parameters:: cb (Any) –

add_event_element_removed(cb)[source]

Adds a listener for an event.

Event is invoked when a configuration has removed an user interface element.

The callback EventArgs.event_data will contain a UNO com.sun.star.ui.ConfigurationEvent struct.

Return type:: None
Parameters:: cb (Any) –

add_event_element_replaced(cb)[source]

Adds a listener for an event.

Event invoked when a configuration has replaced an user interface element.

The callback EventArgs.event_data will contain a UNO com.sun.star.ui.ConfigurationEvent struct.

Return type:: None
Parameters:: cb (Any) –

add_event_ui_configuration_disposing(cb)[source]

Adds a listener for an event.

Event is invoked when the broadcaster is about to be disposed.

The callback EventArgs.event_data will contain a UNO com.sun.star.lang.EventObject struct.

Return type:: None
Parameters:: cb (Any) –

remove_event_element_inserted(cb)[source]

Removes a listener for an event

Return type:: None
Parameters:: cb (Any) –

remove_event_element_removed(cb)[source]

Removes a listener for an event

Return type:: None
Parameters:: cb (Any) –

remove_event_element_replaced(cb)[source]

Removes a listener for an event

Return type:: None
Parameters:: cb (Any) –

remove_event_ui_configuration_disposing(cb)[source]

Removes a listener for an event

Return type:: None
Parameters:: cb (Any) –

property events_listener_ui_configuration: UIConfigurationListener

Returns listener

Return type:: UIConfigurationListener

ooodev.adapter.ui.ui_configuration_events.on_lazy_cb(source, event)[source]

Callback that is invoked when an event is added or removed.

This method is generally used to add the listener to the component in a lazy manner. This means this callback will only be called once in the lifetime of the component.

Parameters:

source (Any) – Expected to be an instance of UIConfigurationEvents that is a partial class of a component based class.
event (ListenerEventArgs) – Event arguments.

Return type:

None

Warning

This method is intended for internal use only.