class TK_LISTBOX < $TK_WIDGET
****
a tk listbox with a vertical scrollbar


Ancestors
$TK_WIDGET



Public


Readable Attributes
attr actual_widget_name: STR; .. Included as actual_widget_name
**** Name of the actual widget
attr frame: TK_FRAME; .. Included as frame
**** Outer frame that holds widget + scrolls
attr hscroll_name,vscroll_name: STR; .. Included as hscroll_name
**** Scroll bar names
attr name: STR; .. Included as name
**** name of the full path to the widget proper
attr parent: $TK_WIDGET; .. Included as parent
**** which may contain scrollbars etc.
attr path_name: STR; .. Included as path_name
**** refers to the path to the outermost frame which may contain scrollbars etc.
attr hscroll_name,vscroll_name: STR; .. Included as vscroll_name
**** Scroll bar names

Features
act_on(id: INT,args: ARRAY{STR}) .. Included as act_on
**** Peform the action associated with the index "id".
activate(index: INT)
**** make index the active element
actual_widget: TK_GEN_WIDGET .. Included as actual_widget
bind_event(event: $TK_EVENT,action: ROUT{TK_EVENT_INFO}) .. Included as bind_event
**** Bind the event "event" to the action "action", a bound routine which takes an EVENT_INFO as an argument The first argument to the callback is an index in to the list of bindings that corresponds to this "action"
clear_selection(i:INT)
**** Disselects the selection at `i'.
configure(cf: CFGINFO) .. Included as configure
**** Reconfigure the widget with the new configuration "cf" Unstated parameters of "cf" remain unchanged
create(parent: $TK_WIDGET): SAME .. Included as create
**** Create a new widget, specifying a particular parent widget/window.
create(parent: $TK_WIDGET,np: STR): SAME .. Included as create
**** Create a new widget, specifying a particular parent and a name for the widget. The name "np" controls what tcl name is used and is only useful just for debugging purposes
create(parent:$TK_WIDGET,np:STR,cf: CFGINFO,pack:TK_PACK): SAME .. Included as create
**** Actual widget creation routine. All the rest are wrappers.
___Arg_parent_specifies_the_container_parent_window/widget
___Arg_np_is_used_to_specify_a_widget_name_for_debugging
___Arg_cf_specifies_configuration_options_(a_parameter_of
___TK_WIDGET_INCL)
___Arg_pack_specifies_the_packing_options
___Returns_a_configured,_packed_widget
create(parent: $TK_WIDGET,np: STR, pack: TK_PACK): SAME .. Included as create
**** Create a new widget.
___Arg_parent_specifies_the_container_parent_window/widget
___Arg_np_is_used_to_specify_a_widget_name_for_debugging
___Arg_pack_specifies_the_packing_options
create(parent: $TK_WIDGET,cf: CFGINFO): SAME .. Included as create
**** Create a new widget
__Arg_parent_specifies_the_parent_window/widget._This_could
____be_a_#TK_ROOTWINDOW_or_a_TK_TOPLEVEL
____toplevel_win_::=_#TK_TOPLEVEL;
____this_win_:=_#<some_widget_class>(toplevel_win,
__Arg_cf_specifies_a_configuration_option_that_should_be_used
____by_this_widget._This_routine_is_declared_in_TK_WIDGET_INCL
____where_the_type_of_the_configuration_option_is_a_type_parameter
____CFGINFO,_which_is_usually_set_to_<widget_name>TK__CFG
create(parent: $TK_WIDGET,cf: CFGINFO,pack: TK_PACK): SAME .. Included as create
**** Create a new widget.
___Arg_parent_specifies_the_container_parent_window/widget
___Arg_cf_specifies_configuration_options_(a_parameter_of
___TK_WIDGET_INCL)
___Arg_pack_specifies_the_packing_options
create(parent: $TK_WIDGET,pack: TK_PACK): SAME .. Included as create
**** Create a new widget
__Arg_parent_specifies_the_container_parent_window/widget
__Arg_pack_specifies_the_location_of_the_widget_within_the
___parent_(packing).
create: SAME .. Included as create
curselection: ARRAY{INT}
**** the indices of all currently selected elements
delete(first: INT)
delete(first, last: INT)
destroy .. Included as destroy
**** Destroy the widget associated with self
get(first: INT): STR
get(first, last: INT): ARRAY{STR}
hscroll .. Included as hscroll
**** Create a horizontal scrollbar
hscroll: SAME .. Included as hscroll
index_active: INT
index_anchor: INT
index_at(x, y: FLT): INT
index_end: INT
insert(index: INT, s: ARRAY{STR})
**** Inserts all s's at index i see above for index functions
insert(index: INT, s: STR)
**** Inserts `s' at index `i' see above for index functions
is_eq(o:$TK_WIDGET): BOOL .. Included as is_eq
is_selected(i:INT): BOOL
**** Returns true if the index `i' is selcted.
nearest(y:INT): INT
**** Returns the index number which is nearest to the `y' coordinate.
see(index: INT)
**** Makes element i visible (and scrolls if neccessary).
set_selection(i:INT)
**** Sets the selection to the `i'th element .
size: INT
**** Returns number of elements in the list box.
vscroll .. Included as vscroll
**** Add a vertical scrollbar
vscroll: SAME .. Included as vscroll
widget_name: STR .. Included as widget_name

Iters
curselection!: INT
get!( once first,once last: INT): STR


Private

attr actual_widget_name: STR; .. Included as actual_widget_name
**** Name of the actual widget
arr_str(a: ARRAY{STR}): STR .. Included as arr_str
**** Print out an array version of the string, since ARRAY does not have a .str routien in the standar library.
attr bindings: A_LIST{ROUT{TK_EVENT_INFO}}; .. Included as bindings
**** Store the bindings
attr bindings: A_LIST{ROUT{TK_EVENT_INFO}}; .. Included as bindings
**** Store the bindings
deb(s: STR) .. Included as deb
**** Print out a debugging message
debug: BOOL .. Included as debug
**** Return the value of the debug flag
default_config: CFGINFO .. Included as default_config
**** Default configuration information
default_init(c: TK_LISTBOX_CFG)
default_packing: TK_PACK .. Included as default_packing
err(s: STR) .. Included as err
**** Print out an error message.
eval(a1: $STR) .. Included as eval
eval(a1,a2: $STR) .. Included as eval
eval(a1,a2,a3: $STR) .. Included as eval
eval(a1,a2,a3,a4: $STR) .. Included as eval
eval(a1,a2,a3,a4,a5: $STR) .. Included as eval
fix_tcl_name(s: STR): STR .. Included as fix_tcl_name
**** SEF:Eliminate problems with tcl name, returning the empty string if necessary.
flt_if_poss(s: STR,default: FLT): FLT .. Included as flt_if_poss
**** Convert the string "s" to a float and return it, if possible. If an error occurs in the conversion, return the "default" value
attr frame: TK_FRAME; .. Included as frame
**** Outer frame that holds widget + scrolls
attr hscroll_name,vscroll_name: STR; .. Included as hscroll_name
**** Scroll bar names
index(s: STR): INT
init(a_parent: $TK_WIDGET,name:STR,cfg: CFGINFO) .. Included as init
**** Creation of the widget and its frame
int_if_poss(s: STR,default: INT): INT .. Included as int_if_poss
**** Convert the string "s" to an integer and return it, if possible. If an error occurs in the conversion, return the "default" value
join(a1,a2: $STR): STR .. Included as join
attr name: STR; .. Included as name
**** name of the full path to the widget proper
attr parent: $TK_WIDGET; .. Included as parent
**** which may contain scrollbars etc.
attr path_name: STR; .. Included as path_name
**** refers to the path to the outermost frame which may contain scrollbars etc.
quote(s:STR): STR .. Included as quote
**** Return a (tcl) quoted version of the string "s"
register .. Included as register
**** Register this widget with the widget map so that subsequent callbacks that belong to this widget may be directed here.
const tk_widget_type: STR := "listbox";
attr hscroll_name,vscroll_name: STR; .. Included as vscroll_name
**** Scroll bar names

The Sather Home Page