ooodev.adapter.tree.tree_data_model_listener module

class ooodev.adapter.tree.tree_data_model_listener.TreeDataModelListener(trigger_args=None)[source]

Bases: AdapterBase, XTreeDataModelListener

An instance of this interface is used by the TreeControl to get notifications about data model changes.

Usually you must not implement this interface yourself as it is already handled by the TreeControl, but you must notify it correctly if you implement the XTreeDataModel yourself.

See also

API XTreeDataModelListener

Parameters:

args (Any) –
kwargs (Any) –

Return type:

Any

__init__(trigger_args=None)[source]

Constructor:

Parameters:: trigger_args (GenericArgs, optional) – Args that are passed to events when they are triggered.
Return type:: None

disposing(Source)[source]

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

Return type:: None
Parameters:: Source (com.sun.star.lang.EventObject) –

treeNodesChanged(Event)[source]

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.

Return type:: None
Parameters:: Event (com.sun.star.awt.tree.TreeDataModelEvent) –

treeNodesInserted(Event)[source]

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

Return type:: None
Parameters:: Event (com.sun.star.awt.tree.TreeDataModelEvent) –

treeNodesRemoved(Event)[source]

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

Return type:: None
Parameters:: Event (com.sun.star.awt.tree.TreeDataModelEvent) –

treeStructureChanged(Event)[source]

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.

Return type:: None
Parameters:: Event (com.sun.star.awt.tree.TreeDataModelEvent) –