ooodev.adapter.beans.vetoable_change_events module

class ooodev.adapter.beans.vetoable_change_events.VetoableChangeEvents(trigger_args=None, cb=None, listener=None)[source]

Bases: object

Class for managing Vetoable Change Events.

Parameters:
__init__(trigger_args=None, cb=None, listener=None)[source]

Constructor

Parameters:
  • trigger_args (GenericArgs, optional) – Args that are passed to events when they are triggered. This only applies if the listener is not passed.

  • cb (ListenerEventCallbackT | None, optional) – Callback that is invoked when an event is added or removed.

  • listener (VetoableChangeListener | None, optional) – Listener that is used to manage events.

Return type:

None

add_event_vetoable_change(cb)[source]

Adds a listener for an event.

Event is invoked when bound properties are changed.

The callback EventArgs.event_data will contain a com.sun.star.beans.PropertyChangeEvent struct.

Return type:

None

Parameters:

cb (Any) –

add_event_vetoable_change_events_disposing(cb)[source]

Adds a listener for an event.

Event is invoked when the broadcaster is about to be disposed.

The callback EventArgs.event_data will contain a UNO com.sun.star.lang.EventObject struct.

Return type:

None

Parameters:

cb (Any) –

remove_event_vetoable_change(cb)[source]

Removes a listener for an event

Return type:

None

Parameters:

cb (Any) –

remove_event_vetoable_change_events_disposing(cb)[source]

Removes a listener for an event

Return type:

None

Parameters:

cb (Any) –

property events_listener_vetoable_change: VetoableChangeListener

Returns listener

Return type:

VetoableChangeListener