ooodev.adapter.awt.item_list_listener module

class ooodev.adapter.awt.item_list_listener.ItemListListener(trigger_args=None, subscriber=None)[source]

Bases: AdapterBase, XItemListListener

Describes a listener for changes in an item list

See also

API XItemListListener

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

Return type:

None

allItemsRemoved(Event)[source]

Event is invoked when the list has been completely cleared, i.e. after an invocation of XItemList.removeAllItems()

Parameters:

  • event (EventObject) – Event data for the event.

  • Event (com.sun.star.lang.EventObject) –

Return type:

None

disposing(Source)[source]

Gets invoked 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.

  • Source (com.sun.star.lang.EventObject) –

Return type:

None

itemListChanged(Event)[source]

Event is invoked when the changes to the item list which occurred are too complex to be notified in single events.

Consumers of this event should discard their cached information about the current item list, and completely refresh it from the XItemList’s current state.

Parameters:

  • event (EventObject) – Event data for the event.

  • Event (com.sun.star.lang.EventObject) –

Return type:

None

listItemInserted(Event)[source]

Event is invoked when an item is inserted into the list.

Parameters:

  • event (ItemListEvent) – Event data for the event.

  • Event (com.sun.star.awt.ItemListEvent) –

Return type:

None

listItemModified(Event)[source]

Event is invoked when an item in the list is modified, i.e. its text or image changed.

Parameters:

  • event (ItemListEvent) – Event data for the event.

  • Event (com.sun.star.awt.ItemListEvent) –

Return type:

None

listItemRemoved(Event)[source]

Event is invoked when an item is removed from the list.

Parameters:

  • event (ItemListEvent) – Event data for the event.

  • Event (com.sun.star.awt.ItemListEvent) –

Return type:

None