Class EditableTextList

Superclasses :
gui::LineBasedScrollArea
Package :
gui

A scrollable editable text area. An CONTENT_CHANGED_EVENT is generated whenever the contents are changed by the user, a CURSOR_MOVED_EVENT when the cursor moves, and a SELECTION_CHANGED_EVENT whenver the selection changes.

Source

Class summary
Methods inherited from gui::LineBasedScrollArea
ensure_row_visible(row) get_curr_lines() get_first_line() get_last_line() get_left_pos() 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()
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() refresh(redraw)
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_components_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_pointer() get_tooltip() get_w_reference() get_x_reference() get_y_reference() got_focus(e) handle_accel(e) in_region(x1, y1) 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() parse_pos(total, s) remove(c) 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_pointer(x) set_pos(x_spec, y_spec) set_size(w_spec, h_spec) set_ticker(n, d) set_tooltip(x) stop_ticker() 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 pointer 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
can_redo() can_undo() clear_mark() clear_view_list() constrain_cursor() constrain_line() contents_changed() create_view_list() delete_region(e) draw(subject_x, subject_y, vx, vy, vw, vh) draw_line(xp, yp, i, rev) end_handle(e) find_long_line() get_contents() get_line_count() get_line_height() get_pasteable_clipboard() get_region() get_subject_width() get_view_list_index(x, y) get_view_x_padding() get_view_y_padding() handle_copy(e) handle_cut(e) handle_default(e) handle_delete_left(e) handle_delete_line(e) handle_delete_right(e) handle_drag(e) handle_end_of_line(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_paste(e) handle_press(e) handle_redo(e) handle_release(e) handle_return(e) handle_select_all(e) handle_start_of_line(e) handle_undo(e) has_region() initially() keeps(e) keyboard_mark() lost_focus(e) on_hsb(ev) on_vsb(ev) range(f1, t1, f2, t2) resize() set_contents(x) set_cursor_from_pos() set_cursor_y(n) set_internal_fields() set_one(attr, val) set_tab_width(n) set_wrap_mode(s) start_handle() tick() update_view_list(index, del, add)
Variables defined in this class
changed contents cursor_x cursor_y direction is_held line_splitter long_line mark_x mark_y old_cursor_x old_cursor_y old_has_region old_mw old_view_list_size printable tab_width undo_manager view_list wrap_mode

Method detail

can_redo()

Source

can_undo()

Source

clear_mark()

Source

clear_view_list()

Private method, not intended for client invocation

constrain_cursor()

Private method, not intended for client invocation

constrain_line()

Private method, not intended for client invocation

contents_changed()

Call this method if the contents list, previously set with set_contents(), has changed.
Source

create_view_list()

Private method, not intended for client invocation

delete_region(e)

Source

draw(subject_x, subject_y, vx, vy, vw, vh)

Overrides draw(subject_x, subject_y, vx, vy, vw, vh) in gui::DrawScrollArea
Source

draw_line(xp, yp, i, rev)

Source

end_handle(e)

Source

find_long_line()

Private method, not intended for client invocation

get_contents()

Source

get_line_count()

Overrides get_line_count() in gui::LineBasedScrollArea
Source

get_line_height()

Overrides get_line_height() in gui::LineBasedScrollArea
Source

get_pasteable_clipboard()

Source

get_region()

Source

get_subject_width()

Overrides get_subject_width() in gui::ScrollArea
Source

get_view_list_index(x, y)

Private method, not intended for client invocation

get_view_x_padding()

Overrides get_view_x_padding() in gui::ScrollArea
Source

get_view_y_padding()

Overrides get_view_y_padding() in gui::ScrollArea
Source

handle_copy(e)

Source

handle_cut(e)

Source

handle_default(e)

Source

handle_delete_left(e)

Source

handle_delete_line(e)

Source

handle_delete_right(e)

Source

handle_drag(e)

Source

handle_end_of_line(e)

Source

handle_event(e)

Overrides handle_event(e) in gui::Component
Source

handle_key_down(e)

Source

handle_key_end(e)

Source

handle_key_home(e)

Source

handle_key_left(e)

Source

handle_key_page_down(e)

Source

handle_key_page_up(e)

Source

handle_key_right(e)

Source

handle_key_up(e)

Source

handle_paste(e)

Source

handle_press(e)

Source

handle_redo(e)

Source

handle_release(e)

Source

handle_return(e)

Source

handle_select_all(e)

Source

handle_start_of_line(e)

Source

handle_undo(e)

Source

has_region()

Source

initially()

Overrides initially() in util::Connectable

keeps(e)

Overrides keeps(e) in gui::Component
Source

keyboard_mark()

Source

lost_focus(e)

Overrides lost_focus(e) in gui::Component
Source

on_hsb(ev)

Overrides on_hsb() in gui::ScrollArea
Source

on_vsb(ev)

Overrides on_vsb() in gui::ScrollArea
Source

range(f1, t1, f2, t2)

Private method, not intended for client invocation

resize()

Overrides resize() in gui::Component
Source

set_contents(x)

Set the contents of the component.
Parameters :
x - the contents, as a list of strings
Source

set_cursor_from_pos()

Private method, not intended for client invocation

set_cursor_y(n)

Private method, not intended for client invocation

set_internal_fields()

Overrides set_internal_fields() in gui::ScrollArea
Source

set_one(attr, val)

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

set_tab_width(n)

Set the tab width to use. Default is eight chars.
Source

set_wrap_mode(s)

Set the word-wrap mode, which should be one of the following values :-

&null, "false", "off", "no", meaning don't do word-wrap (the default).

an integer (eg 20), meaning wrap at that line length.

"width", meaning wrap at the width of the component.

Source

start_handle()

Source

tick()

Overrides tick() in gui::Component
Source

update_view_list(index, del, add)

Update the view list, given that the contents have changed. This takes care to minimize the work that has to be done. The first param is an index into the contents list. The second param indicates some view_list lines corresponding to those beginning with index should be removed; the third param says that some should be added.
Source
Variable detail

changed

contents

cursor_x

cursor_y

direction

is_held

line_splitter

long_line

mark_x

mark_y

old_cursor_x

old_cursor_y

old_has_region

old_mw

old_view_list_size

printable

tab_width

undo_manager

view_list

wrap_mode