ooodev.adapter.form.binding.list_entry_events module

class ooodev.adapter.form.binding.list_entry_events.ListEntryEvents(trigger_args=None, cb=None, listener=None, subscriber=None)

Bases: object

Class for managing List Entry Events.

Parameters:

• trigger_args (GenericArgs | None) –

• cb (ListenerEventCallbackT | None) –

• listener (ListEntryListener | None) –

• subscriber (XListEntrySource | None) –

__init__(trigger_args=None, cb=None, listener=None, subscriber=None)

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 (ListEntryListener | None, optional) – Listener that is used to manage events.

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

Return type:

None

add_event_all_entries_changed(cb)

Adds a listener for an event.

Notifies the listener that all entries of the list have changed.

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

The listener should retrieve the complete new list by calling the XListEntrySource.getAllListEntries() method of the event source (which is denoted by com.sun.star.lang.EventObject.Source).

Return type:

None

Parameters:

cb (Any) –

add_event_entry_changed(cb)

Adds a listener for an event.

Notifies the listener that a single entry in the list has change.

The callback EventArgs.event_data will contain a UNO com.sun.star.form.binding.ListEntryEvent struct.

Return type:

None

Parameters:

cb (Any) –

add_event_entry_range_inserted(cb)

Adds a listener for an event.

Notifies the listener that a range of entries has been inserted into the list.

The callback EventArgs.event_data will contain a UNO com.sun.star.form.binding.ListEntryEvent struct.

Return type:

None

Parameters:

cb (Any) –

add_event_entry_range_removed(cb)

Adds a listener for an event.

Notifies the listener that a range of entries has been removed from the list.

The callback EventArgs.event_data will contain a UNO com.sun.star.form.binding.ListEntryEvent struct.

Return type:

None

Parameters:

cb (Any) –

add_event_list_entry_listener_events_disposing(cb)

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_all_entries_changed(cb)

Removes a listener for an event

Return type:

None

Parameters:

cb (Any) –

remove_event_entry_changed(cb)

Removes a listener for an event

Return type:

None

Parameters:

cb (Any) –

remove_event_entry_range_inserted(cb)

Removes a listener for an event

Return type:

None

Parameters:

cb (Any) –

remove_event_entry_range_removed(cb)

Removes a listener for an event

Return type:

None

Parameters:

cb (Any) –

remove_event_list_entry_listener_events_disposing(cb)

Removes a listener for an event

Return type:

None

Parameters:

cb (Any) –

property events_listener_list_entry: ListEntryListener

Returns listener

Return type:

ListEntryListener

ooodev.adapter.form.binding.list_entry_events.on_lazy_cb(source, event)

Callback that is invoked when an event is added or removed.

This method is generally used to add the listener to the component in a lazy manner. This means this callback will only be called once in the lifetime of the component.

Parameters:

• source (Any) – Expected to be an instance of ListEntryEvents that is a partial class of a component based class.

• event (ListenerEventArgs) – Event arguments.

Return type:

None

Warning

This method is intended for internal use only.