ooodev.adapter.form.update_listener module

class ooodev.adapter.form.update_listener.UpdateListener(trigger_args=None, subscriber=None)[source]

Bases: AdapterBase, XUpdateListener

Used to listen on objects which allow updating their data.

In addition to just get notified when a data update happened, the listener has a chance to veto updates before they happen.

See also

API XUpdateListener

Parameters:

  • args (Any) –

  • kwargs (Any) –

Return type:

Any

__init__(trigger_args=None, subscriber=None)[source]

Constructor

Parameters:

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

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

Return type:

None

approveUpdate(aEvent)[source]

Event is invoked to check the current data.

If event is canceled then the update will be canceled.

Parameters:

  • event (EventObject) – Event data for the event.

  • aEvent (com.sun.star.lang.EventObject) –

Returns:

True if the update should be performed, False otherwise.

Return type:

bool

Note

When approveUpdate event is invoked it will contain a CancelEventArgs instance as the trigger event. When the event is triggered the CancelEventArgs.cancel can be set to True to cancel the update. Also if canceled the CancelEventArgs.handled can be set to True to indicate that the update should be performed. The CancelEventArgs.event_data will contain the original com.sun.star.lang.EventObject that triggered the update.

disposing(Source)[source]

Gets called 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.

Parameters:

  • event (EventObject) – Event data for the event.

  • Source (com.sun.star.lang.EventObject) –

Return type:

None

updated(aEvent)[source]

Event is invoked when an object has finished processing the updates and the data has been successfully written.

Parameters:

  • event (EventObject) – Event data for the event.

  • aEvent (com.sun.star.lang.EventObject) –

Return type:

None