Class Table

Summary

#
  This class displays a table, the columns of which are set up
  using TableColumns.

Superclasses:
Component

Package:
(main)
File:
_table.icn
Methods:
add, button_area_to_buffer, clear_selections, compute_and_redisplay, display, end_state, final_setup, finally, get_checked, get_contents, get_last_line, get_left_pos, get_line, get_page_size, get_prev_down, get_right_selections, get_selections, get_which_down, goto_pos, handle_drag, handle_event, handle_key_down, handle_key_end, handle_key_home, handle_key_left, handle_key_page_down, handle_key_page_up, handle_key_right, handle_key_up, handle_notify, handle_press, handle_release, handle_rpress, refresh, resize, row_get_prev_down, row_get_which_down, scroll_buttons, set_button_group_height, set_checked, set_contents, set_internal_fields, set_select_many, set_select_one, set_selections, text_area_to_buffer, tick

Methods inherited from Component:
accepts_tab_focus, attrib, clear_accepts_tab_focus, clear_draw_border, clear_is_shaded, clear_no_updates, do_shading, error, firstly, generate_all_components, generate_components, get_cbwin_reference, get_cwin_reference, get_h_reference, get_parent_Dialog, get_parent_buffer_win, get_parent_win, get_visible_reference, get_w_reference, get_x_reference, get_y_reference, got_focus, in_region, is_hidden, is_shaded, is_unhidden, is_unshaded, lost_focus, parse_pos, redisplay, set_abs_coords, set_abs_size, set_accepts_tab_focus, set_align, set_attribs, set_attribs_list, set_draw_border, set_is_shaded, set_no_updates, set_parent_Dialog, set_pos, set_size, set_tooltip, toggle_draw_border, toggle_is_shaded, unique_end, unique_start

Methods inherited from MetaComponent:
set_fields

Methods inherited from Ticker:
is_ticking, retime_ticker, set_ticker, stop_ticker

Fields:
checked, columns, contents, going_up, head_h, head_x, head_y, highlight_lst, highlight_lst2, hsb, is_held, last_refresh_x, last_refresh_y, line_height, max_width, prev_down, rchecked, select_many, select_one, th, tw, tx, ty, vsb, which_down

Source code.

Details
Constructor

Table(argv)

Methods:

add(c)

#
  Add the given TableColumn to the Table.
  @param c  The column to add.


button_area_to_buffer()


clear_selections()


compute_and_redisplay()


display(buffer_flag)

This method overrides display in class Component

end_state()


final_setup(x, y)

This method overrides final_setup in class Component

finally()

This method overrides finally in class Component

get_checked()


get_contents()


get_last_line()


get_left_pos()


get_line()


get_page_size()


 Present page size


get_prev_down()


 Return item currently under the clicked cursor


get_right_selections()

swj


get_selections()


 Return a list of items highlighted

#
  Return a list of rows selected
  @return A list of rows currently selected


get_which_down()


 Return item currently under the clicked cursor


goto_pos(x, y)

#
 Move to the given position.  Either parameter may be omitted.
 @param x   The row to move to
 @param y   The left offset to move to


handle_drag(e)


handle_event(e)

This method overrides handle_event in class Component

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_notify(e)

This method overrides handle_notify in class Component

handle_press(e)


handle_release(e)


handle_rpress(e)


refresh(redraw)


 Re-draw the text area.  Use double-buffering to avoid flicker.


resize()

This method overrides resize in class Component

row_get_prev_down()


 Return row currently under the clicked cursor


row_get_which_down()


 Return row currently under the clicked cursor


scroll_buttons()


set_button_group_height(x)

#
  Set the height of the buttons at the top in pixels.  If not
  invoked, a sensible default will be used.
  @param x   The height


set_checked(l)


set_contents(x)

#
  Set the contents of the table.  The parameter should be a
  two dimensional list.  Each element of the list should
  correspond to one row of the table.
  @param x   The contents


set_internal_fields()


 Called on resize, buttons resized, or contents amended


set_select_many()

#
  Configure the table so that several rows of the table may be highlighted.


set_select_one()

#
  Configure the table so that one row of the table may be highlighted.


set_selections(l)

#
  Set the current selections to the list l, which is a list of
  row numbers.
  @param l   The list of item numbers.


text_area_to_buffer()


tick()

This method overrides tick in class Ticker
Fields:
checked

columns

contents

going_up

head_h

head_x

head_y

highlight_lst

highlight_lst2 -- temporary quick fix for 2 colors

hsb

is_held

last_refresh_x

last_refresh_y

line_height

max_width

prev_down

rchecked -- swj

select_many

select_one

th

tw

tx

ty

vsb

which_down


This page produced by UniDoc on 2021/04/15 @ 23:59:54.