- INHERITED METHODS
Tickit::Widget::Tree - tree widget implementation for Tickit
use Tickit::Widget::Tree; my $tree = Tickit::Widget::Tree->new(root => Tree::DAG_Node->new);
NOTE: Versions 0.003 and below used a custom graph management implementation which had various problems with rendering glitches and performance. This version has been rewritten from scratch to use Tree::DAG_Node to handle the tree structure, and as such is not backward compatible.
The following style keys are recognised, in addition to base styling which will be applied to the tree lines:
line_style - which line type to use, default 'single', other options include 'thick' or 'double'
expand_style - 'boxed' is the only option for now, to select a Unicode +/- boxed icon
highlight_(fg|bg|b|rv) - highlight styling
highlight_full_row - if true, will apply highlighting to the entire width of the widget, rather than just the text
Key bindings are currently:
previous_row - move up a line, stepping into open nodes, default
next_row - move down a line, stepping into open nodes, default
up_tree - move to the parent, default
down_tree - move to the first child, opening the current node if necessary, default
open_node - opens the current node, default
close_node - closes the current node, default
activate - activates the current node, default
first_row - jump to the first node in the tree, default
last_row - jump to the last node in the tree, default
Calculate the minimum size needed to contain the full tree with all nodes expanded.
Instantiate. Takes the following named parameters:
root - the root Tree::DAG_Node
on_activate - coderef to call when a node has been activated (usually via 'enter' keypress)
Accessor for the root node. If given a parameter, will set the root node accordingly (and mark the tree for redraw), returning $self.
Otherwise, returns the root node - or undef if we do not have one.
Work out our size, when we have a window to fit in.
Called by Tickit::Widget::ScrollBox or other scroll-capable containers to set up the extent objects which determine the drawable viewport offset.
Called by Tickit::Widget::ScrollBox or other scroll-capable containers to indicate when scroll actions have occurred.
Render method. Used internally.
Workaround to avoid warnings from Tickit::Window. This probably shouldn't be here, pretend you didn't see it.
Mouse callback. Used internally.
Jump to the first row. Normally bound to the
Jump to the last row. Normally bound to the
Go up a node.
Move down a node.
Going "up" the tree means the parent of the current node.
Going "down" the tree means the first child node, if we have one and we're open.
Change the currently highlighted node.
Open this node.
Close this node.
on_activate coderef if we have it.
Plenty of features and bugfixes left on the list, in no particular order:
Avoid full redraw when moving highlight or opening/closing nodes
Support nested widgets
Detect changes to the underlying Tree::DAG_Node structure
get_style_pen, get_style_text, get_style_values, key_focus_next_after, key_focus_next_before, on_pen_changed, parent, pen, redraw, resized, set_parent, set_pen, set_style, set_style_tag, set_window, style_classes, take_focus, window, window_lost
Tom Molesworth <email@example.com>
Copyright Tom Molesworth 2011-2013. Licensed under the same terms as Perl itself.