ooodev.adapter.awt.grid.grid_data_events module

class ooodev.adapter.awt.grid.grid_data_events.GridDataEvents(trigger_args=None, cb=None, listener=None)[source]

Bases: object

Class for managing Grid Data Events.

This class is usually inherited by control classes that implement com.sun.star.awt.grid.XGridDataListener.

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

Return type:

None

add_event_data_changed(cb)[source]

Adds a listener for an event.

Event is invoked when existing data in a grid control’s data model has been modified.

The callback EventArgs.event_data will contain a UNO com.sun.star.awt.grid.GridDataEvent struct.

Return type:

None

Parameters:

cb (Any) –

add_event_grid_data_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) –

add_event_row_heading_changed(cb)[source]

Adds a listener for an event.

EEvent is invoked when the title of one or more rows changed.

The callback EventArgs.event_data will contain a UNO com.sun.star.awt.grid.GridDataEvent struct.

Return type:

None

Parameters:

cb (Any) –

add_event_rows_inserted(cb)[source]

Adds a listener for an event.

Event is invoked when one or more rows of data have been inserted into a grid control’s data model.is invoked when the title of one or more rows changed.

The callback EventArgs.event_data will contain a UNO com.sun.star.awt.grid.GridDataEvent struct.

Return type:

None

Parameters:

cb (Any) –

add_event_rows_removed(cb)[source]

Adds a listener for an event.

Event is is invoked when one or more rows of data have been removed from a grid control’s data model.

The callback EventArgs.event_data will contain a UNO com.sun.star.awt.grid.GridDataEvent struct.

Return type:

None

Parameters:

cb (Any) –

remove_event_data_changed(cb)[source]

Removes a listener for an event

Return type:

None

Parameters:

cb (Any) –

remove_event_grid_data_events_disposing(cb)[source]

Removes a listener for an event

Return type:

None

Parameters:

cb (Any) –

remove_event_row_heading_changed(cb)[source]

Removes a listener for an event

Return type:

None

Parameters:

cb (Any) –

remove_event_rows_inserted(cb)[source]

Removes a listener for an event

Return type:

None

Parameters:

cb (Any) –

remove_event_rows_removed(cb)[source]

Removes a listener for an event

Return type:

None

Parameters:

cb (Any) –

property events_listener_grid_data: GridDataListener

Returns listener

Return type:

GridDataListener

ooodev.adapter.awt.grid.grid_data_events.on_lazy_cb(source, event)[source]

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 GridDataEvents 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.