1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
|
<!DOCTYPE html>
<html>
<head>
<title>Commands Related to Binding Scripts</title>
<meta name="Author" content="Csaba Nemethi">
<meta name="Keywords" content="tablelist, binding script">
<link rel="stylesheet" type="text/css" href="stylesheet.css">
</head>
<body>
<div>
<h1>Commands Related to Binding Scripts</h1>
<h2>For Tablelist Version 7.4</h2>
<h3>by</h3>
<h2>Csaba Nemethi</h2>
<address>
<a href="mailto:csaba.nemethi@t-online.de">csaba.nemethi@t-online.de</a>
</address>
</div>
<hr>
<h2 id="contents">Contents</h2>
<ul>
<li><a href="#overview">Overview</a></li>
<li><a href="#convEventFields">The
<code><b>tablelist::convEventFields</b></code> Command</a></li>
<li><a href="#getTablelistPath">The
<code><b>tablelist::getTablelistPath</b></code> Command</a></li>
<li><a href="#getTablelistColumn">The
<code><b>tablelist::getTablelistColumn</b></code> Command</a></li>
<li><a href="#delaySashPosUpdates">The
<code><b>tablelist::delaySashPosUpdates</b></code> Command</a></li>
</ul>
<div>
<p><a href="index.html">Start page</a></p>
</div>
<hr>
<h2 id="overview">Overview</h2>
<p>The first three 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 <code><b><a href=
"tablelistWidget.html#bodytag">bodytag</a></b></code> and <code><b><a href=
"tablelistWidget.html#labeltag">labeltag</a></b></code> 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 <code><b>TablelistBody</b></code>. For details and examples
see the sections <a href="tablelistWidget.html#body_bindings">DEFAULT AND
INDIVIDUAL BINDINGS FOR THE TABLELIST BODY</a> and <a href=
"tablelistWidget.html#label_bindings">DEFAULT AND INDIVIDUAL BINDINGS FOR THE
HEADER LABELS</a>.</p>
<p>The last command is related to the default binding scripts for Tk core
panedwindow and ttk::panedwindow widgets. It can be used to control the
frequency of the sash position updates, which might be necessary to eliminate
some artifacts caused by dragging a sash if one or more of the panes contains
a tablelist widget with embedded images.</p>
<div>
<p><a href="#contents">Contents</a> <a href=
"index.html">Start page</a></p>
</div>
<hr>
<h2 id="convEventFields">The <code><b>tablelist::convEventFields</b></code>
Command</h2>
<dl>
<dt><b>NAME</b></dt>
<dd><code>tablelist::convEventFields</code> – Convert event fields
relative to a descendant of a tablelist widget</dd>
<dt class="tm"><b>SYNOPSIS</b></dt>
<dd>
<pre>
<b>tablelist::convEventFields</b> <i>descendantPathName</i> <i>x</i> <i>y</i>
</pre>
</dd>
<dt><b>DESCRIPTION</b></dt>
<dd>This command gets the path name of a tablelist widget and the x and y
coordinates relative to the latter from the path name
<code><i>descendantPathName</i></code> of one of its descendants and from
the x and y coordinates <code><i>x</i></code>, <code><i>y</i></code>
relative to this descendant. The command returns these values as the
components of a list consisting of three elements.</dd>
<dd class="tm">
In a binding script, the descendant widget corresponds to the event field
<code><b>%W</b></code>, 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
a Tk core or tile checkbutton embedded into a header label, or a sort
arrow. Likewise, the
arguments <code><i>x</i></code> and <code><i>y</i></code> correspond to
the event fields <code><b>%x</b></code> and <code><b>%y</b></code>.
The three elements of the list returned by the command are usually
assigned to the help variables <code><b>tablelist::W</b></code>,
<code><b>tablelist::x</b></code>, and <code><b>tablelist::y</b></code>,
by using the statement
<blockquote>
<pre>
foreach {tablelist::W tablelist::x tablelist::y} \
[<span class="red">tablelist::convEventFields</span> %W %x %y] {}
</pre>
</blockquote>
</dd>
<dt><b>KEYWORDS</b></dt>
<dd>tablelist, event fields, binding script</dd>
</dl>
<div>
<p><a href="#contents">Contents</a> <a href=
"index.html">Start page</a></p>
</div>
<hr>
<h2 id="getTablelistPath">The <code><b>tablelist::getTablelistPath</b></code>
Command</h2>
<dl>
<dt><b>NAME</b></dt>
<dd><code>tablelist::getTablelistPath</code> – Get the path name of a
tablelist widget from the path name of one of its descendants</dd>
<dt class="tm"><b>SYNOPSIS</b></dt>
<dd>
<pre>
<b>tablelist::getTablelistPath</b> <i>descendantPathName</i>
</pre>
</dd>
<dt><b>DESCRIPTION</b></dt>
<dd>This command gets the path name of a tablelist widget from the path
name <code><i>descendantPathName</i></code> of one of its descendants.</dd>
<dd class="tm">In a binding script, the descendant widget corresponds to
the event field <code><b>%W</b></code>, 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 a Tk core or tile checkbutton embedded into a header label, or a
sort arrow. The return value is often assigned to the help variable
<code><b>tablelist::W</b></code>.</dd>
<dt class="tm"><b>KEYWORDS</b></dt>
<dd>tablelist, path name, binding script</dd>
</dl>
<div>
<p><a href="#contents">Contents</a> <a href=
"index.html">Start page</a></p>
</div>
<hr>
<h2 id="getTablelistColumn">The
<code><b>tablelist::getTablelistColumn</b></code> Command</h2>
<dl>
<dt><b>NAME</b></dt>
<dd><code>tablelist::getTablelistColumn</code> – Get the column
number from the path name of a tablelist header label</dd>
<dt class="tm"><b>SYNOPSIS</b></dt>
<dd>
<pre>
<b>tablelist::getTablelistColumn</b> <i>headerLabelPathName</i>
</pre>
</dd>
<dt><b>DESCRIPTION</b></dt>
<dd>This command gets the column number from the path name
<code><i>headerLabelPathName</i></code> of a tablelist header label or of
a Tk core or tile checkbutton embedded into a header label, or of a sort
arrow. Returns the column number on success and <code>-1</code> on
failure.</dd>
<dd class="tm">In a binding script, the argument corresponds to the event
field <code><b>%W</b></code>. The return value is often assigned to
the help variable <code><b>tablelist::col</b></code>.</dd>
<dt class="tm"><b>KEYWORDS</b></dt>
<dd>tablelist, path name, binding script</dd>
</dl>
<div>
<p><a href="#contents">Contents</a> <a href=
"index.html">Start page</a></p>
</div>
<hr>
<h2 id="delaySashPosUpdates">The
<code><b>tablelist::delaySashPosUpdates</b></code> Command</h2>
<dl>
<dt><b>NAME</b></dt>
<dd><code>tablelist::delaySashPosUpdates</code> – Set a delay for the
panedwindow sash position updates</dd>
<dt class="tm"><b>SYNOPSIS</b></dt>
<dd>
<pre>
<b>tablelist::delaySashPosUpdates</b> <i>panedwindowPathName</i> <i>ms</i>
</pre>
</dd>
<dt><b>DESCRIPTION</b></dt>
<dd>This command sets a delay for the updates of the sash position caused
by dragging a sash of the panedwindow widget specified by the first
argument, which must be the path name of a Tk core panedwindow or
ttk::panedwindow widget. <code><i>ms</i></code> must be an integer
giving the delay in milliseconds. If this number is nonnegative then
the sash position updates via  <code><b>sash place ...</b></code>
(for a Tk core panedwindow widget) or <code><b>sashpos
...</b></code> (for a ttk::panedwindow widget) will be scheduled for
execution <code><i>ms</i></code> milliseconds later, in such a way that,
until the time for an already scheduled update expires, new drag events
won't schedule new update operations (only their data will be
remembered). This will reduce the frequency of the sash position
updates caused by dragging a sash of the specified widget, depending on the
value of <code><i>ms</i></code>. If this number is negative then any
dragging of a sash of the specified widget will immediately trigger an
update of the sash position, as implemented in the default binding scripts
for Tk core panedwindow and ttk::panedwindow widgets.</dd>
<dd class="tm">This command can be used to control the frequency of the
sash position updates for a given panedwindow widget, which might be
necessary to eliminate some artifacts caused by dragging a sash if one or
more of the panes contains a tablelist widget with embedded images.
The value of <code><i>ms</i></code> (typically a number between 10 and 100)
is application- and platform-specific (on Windows and Mac OS X/11+ you will
need a higher value than on X11).</dd>
<dt class="tm"><b>KEYWORDS</b></dt>
<dd>panedwindow, tablelist, path name, binding script</dd>
</dl>
<div>
<p><a href="#contents">Contents</a> <a href=
"index.html">Start page</a></p>
</div>
</body>
</html>
|
