Helper Commands Used in Tablelist Binding Scripts

For Tablelist Version 5.17

by

Csaba Nemethi

csaba.nemethi@t-online.de

Contents

Start page


Overview

The commands described in this reference page are designed to be used in binding scripts associated with the binding tags whose names are returned by the bodytag and labeltag subcommands of the Tcl command associated with a tablelist widget.  The first two of these commands are also used in the default binding scripts associated with the binding tag TablelistBody.  For details and examples see the sections DEFAULT AND INDIVIDUAL BINDINGS FOR THE TABLELIST BODY and DEFAULT AND INDIVIDUAL BINDINGS FOR THE HEADER LABELS.

Contents     Start page


The tablelist::convEventFields Command

NAME
tablelist::convEventFields – Convert event fields relative to a descendant of a tablelist widget
SYNOPSIS
tablelist::convEventFields descendantPathName x y
DESCRIPTION
This command gets the path name of a tablelist widget and the x and y coordinates relative to the latter from the path name descendantPathName of one of its descendants and from the x and y coordinates x, y relative to this descendant.  The command returns these values as the components of a list consisting of three elements.
In a binding script, the descendant widget corresponds to the event field %W, which can be the tablelist's body, one of the separator frames, a label widget displaying an embedded image, or (a descendant of) an embedded window.  It can also be a header label or an additional widget placed by Tablelist into a header label for displaying a header image or a sort arrow.  Likewise, the arguments x and y correspond to the event fields %x and %y.  The three elements of the list returned by the command are usually assigned to the help variables tablelist::W, tablelist::x, and tablelist::y, by using the statement
foreach {tablelist::W tablelist::x tablelist::y} \
    [tablelist::convEventFields %W %x %y] {}
KEYWORDS
tablelist, event fields, binding script

Contents     Start page


The tablelist::getTablelistPath Command

NAME
tablelist::getTablelistPath – Get the path name of a tablelist widget from the path name of one of its descendants
SYNOPSIS
tablelist::getTablelistPath descendantPathName
DESCRIPTION
This command gets the path name of a tablelist widget from the path name descendantPathName of one of its descendants.
In a binding script, the descendant widget corresponds to the event field %W, which can be the tablelist's body, one of the separator frames, a label widget displaying an embedded image, or (a descendant of) an embedded window.  It can also be a header label or an additional widget placed by Tablelist into a header label for displaying a header image or a sort arrow.  The return value is often assigned to the help variable tablelist::W.
KEYWORDS
tablelist, path name, binding script

Contents     Start page


The tablelist::getTablelistColumn Command

NAME
tablelist::getTablelistColumn – Get the column number from the path name of a tablelist header label
SYNOPSIS
tablelist::getTablelistColumn headerLabelPathName
DESCRIPTION
This command gets the column number from the path name headerLabelPathName of a tablelist header label or of an additional widget placed by Tablelist into a header label for displaying a header image or a sort arrow.
In a binding script, the command argument corresponds to the event field %W.  The return value is often assigned to the help variable tablelist::col.
KEYWORDS
tablelist, path name, binding script

Contents     Start page