Class CtlTree

Introduction

Class for working with tree controls in a dialog.

EventArgsCallbackT

All EventArgsCallbackT callbacks include control_src as a keyword argument.

A callback can be in the format of:

def on_some_event(
    src: Any, event: EventArgs, control_src: CtlTree, *args, **kwargs
) -> None:
    pass

or

def on_some_event(src: Any, event: EventArgs, *args, **kwargs) -> None:
    # can get control from kwargs
    ctl = cast(CtlTree, kwargs['control_src'])

Example

For an example see Tab and Tree Dialog Example

Class

class ooodev.dialog.dl_control.CtlTree(ctl)[source]

Bases: DialogControlBase, TreeControlModelPartial, SelectionChangeEvents, TreeEditEvents, TreeExpansionEvents

Class for Tree Control

__init__(ctl)[source]

Constructor

Parameters:: ctl (TreeControl) – Tree Control
Return type:: None

add_event_focus_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_focus_gained(cb)

Adds a listener for an event.

Event is invoked when a window gains the keyboard focus.

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

Return type:: None
Parameters:: cb (Any) –

add_event_focus_lost(cb)

Adds a listener for an event.

Event is invoked when a window loses the keyboard focus.

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

Return type:: None
Parameters:: cb (Any) –

add_event_key_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_key_pressed(cb)

Adds a listener for an event.

Event is invoked when a key has been pressed.

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

Return type:: None
Parameters:: cb (Any) –

add_event_key_released(cb)

Adds a listener for an event.

Event is invoked when a key has been released.

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

Return type:: None
Parameters:: cb (Any) –

add_event_listener(listener)

Adds an event listener to the component.

Parameters:: listener (XEventListener) – The event listener to be added.
Return type:: None

add_event_mouse_dragged(cb)

Adds a listener for an event.

Event is invoked when a mouse button is pressed on a window and then dragged.

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

Return type:: None
Parameters:: cb (Any) –

add_event_mouse_entered(cb)

Adds a listener for an event.

Event is invoked when the mouse enters a window.

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

Return type:: None
Parameters:: cb (Any) –

add_event_mouse_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_mouse_exited(cb)

Adds a listener for an event.

Event is invoked when the mouse exits a window.

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

Return type:: None
Parameters:: cb (Any) –

add_event_mouse_motion_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_mouse_moved(cb)

Adds a listener for an event.

Event Is invoked when the mouse pointer has been moved on a window (with no buttons down).

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

Return type:: None
Parameters:: cb (Any) –

add_event_mouse_pressed(cb)

Adds a listener for an event.

Event is invoked when a mouse button has been pressed on a window.

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

Return type:: None
Parameters:: cb (Any) –

add_event_mouse_released(cb)

Adds a listener for an event.

Event is invoked when a mouse button has been released on a window.

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

Return type:: None
Parameters:: cb (Any) –

add_event_node_edited(cb)

Adds a listener for an event.

Event is invoked from the TreeControl implementation when editing of Node is finished and was not canceled.

Note

The callback EventArgs.event_data will contain a NodeEditedArgs object.

Return type:: None
Parameters:: cb (Any) –

add_event_node_editing(cb)

Adds a listener for an event.

Event is invoked after a tab page was activated.

The callback EventArgs.event_data will contain a UNO object that implements XTreeNode.

Return type:: None
Parameters:: cb (Any) –

add_event_observers(*args)

Adds observers that gets their trigger method called when this class trigger method is called.

Parameters:: args (EventObserver) – One or more observers to add.
Return type:: None

Note

Observers are removed automatically when they are out of scope.

add_event_paint_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_properties_change(names, cb)

Add properties to listen for changes.

Parameters:

names (Iterable[str]) – One or more property names to listen for changes.
cb (EventArgsCallbackT) – Callback that is invoked when an event is triggered.

Raises:

ValueError – If names is empty.

Return type:

None

Note

The callback EventArgs.event_data will contain a tuple of com.sun.star.beans.PropertyChangeEvent objects.

Each time this method is called, the previous names are removed and the new names are added.

add_event_property_change(name, cb)

Adds a listener for an event.

Event is invoked when property is changed.

The callback EventArgs.event_data will contain a com.sun.star.beans.PropertyChangeEvent struct.

Parameters:

name (str) – Property Name
cb (EventArgsCallbackT) – Callback

Return type:

None

add_event_property_change_events_disposing(name, cb)

Adds a listener for an event.

Event is invoked when the property listener is about to be disposed.

The callback EventArgs.event_data will contain a UNO com.sun.star.lang.EventObject struct.

Parameters:

name (str) – Property Name
cb (EventArgsCallbackT) – Callback

Return type:

None

add_event_request_child_nodes(cb)

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 UNO com.sun.star.awt.tree.TreeExpansionEvent struct.

Return type:: None
Parameters:: cb (Any) –

add_event_selection_change_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_selection_changed(cb)

Adds a listener for an event.

Event is invoked when the selection changes.

The callback EventArgs.event_data will contain a UNO com.sun.star.lang.EventObject struct.

Return type:: None
Parameters:: cb (Any) –

add_event_tree_collapsed(cb)

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 UNO com.sun.star.awt.tree.TreeExpansionEvent struct.

Return type:: None
Parameters:: cb (Any) –

add_event_tree_collapsing(cb)

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 UNO com.sun.star.awt.tree.TreeExpansionEvent struct.

Return type:: None
Parameters:: cb (Any) –

add_event_tree_edit_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_expanded(cb)

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 UNO com.sun.star.awt.tree.TreeExpansionEvent struct.

Return type:: None
Parameters:: cb (Any) –

