ooodev.adapter.util.changes_listener module

class ooodev.adapter.util.changes_listener.ChangesListener(trigger_args=None, subscriber=None, **kwargs)

Bases: AdapterBase, XChangesListener

Receives events from batch change broadcaster objects.

See also

API XChangesListener

New in version 0.19.1.

Parameters:

• args (Any) –

• kwargs (Any) –

Return type:

Any

__init__(trigger_args=None, subscriber=None, **kwargs)

Constructor

Parameters:

• trigger_args (GenericArgs, Optional) – Args that are passed to events when they are triggered.

• subscriber (XChangesNotifier, optional) – An UNO object that implements the XChangesNotifier interface. If passed in then this listener instance is automatically added to it.

Return type:

None

changesOccurred(event)

Is invoked when a batch of changes occurred.

Return type:

None

Parameters:

event (com.sun.star.util.ChangesEvent) –

disposing(event)

Gets invoked when the broadcaster is about to be disposed.

All listeners and all other objects, which reference the broadcaster should release the reference to the source. No method should be invoked anymore on this object ( including XComponent.removeEventListener() ).

This method is called for every listener registration of derived listener interfaced, not only for registrations at XComponent.

Return type:

None

Parameters:

event (com.sun.star.lang.EventObject) –