Class Tree

Superclasses :
gui::SelectableScrollArea
Subclasses :
gui::TreeTableContent
Package :
gui

This class represents a tree object. A TREE_NODE_EXPANSION_EVENT occurs when a node is expanded/contracted. Also, the events generated by the parent class SelectableScrollArea are inherited.

Source

Class summary
Methods inherited from gui::SelectableScrollArea
can_drag() clear_draggable_cursor() clear_motion_cursor() clear_selection_on_key_moves() clear_selections() constrain_cursor() contents_changed() delete_rows(l) drag_event(d) drag_reset() draw(subject_x, subject_y, vx, vy, vw, vh) end_handle(e) get_checked() get_contents() get_cursor() get_gesture_selections() get_highlight() get_line_count() get_prev_cursor() get_selections() handle_drag(e) handle_event(e) handle_key_down(e) handle_key_end(e) handle_key_home(e) handle_key_left(e) handle_key_page_down(e) handle_key_page_up(e) handle_key_right(e) handle_key_up(e) handle_move(e) handle_release(e) handle_return(e) insert_rows(l, n) keeps(e) move_cursor_on_key(row) move_rows(l, n) object_get_cursor() object_get_gesture_selections() object_get_highlight() object_get_prev_cursor() object_get_selections() object_set_cursor(o) object_set_selections(l) set_checked(l) set_contents(x) set_cursor(row) set_draggable_cursor() set_motion_cursor() set_select_many() set_select_none() set_select_one() set_selection_on_key_moves() set_selections(l) start_handle(e) tick()
Variables inherited from gui::SelectableScrollArea
checked contents cursor draggable_cursor going_up highlight is_held motion_cursor old_cursor prev_cursor selchange select_many select_one selection_on_key_moves
Methods inherited from gui::LineBasedScrollArea
ensure_row_visible(row) get_curr_lines() get_first_line() get_last_line() get_left_pos() get_line_count() get_line_under_pointer() get_max_lines() get_subject_height() get_subject_horizontal_increment() get_subject_vertical_increment() goto_pos(line, horiz) init()
Variables inherited from gui::LineBasedScrollArea
line_height
Methods inherited from gui::DrawScrollArea
create_view() draw(subject_x, subject_y, vx, vy, vw, vh)
Methods inherited from gui::ScrollArea
compute_and_invalidate() create_view() display(buffer_flag) get_areax() get_areay() get_subject_height() get_subject_horizontal_increment() get_subject_vertical_increment() get_view_x_padding() get_view_y_padding() on_hsb() on_vsb() refresh(redraw) resize() set_internal_fields()
Variables inherited from gui::ScrollArea
hsb last_refresh_x last_refresh_y view vsb
Methods inherited from gui::Component
accepts_focus() add(c, i) all_valid() can_drag(ev) can_drop(d) child_validated(c) clear_accepts_focus() clear_allow_drag() clear_allow_drop() clear_draw_border() clear_is_shaded() compute_absolutes() create_event_and_fire(type, param) display(buffer_flag) do_handle_event(e) do_shading(W) drag_event(d) drag_reset() end_drag(d, c) fatal(s) finally() find_accel(e) find_focus() fire_icon_events_on_mouse(p, e) firstly() generate_components() get_accel() get_cbwin_reference() get_children() get_cwin_reference() get_h_reference() get_parent() get_parent_buffer_win() get_parent_dialog() get_parent_dialog_reference() get_parent_win() get_w_reference() get_x_reference() get_y_reference() got_focus(e) handle_accel(e) handle_event(e) in_region() init() invalidate() invoke_can_drag(ev) invoke_can_drop(d) invoke_drag_event(d) invoke_drag_reset() invoke_end_drag(d, c) is_attrib(s) is_dialog_open() is_hidden() is_shaded() is_ticking() is_unhidden() is_unshaded() keeps(e) lost_focus(e) parse_pos(total, s) remove(c) resize() retime_ticker(n) set_abs_coords(x, y) set_abs_size(w, h) set_accel(k) set_accepts_focus() set_align(x_align, y_align) set_allow_drag() set_allow_drop() set_attribs(x[]) set_attribs_list(l) set_draw_border() set_is_shaded() set_parent(c) set_parent_dialog(c) set_pos(x_spec, y_spec) set_size(w_spec, h_spec) set_ticker(n, d) set_tooltip(x) stop_ticker() tick() toggle_draw_border() toggle_is_shaded() unique_end(x) unique_start() validate()
Variables inherited from gui::Component
accel accepts_focus_flag allow_drag_flag allow_drop_flag attribs cbwin children cwin draw_border_flag h h_spec has_focus is_shaded_flag parent parent_dialog ticker tooltip valid w w_spec x x_align x_spec y y_align y_spec
Methods inherited from lang::Object
clone(seen) equals(other, seen) get_class() get_class_name() get_id() hash_code(depth, seen) is_instance(name) to_string(depth, seen)
Methods inherited from util::SetFields
as_attrib(attr, val) attrib(a[]) cset_val(attr, val) field_error(s) int_val(attr, val) int_vals(attr, val, n) numeric_val(attr, val) numeric_vals(attr, val, n) set_fields(l) string_val(attr, val) string_vals(attr, val, n) test_flag(attr, val)
Methods inherited from util::Connectable
connect(obj, meth, type) disconnect(l) fire(type, param) fire_event(e)
Variables inherited from util::Connectable
listeners
Methods defined in this class
clear_show_root() clear_show_root_handles() compute_bmp_wh() draw_line(xp, yp, i, selection_cw, cursor_cw, highlight_cw) expand() flatten() flatten2(l, n, dl) get_last_expanded() get_line_height() get_root_node() get_subject_width() handle_press(e) initially() set_default_bmps(l) set_one(attr, val) set_root_node(r) set_show_root() set_show_root_handles() tree_structure_changed()
Variables defined in this class
bmp_h bmp_w col_w default_bmps last_expanded little_h little_w minus plus root_node show_root show_root_handles

Method detail

clear_show_root()

Set the component such that the root node is not shown.
Source

clear_show_root_handles()

Set the component so that root handles are not shown.
Source

compute_bmp_wh()

Source

draw_line(xp, yp, i, selection_cw, cursor_cw, highlight_cw)

Overrides draw_line(xp, yp, i, selection_cw, cursor_cw, highlight_cw) in gui::SelectableScrollArea
Source

expand()

Expand all the nodes in the Tree.
Source

flatten()

This method returns a flat list of all the Nodes in the tree that are currently displayed.
Returns :
A list of nodes.
Source

flatten2(l, n, dl)

Source

get_last_expanded()

Source

get_line_height()

Overrides get_line_height() in gui::LineBasedScrollArea
Source

get_root_node()

Get the root node of the tree
Source

get_subject_width()

Overrides get_subject_width() in gui::ScrollArea
Source

handle_press(e)

Overrides handle_press(e) in gui::SelectableScrollArea
Source

initially()

Overrides initially() in util::Connectable

set_default_bmps(l)

Set the default bitmaps for each Node in the Tree. The parameter should be a list of three bitmaps; see Node above for an explanation.
Parameters :
l - The list of bitmaps.
Source

set_one(attr, val)

Overrides set_one(attr, val) in util::SetFields
Source

set_root_node(r)

Set the root node of the Tree.
Source

set_show_root()

Set the tree so that the root is shown (the default).
Source

set_show_root_handles()

Set the component so that root handles are shown (the default).
Source

tree_structure_changed()

Source

Variable detail

bmp_h


bmp_w


col_w


default_bmps


last_expanded


little_h


little_w


minus


plus


root_node


show_root


show_root_handles