traitsui.tree_node_renderer module

class traitsui.tree_node_renderer.AbstractTreeNodeRenderer

Bases: traits.has_traits.ABCHasStrictTraits

Abstract base class for renderers of tree node items.

This is currently only supported for Qt.

get_label(node, object, column=0)

Get the label associated with an item and column.

handles_all = Bool(False)

Whether the renderer handles rendering everything

handles_icon = Bool(False)

Whether the renderer handles rendering the icon or other decoration

handles_text = Bool(True)

Whether the renderer handles rendering any text

abstract paint(node, column, object, paint_context)

Render the node.

Parameters
  • node (ITreeNode instance) – The tree node to render.

  • column (int) – The column in the tree that should be rendererd.

  • object (object) – The underlying object being edited.

  • paint_context (object) – A toolkit-dependent context for performing paint operations.

Returns

size – Optionally return a new preferred size so that the toolkit can perform better layout.

Return type

tuple of (width, height) or None

abstract size(node, column, object, size_context)

Return the preferred size for the item

Parameters
  • node (ITreeNode instance) – The tree node to render.

  • column (int) – The column in the tree that should be rendererd.

  • object (object) – The underlying object being edited.

  • size_context (object) – A toolkit-dependent context for performing sizing operations.

Returns

size

Return type

tuple of (width, height) or None