ooodev.adapter.form.approve_action_listener module

class ooodev.adapter.form.approve_action_listener.ApproveActionListener(trigger_args=None, subscriber=None)

Bases: AdapterBase, XApproveActionListener

Can be implemented to listen and probably veto actions to be performed on components.

An example for an action would be the click of a CommandButton.

See also

API XApproveActionListener

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 (XApproveActionBroadcaster, optional) – An UNO object that implements the XApproveActionBroadcaster interface. If passed in then this listener instance is automatically added to it.

Return type:

None

approveAction(event)

Event is invoked when an action is preformed. If event is canceled then the action will be canceled.

Parameters:

event (EventObject) – Event data for the event.

Returns:

True if the action should be performed, False otherwise.

Return type:

bool

Note

When approveAction 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 action. Also if canceled the CancelEventArgs.handled can be set to True to indicate that the action 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.

Return type:

None

Parameters:

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