ooodev.adapter.tree.tree_data_model_events module

class ooodev.adapter.tree.tree_data_model_events.TreeDataModelEvents(trigger_args=None, cb=None, listener=None)

Bases: object

Class for managing Tree Data Model Events.

Parameters:

• trigger_args (GenericArgs | None) –

• cb (ListenerEventCallbackT | None) –

• listener (TreeDataModelListener | None) –

__init__(trigger_args=None, cb=None, listener=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 (TreeDataModelListener | None, optional) – Listener that is used to manage events.

Return type:

None

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

add_event_tree_nodes_changed(cb)

Adds a listener for an event.

Event is invoked after a node (or a set of siblings) has changed in some way.

The node(s) have not changed locations in the tree or altered their children arrays, but other attributes have changed and may affect presentation.

Example: the name of a file has changed, but it is in the same location in the file system.

To indicate the root has changed, TreeDataModelEvent.Nodes will contain the root node and TreeDataModelEvent.ParentNode will be empty.

The callback EventArgs.event_data will contain a UNO com.sun.star.awt.tree.TreeDataModelEvent struct.

Return type:

None

Parameters:

cb (Any) –

add_event_tree_nodes_inserted(cb)

Adds a listener for an event.

Event is invoked after nodes have been inserted into the tree.

Use TreeDataModelEvent.ParentNode to get the parent of the new node(s). TreeDataModelEvent.Nodes contains the new node(s).

The callback EventArgs.event_data will contain a UNO com.sun.star.awt.tree.TreeDataModelEvent struct.

Return type:

None

Parameters:

cb (Any) –

add_event_tree_nodes_removed(cb)

Adds a listener for an event.

Event is invoked after nodes have been removed from the tree.

Note that if a subtree is removed from the tree, this method may only be invoked once for the root of the removed subtree, not once for each individual set of siblings removed.

Use TreeDataModelEvent.ParentNode to get the former parent of the deleted node(s). TreeDataModelEvent.Nodes contains the removed node(s).

The callback EventArgs.event_data will contain a UNO com.sun.star.awt.tree.TreeDataModelEvent struct.

Return type:

None

Parameters:

cb (Any) –

add_event_tree_structure_changed(cb)

Adds a listener for an event.

Event is invoked after the tree has drastically changed structure from a given node down.

Use TreeDataModelEvent.ParentNode to get the node which structure has changed. TreeDataModelEvent.Nodes is empty.

The callback EventArgs.event_data will contain a UNO com.sun.star.awt.tree.TreeDataModelEvent struct.

Return type:

None

Parameters:

cb (Any) –

remove_event_tree_data_model_events_disposing(cb)

Removes a listener for an event

Return type:

None

Parameters:

cb (Any) –

remove_event_tree_nodes_changed(cb)

Removes a listener for an event

Return type:

None

Parameters:

cb (Any) –

remove_event_tree_nodes_inserted(cb)

Removes a listener for an event

Return type:

None

Parameters:

cb (Any) –

remove_event_tree_nodes_removed(cb)

Removes a listener for an event

Return type:

None

Parameters:

cb (Any) –

remove_event_tree_structure_changed(cb)

Removes a listener for an event

Return type:

None

Parameters:

cb (Any) –

property events_listener_tree_data_model: TreeDataModelListener

Returns listener

Return type:

TreeDataModelListener

ooodev.adapter.tree.tree_data_model_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 TreeDataModelEvents 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.