ooodev.adapter.awt.tree.tree_expansion_events module
- class ooodev.adapter.awt.tree.tree_expansion_events.TreeExpansionEvents(trigger_args=None, cb=None, listener=None, subscriber=None)[source]
Bases:
object
Class for managing Tree Expansion Events.
This class is usually inherited by control classes that implement
com.sun.star.awt.tree.XTreeExpansionListener
.- Parameters:
trigger_args (GenericArgs | None) –
cb (ListenerEventCallbackT | None) –
listener (TreeExpansionListener | None) –
subscriber (XTreeControl | None) –
- __init__(trigger_args=None, cb=None, listener=None, subscriber=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 (TreeExpansionListener | None, optional) – Listener that is used to manage events.
subscriber (XTreeControl, optional) – An UNO object that implements the
XTreeControl
interface. If passed in then this instance listener is automatically added to it.
- Return type:
None
- add_event_request_child_nodes(cb)[source]
Adds a listener for an event.
Event is invoked when a node with children on demand is about to be expanded.
The callback
EventArgs.event_data
will contain a UNOcom.sun.star.awt.tree.TreeExpansionEvent
struct.- Return type:
None
- Parameters:
cb (Any) –
- add_event_tree_collapsed(cb)[source]
Adds a listener for an event.
Event is invoked whenever a node in the tree has been successfully collapsed.
The callback
EventArgs.event_data
will contain a UNOcom.sun.star.awt.tree.TreeExpansionEvent
struct.- Return type:
None
- Parameters:
cb (Any) –
- add_event_tree_collapsing(cb)[source]
Adds a listener for an event.
Event is invoked whenever a node in the tree is about to be collapsed.
The callback
EventArgs.event_data
will contain a UNOcom.sun.star.awt.tree.TreeExpansionEvent
struct.- Return type:
None
- Parameters:
cb (Any) –
- add_event_tree_expanded(cb)[source]
Adds a listener for an event.
Event is invoked whenever a node in the tree has been successfully expanded.
The callback
EventArgs.event_data
will contain a UNOcom.sun.star.awt.tree.TreeExpansionEvent
struct.- Return type:
None
- Parameters:
cb (Any) –
- add_event_tree_expanding(cb)[source]
Adds a listener for an event.
Event is invoked whenever a node in the tree is about to be expanded.
The callback
EventArgs.event_data
will contain a UNOcom.sun.star.awt.tree.TreeExpansionEvent
struct.- Return type:
None
- Parameters:
cb (Any) –
- add_event_tree_expansion_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 UNOcom.sun.star.lang.EventObject
struct.- Return type:
None
- Parameters:
cb (Any) –
- remove_event_request_child_nodes(cb)[source]
Removes a listener for an event
- Return type:
None
- Parameters:
cb (Any) –
- remove_event_tree_collapsed(cb)[source]
Removes a listener for an event
- Return type:
None
- Parameters:
cb (Any) –
- remove_event_tree_collapsing(cb)[source]
Removes a listener for an event
- Return type:
None
- Parameters:
cb (Any) –
- remove_event_tree_expanded(cb)[source]
Removes a listener for an event
- Return type:
None
- Parameters:
cb (Any) –
- remove_event_tree_expanding(cb)[source]
Removes a listener for an event
- Return type:
None
- Parameters:
cb (Any) –
- remove_event_tree_expansion_events_disposing(cb)[source]
Removes a listener for an event
- Return type:
None
- Parameters:
cb (Any) –
- property events_listener_tree_expansion: TreeExpansionListener
Returns listener
- Return type:
- ooodev.adapter.awt.tree.tree_expansion_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 TreeExpansionEvents 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.