Class ScrollArea

Superclasses :
gui::Component
Subclasses :
gui::ComponentScrollArea
gui::DrawScrollArea
Package :
gui

This is a base class for displaying an arbitrarily large object using a pair of scroll bars. This specification of the object is provided by implementing methods in a subclass.

No event handling is done; see BasicScrollArea for the necessary requirement for the subclass.

Source

Class summary
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) 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) 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_one(attr, val) 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) set_one(attr, val) 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
compute_and_invalidate() create_view() display(buffer_flag) get_areax() get_areay() get_subject_height() get_subject_horizontal_increment() get_subject_vertical_increment() get_subject_width() get_view_x_padding() get_view_y_padding() initially() on_hsb() on_vsb() refresh(redraw) resize() set_internal_fields()
Variables defined in this class
hsb last_refresh_x last_refresh_y view vsb

Method detail

compute_and_invalidate()

Recompute the scrollbars and redisplay the object.
Source

create_view()

Create the view component
Source

display(buffer_flag)

Overrides display(buffer_flag) in gui::Component
Source

get_areax()

The x offset into the object we are viewing
Source

get_areay()

The y offset into the object we are viewing
Source

get_subject_height()

Return the height of the subject object
Source

get_subject_horizontal_increment()

Return the increment on a line-left/line-right
Source

get_subject_vertical_increment()

Return the increment on a line-up/line-down
Source

get_subject_width()

Return the width of the subject object
Source

get_view_x_padding()

For a scrollarea with a border, return the number of pixels between the left of the component and the view component.

Different subclasses may override this; by default it returns DEFAULT_SP_X_PADDING.

Source

get_view_y_padding()

For a scrollarea with a border, return the number of pixels between the top of the component and the view component.

Different subclasses may override this; by default it returns DEFAULT_SP_Y_PADDING.

Source

initially()

Overrides initially() in util::Connectable

on_hsb()

Source

on_vsb()

Source

refresh(redraw)

Private method, not intended for client invocation

resize()

Overrides resize() in gui::Component
Source

set_internal_fields()

Private method, not intended for client invocation

Variable detail

hsb


last_refresh_x


last_refresh_y


view


vsb