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
- 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(event)[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.
- Returns:
True
if the update should be performed,False
otherwise.- Return type:
bool
Note
When
approveUpdate
event is invoked it will contain aCancelEventArgs
instance as the trigger event. When the event is triggered theCancelEventArgs.cancel
can be set toTrue
to cancel the update. Also if canceled theCancelEventArgs.handled
can be set toTrue
to indicate that the update should be performed. TheCancelEventArgs.event_data
will contain the originalcom.sun.star.lang.EventObject
that triggered the update.
- disposing(event)[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.
- Return type:
None