add_event_tree_expanding(cb)

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 UNO com.sun.star.awt.tree.TreeExpansionEvent struct.

Return type:: None
Parameters:: cb (Any) –

add_event_tree_expansion_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_vetoable_change(name, cb)

Adds a listener for an event.

Event is invoked when property is changed.

The callback EventArgs.event_data will contain a com.sun.star.beans.PropertyChangeEvent struct.

Parameters:

name (str) – Property Name
cb (EventArgsCallbackT) – Callback

Return type:

None

add_event_vetoable_change_events_disposing(name, cb)

Adds a listener for an event.

Event is invoked when the property listener is about to be disposed.

The callback EventArgs.event_data will contain a UNO com.sun.star.lang.EventObject struct.

Parameters:

name (str) – Property Name
cb (EventArgsCallbackT) – Callback

Return type:

None

add_event_window_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_window_hidden(cb)

Adds a listener for an event.

Event is invoked when the window has been hidden.

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

Return type:: None
Parameters:: cb (Any) –

add_event_window_moved(cb)

Adds a listener for an event.

Event is invoked when the window has been moved.

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

Return type:: None
Parameters:: cb (Any) –

add_event_window_paint(cb)

Adds a listener for an event.

Event Is invoked when a region of the window became invalid, e.g. when another window has been moved away.

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

Return type:: None
Parameters:: cb (Any) –

add_event_window_resized(cb)

Adds a listener for an event.

Event is invoked when the window has been resized.

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

Return type:: None
Parameters:: cb (Any) –

add_event_window_shown(cb)

Adds a listener for an event.

Event is invoked when the window has been shown.

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

Return type:: None
Parameters:: cb (Any) –

add_property_change_listener(name, listener)

Adds a listener for property changes.

Parameters:

name (str) – The name of the property.
listener (Any) – The listener to be added.

Return type:

None

add_sub_node(parent_node, display_value='', data_value=None)[source]

Adds a sub node to the parent node

Parameters:

parent_node (XMutableTreeNode) – Parent node
display_value (str, optional) – display value for the Node.
data_value (Any, optional) – Specifies any value associated with the node. Must be a type understood by UNO, such as a string, int, float, a struct such as UnoDateTime, etc. Defaults to None.

Returns:

MutableTreeNode

Return type:

XMutableTreeNode

add_sub_tree(flat_tree, parent_node=None)[source]

Adds a sub tree to the parent node

Parameters:

parent_node (XMutableTreeNode) – Parent node.
flat_tree (Sequence[Sequence[str]]) – FlatTree: a 2D sequence of strings, sorted on the columns containing the DisplayValues
width_data (bool, optional) – _description_. Defaults to False.

Return type:

None

Note

The same data structure for tree_data can be used to add sub-nodes as shown in convert_to_tree().

Return type:

None

Parameters:

flat_tree (Sequence[Any]) –
parent_node (XMutableTreeNode | None) –

add_vetoable_change_listener(name, listener)

Adds a listener for vetoable changes.

Parameters:

name (str) – The name of the property.
listener (Any) – The listener to be added.

Return type:

None

apply_styles(*styles)

Applies styles to control

Parameters:: *styles (StyleT) – Styles to apply
Return type:: None

convert_to_tree(flat_tree)[source]

Converts a flat tree to a tree

Parameters:: flat_tree (Sequence[Sequence[str]]) – FlatTree: a 2D sequence of strings, sorted on the columns containing the DisplayValues
Returns:: A tree
Return type:: dict

Notes

The flat tree can be a sequence of sequence of strings or a sequence of sequence of sequence.

Example sequence of sequence of strings:

This example uses a List of List of strings. It would alo work with a tuple of tuple of strings.

[
    ["A1", "B1", "C1"],
    ["A1", "B1", "C2"],
    ["A1", "B2", "C3"],
    ["A2", "B3", "C4"],
    ["A2", "B3", "C5"],
    ["A2", "B3", "C6"],
    ["A2", "B4", "Razor"],
]

The result will be as follows:

Example sequence of sequence of sequence:

This example uses includes data values that are to be assigned to the nodes.

Data values can be any type understood by UNO, such as a string, int, float, a struct such as UnoDateTime, etc. List and tuple can be interchanged and still work.

In this example A1 will have a data value of 1 and B1 will have a data value of now_date. The first data value that is encountered will be assigned to the node’s DataValue property. All other data values for that node will be ignored.

now_date = DateUtil.date_to_uno_date_time(datetime.datetime.now())

[
    [("A1", 1), ("B1", now_date), ("C1", None)],
    [("A1", "ignored"), ("B1", None), ("C2", "Data4")],
    [("A1",), ("B2", "Data5"), ("C3", "Data6")],
    [("A2", 33), ("B3", "Data8"), ("C4", "Data9")],
    [("A2", "Data7"), ("B3", "Data8"), ("C5", "Data10")],
    [("A2", "Data7"), ("B3", "Data8"), ("C6", "Data11")],
]

The result will be as follows:

The B1 Node will look something like this:

The input is rather flexible. The following would also work:

Note that A2 contains too many values. The first two will be used and the rest ignored. The A2 node will have a text value of A2 and a data value of 33.

[
    [["A1", 1], ["B1", now_date], ["C1"]],
    [["A1"], ["B1"], ["C2"]],
    [["A1"], ["B2"], ["C3"]],
    [["A2", 33, 66, 127], ["B3", "Data8"], ["C4", "Data9"]],
    [["A2"], ["B3", "Data8"], ["C5", "Data10"]],
    [["A2"], ["B3", None], ["C6", "Data11"]],
]