ooodev.adapter.form.reset_listener module

class ooodev.adapter.form.reset_listener.ResetListener(trigger_args=None, subscriber=None)

Bases: AdapterBase, XResetListener

Is the interface for receiving notifications about reset events.

The listener is called if a component implementing the XReset interface performs a reset.Order of events:

See also

API XResetListener

Parameters:

• args (Any) –

• kwargs (Any) –

Return type:

Any

__init__(trigger_args=None, subscriber=None)

Constructor

Parameters:

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

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

Return type:

None

approveReset(event)

Event is invoked is invoked before a component is reset.

If event is canceled then the reset will be canceled.

Parameters:

event (EventObject) – Event data for the event.

Returns:

True if the rest should be performed, False otherwise.

Return type:

bool

Note

When approveReset 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 reset. Also if canceled the CancelEventArgs.handled can be set to True to indicate that the reset should be performed. The CancelEventArgs.event_data will contain the original com.sun.star.lang.EventObject that triggered the update.

disposing(event)

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

resetted(event)

Event is invoked when a component has been reset.

Parameters:

event (EventObject) – TEvent data for the event.

Return type:

None