ooodev.adapter.awt.tree.tree_expansion_listener module

class ooodev.adapter.awt.tree.tree_expansion_listener.TreeExpansionListener(trigger_args=None, subscriber=None)[source]

Bases: AdapterBase, XTreeExpansionListener

An instance of this interface can get notifications from a TreeControl when nodes are expanded or collapsed.

See also

API XTreeExpansionListener

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

Return type:

None

disposing(event)[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:: event (com.sun.star.lang.EventObject) –

requestChildNodes(event)[source]

Invoked when a node with children on demand is about to be expanded.

This event is invoked before the treeExpanding() event.

Return type:: None
Parameters:: event (com.sun.star.awt.tree.TreeExpansionEvent) –

treeCollapsed(event)[source]

Called whenever a node in the tree has been successfully collapsed.

Return type:: None
Parameters:: event (com.sun.star.awt.tree.TreeExpansionEvent) –

treeCollapsing(event)[source]

Invoked whenever a node in the tree is about to be collapsed.

Raises:: ExpandVetoException – ExpandVetoException
Return type:: None
Parameters:: event (com.sun.star.awt.tree.TreeExpansionEvent) –

treeExpanded(event)[source]

Invoked whenever a node in the tree has been successfully expanded.

Return type:: None
Parameters:: event (com.sun.star.awt.tree.TreeExpansionEvent) –

treeExpanding(event)[source]

Invoked whenever a node in the tree is about to be expanded.

Raises:: ExpandVetoException – ExpandVetoException
Return type:: None
Parameters:: event (com.sun.star.awt.tree.TreeExpansionEvent) –