summaryrefslogtreecommitdiffstats
path: root/doc/What's New in TkTreeCtrl.html
blob: 0017fd7dac09ae8f1fdfce6fb41d62f1f66ff925 (plain)
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
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<!-- $Id: What's\040New\040in\040TkTreeCtrl.html,v 1.7 2005/06/13 23:35:36 treectrl Exp $ -->
  <meta content="text/html; charset=ISO-8859-1"
 http-equiv="content-type">
  <title>What's New in TkTreeCtrl</title>
  <meta content="Tim Baker" name="author">
</head>
<body>
<h1>What's New in TkTreeCtrl 2.0</h1>
<h2>TreeCtrl Configuration Options</h2>
<table style="text-align: left; width: 100%;" border="1" cellpadding="2"
 cellspacing="2">
  <tbody>
    <tr>
      <th style="background-color: rgb(255, 255, 204); width: 50%;">Replaced</th>
      <th style="background-color: rgb(204, 255, 255);">What to use
instead</th>
    </tr>
    <tr>
      <td>-openbuttonimage</td>
      <td>-buttonimage</td>
    </tr>
    <tr>
      <td>-closedbuttonimage</td>
      <td>-buttonimage</td>
    </tr>
    <tr>
      <td>-openbuttonbitmap</td>
      <td>-buttonbitmap</td>
    </tr>
    <tr>
      <td>-closedbuttonbitmap</td>
      <td>-buttonbitmap</td>
    </tr>
    <tr>
      <th style="background-color: rgb(255, 255, 204); width: 50%;">Usage
Changed</th>
      <th style="background-color: rgb(204, 255, 255);">How it changed</th>
    </tr>
    <tr>
      <td>-backgroundmode</td>
      <td>The values "index" and "visindex" are deprecated. The value
"order" should be used instead of "index", and
"ordervisible" should be used instead of "visindex". This brings
agreement with the new "item order" command which replaces the "item

index" command.</td>
    </tr>
    <tr>
      <td>-treecolumn</td>
      <td>This used to be any integer value which may or may not have
corresponded to an actual column. Now the value must be a valid column
description, or an empty string to indicate no column should display
buttons/lines.</td>
    </tr>
    <tr>
      <th style="background-color: rgb(255, 255, 204);">New</th>
      <td></td>
    </tr>
    <tr>
      <td>-backgroundimage</td>
      <td></td>
    </tr>
    <tr>
      <td>-columnprefix</td>
      <td></td>
    </tr>
    <tr>
      <td>-columnresizemode</td>
      <td></td>
    </tr>
    <tr>
      <td>-itemprefix</td>
      <td></td>
    </tr>
    <tr>
      <td>-minitemheight</td>
      <td></td>
    </tr>
    <tr>
      <td>-usetheme</td>
      <td></td>
    </tr>
  </tbody>
</table>
<h2>TreeCtrl Commands</h2>
<table style="text-align: left; width: 100%;" border="1" cellpadding="2"
 cellspacing="2">
  <tbody>
    <tr>
      <th style="width: 50%; background-color: rgb(255, 255, 204);">Deprecated</th>
      <th style="background-color: rgb(204, 255, 255);">What to use
instead</th>
    </tr>
    <tr>
      <td>compare</td>
      <td>item compare</td>
    </tr>
    <tr>
      <td>index</td>
      <td>item id</td>
    </tr>
    <tr>
      <td>numcolumns</td>
      <td>column count</td>
    </tr>
    <tr>
      <td>numitems</td>
      <td>item count</td>
    </tr>
    <tr>
      <td>range</td>
      <td>item range</td>
    </tr>
  </tbody>
</table>
<h2>Column Configuration Options</h2>
<table style="text-align: left; width: 100%;" border="1" cellpadding="2"
 cellspacing="2">
  <tbody>
    <tr>
      <th style="background-color: rgb(255, 255, 204); width: 50%;">Removed</th>
      <th style="background-color: rgb(204, 255, 255);">What to use
instead</th>
    </tr>
    <tr>
      <td>-relief<br>
      </td>
      <td>-state</td>
    </tr>
    <tr>
      <td>-sunken</td>
      <td>-state</td>
    </tr>
    <tr>
      <th style="background-color: rgb(255, 255, 204);">Renamed<br>
      </th>
      <th style="background-color: rgb(204, 255, 255);">New name</th>
    </tr>
    <tr>
      <td>-arrowpad</td>
      <td>-arrowpadx</td>
    </tr>
    <tr>
      <th style="background-color: rgb(255, 255, 204);">Usage Changed</th>
      <th style="background-color: rgb(204, 255, 255);">How it changed</th>
    </tr>
    <tr>
      <td>-background</td>
      <td>This is now a per-state option. See COLUMNS in the help file
for valid state names.</td>
    </tr>
    <tr>
      <th style="background-color: rgb(255, 255, 204);">New<br>
      </th>
      <td></td>
    </tr>
    <tr>
      <td>-arrowbitmap<br>
      </td>
      <td></td>
    </tr>
    <tr>
      <td>-arrowimage</td>
      <td></td>
    </tr>
    <tr>
      <td>-arrowpady</td>
      <td></td>
    </tr>
    <tr>
      <td>-maxwidth</td>
      <td></td>
    </tr>
    <tr>
      <td>-resize</td>
      <td></td>
    </tr>
    <tr>
      <td>-state</td>
      <td></td>
    </tr>
    <tr>
      <td>-textlines</td>
      <td></td>
    </tr>
  </tbody>
</table>
<h2>Column Command</h2>
<table style="text-align: left; width: 100%;" border="1" cellpadding="2"
 cellspacing="2">
  <tbody>
    <tr>
      <th style="background-color: rgb(255, 255, 204);">Deprecated</th>
      <th style="background-color: rgb(204, 255, 255);">What to use
instead</th>
    </tr>
    <tr>
      <td>column index</td>
      <td>column id</td>
    </tr>
    <tr>
      <th style="background-color: rgb(255, 255, 204); width: 50%;">Arguments/Result
Changed</th>
      <th style="background-color: rgb(204, 255, 255);">What changed</th>
    </tr>
    <tr>
      <td>column configure<br>
      </td>
      <td>A column description of "all" is allowed if at least one
option-value pair is given.<br>
      </td>
    </tr>
    <tr>
      <td>column create</td>
      <td>The result is a unique identifier. Previously the result was
an
index in the list of columns.</td>
    </tr>
    <tr>
      <td>column delete</td>
      <td>A column description of "all" is allowed.</td>
    </tr>
    <tr>
      <th style="background-color: rgb(255, 255, 204);">New</th>
      <th style="background-color: rgb(204, 255, 255);">Comment</th>
    </tr>
    <tr>
      <td>column compare</td>
      <td></td>
    </tr>
    <tr>
      <td>column count</td>
      <td>replaces "numcolumns"</td>
    </tr>
    <tr>
      <td>column dragconfigure</td>
      <td></td>
    </tr>
    <tr>
      <td>column dragcget</td>
      <td></td>
    </tr>
    <tr>
      <td>column id</td>
      <td>replaces "column index"</td>
    </tr>
    <tr>
      <td>column list</td>
      <td></td>
    </tr>
    <tr>
      <td>column order</td>
      <td></td>
    </tr>
  </tbody>
</table>
<h2>Item Command</h2>
<table style="text-align: left; width: 100%;" border="1" cellpadding="2"
 cellspacing="2">
  <tbody>
    <tr>
      <th style="background-color: rgb(255, 255, 204);">Removed</th>
      <th style="background-color: rgb(204, 255, 255);">What to use
instead</th>
    </tr>
    <tr>
      <td>item index</td>
      <td>item order</td>
    </tr>
    <tr>
      <th style="background-color: rgb(255, 255, 204); width: 50%;">New</th>
      <th style="background-color: rgb(204, 255, 255);">Comment</th>
    </tr>
    <tr>
      <td>item compare</td>
      <td>replaces "compare"</td>
    </tr>
    <tr>
      <td>item count</td>
      <td>replaces "numitems"</td>
    </tr>
    <tr>
      <td>item id</td>
      <td>replaces "index"</td>
    </tr>
    <tr>
      <td>item order</td>
      <td>replaces "item index"</td>
    </tr>
    <tr>
      <td>item range</td>
      <td>replaces "range"</td>
    </tr>
  </tbody>
</table>
<h2>Notify Command</h2>
<table style="text-align: left; width: 100%;" border="1" cellpadding="2"
 cellspacing="2">
  <tbody>
    <tr>
      <th style="background-color: rgb(255, 255, 204); width: 50%;">Arguments/Result
Changed</th>
      <th style="background-color: rgb(204, 255, 255);">What changed</th>
    </tr>
    <tr>
      <td>notify generate<br>
      </td>
      <td>Added optional <span style="font-style: italic;">percentsCommand</span>
argument</td>
    </tr>
    <tr>
      <td>notify install</td>
      <td>Old syntax (supported but deprecated):<br>
      <pre style="margin-left: 40px;"><span style="font-weight: bold;">notify install event</span> <span
 style="font-style: italic;">eventName</span></pre>
      <pre style="margin-left: 40px;"><span style="font-weight: bold;">notify install detail</span> <span
 style="font-style: italic;">eventName</span> <span
 style="font-style: italic;">detail</span></pre>
New syntax:<br>
      <pre style="margin-left: 40px;"><span style="font-weight: bold;">notify install</span> &lt;<span
 style="font-style: italic;">eventName</span>&gt;</pre>
      <pre style="margin-left: 40px;"><span style="font-weight: bold;">notify install</span> &lt;<span
 style="font-style: italic;">eventName</span>-<span
 style="font-style: italic;">detail</span>&gt;</pre>
      </td>
    </tr>
    <tr>
      <td>notify linkage</td>
      <td>Old syntax (supported but deprecated):<br>
      <div style="margin-left: 40px;">
      <pre><span style="font-weight: bold;">notify linkage</span> <span
 style="font-style: italic;">eventName</span></pre>
      <pre><span style="font-weight: bold;">notify linkage</span> <span
 style="font-style: italic;">eventName</span> <span
 style="font-style: italic;">detail</span></pre>
      </div>
New syntax:<br>
      <div style="margin-left: 40px;">
      <pre><span style="font-weight: bold;">notify linkage</span> &lt;<span
 style="font-style: italic;">eventName</span>&gt;</pre>
      <pre><span style="font-weight: bold;">notify linkage</span> &lt;<span
 style="font-style: italic;">eventName</span>-<span
 style="font-style: italic;">detail</span>&gt;</pre>
      </div>
      </td>
    </tr>
    <tr>
      <td>notify uninstall</td>
      <td>see <span style="font-weight: bold;">notify install</span>
above</td>
    </tr>
  </tbody>
</table>
<h2>Style Layout Options</h2>
<table style="text-align: left; width: 100%;" border="1" cellpadding="2"
 cellspacing="2">
  <tbody>
    <tr>
      <th style="background-color: rgb(255, 255, 204);">Usage Changed</th>
      <th style="background-color: rgb(204, 255, 255);">How it changed</th>
    </tr>
    <tr>
      <td>-iexpand</td>
      <td>Two new flags "x' and "y" are allowed. Previously, only the

-ipadx and -ipady padding could be expanded by this option. The new xy

flags expand the display area of the element, not the padding. To

update your code, you will probably want to change this:<br>

      <div style="margin-left: 40px;">

      <pre>$T style layout $S $E -iexpand we</pre>

      </div>

to this:<br>

      <div style="margin-left: 40px;">

      <pre>$T style layout $S $E -iexpand x<br></pre>

      </div>

Keep in mind that -union elements are not affected by -iexpand xy,

since the size of a -union element is determined by the elements it

surrounds.</td>

    </tr>

    <tr>

      <th style="width: 50%; background-color: rgb(255, 255, 204);">New<br>

      </th>

      <td></td>

    </tr>

    <tr>

      <td>-height</td>

      <td></td>

    </tr>

    <tr>

      <td>-maxheight</td>

      <td></td>

    </tr>

    <tr>

      <td>-maxwidth</td>

      <td></td>

    </tr>

    <tr>

      <td>-minheight</td>

      <td></td>

    </tr>

    <tr>

      <td>-minwidth</td>

      <td></td>

    </tr>

    <tr>

      <td>-sticky</td>

      <td></td>

    </tr>

    <tr>

      <td>-width</td>

      <td></td>

    </tr>

  </tbody>

</table>

<h2>Element Changes</h2>

<ul>

  <li>A new element type&nbsp;<span style="font-weight: bold;">window</span>

was added.

See the new demo "Firefox Privacy" and the ELEMENTS section in the help

file.</li>

  <li>All element types have a new

per-state boolean option called <span style="font-weight: bold;">-draw</span>.</li>

  <li>The <span style="font-weight: bold;">text</span> element type

has a new option called <span style="font-weight: bold;">-textvariable</span>.

See the new demo

"Textvariable" and the ELEMENTS section in the help file.</li>

</ul>

<h2>Event Changes</h2>

<ul>

  <li>2 new %-substitution characters <span style="font-weight: bold;">%P</span>

and <span style="font-weight: bold;">%?</span> are allowed in binding

scripts. See the EVENTS AND SCRIPT SUBSTITUTIONS section in the help

file.</li>

  <li>The new static event <span style="font-weight: bold;">&lt;ItemDelete&gt;</span>

is generated when items are deleted. See the EVENTS AND SCRIPT

SUBSTITUTIONS section in the help file.</li>

</ul>

<h2>Library Script Changes</h2>

<h3 style="margin-left: 40px;">filelist-bindings.tcl:</h3>

<ul>

  <li>The Priv(edit) variable, which is used to specify which text

elements may be edited, now has the same format as Priv(sensitive).

Previously only elements in the first column could be edited.</li>

  <li>3 new commands in the TreeCtrl namespace should be used to access

the Priv(dragimage), Priv(edit) and Priv(sensitive) variables. The

commands are SetDragImage, SetEditable and SetSensitive.</li>

  <li>Two new dynamic events <span style="font-weight: bold;">&lt;Edit-begin&gt;</span>

and <span style="font-weight: bold;">&lt;Edit-end&gt;</span> are

generated when editing a file name.</li>

</ul>

<h3 style="margin-left: 40px;">treectrl.tcl:</h3>

<ul>

  <li>On OSX/Aqua, the Command key is used to perform discontinuous

selection. Previously the Control key was used but Command is specified

by Apple's user-interface guidelines.</li>

</ul>

<h2>Other Changes</h2>

<ul>

  <li>On WinXP, the column headers and open/close buttons are drawn

using the system theme if <span style="font-weight: bold;">-usetheme</span>

is true. The sort arrow is drawn the old-fashioned way.</li>

  <li>On OSX/Aqua,&nbsp; the column headers and open/close buttons are

drawn

using the system theme if <span style="font-weight: bold;">-usetheme</span>

is true. The sort arrow will be drawn by the Appearance Manager as

well. This will override the <span style="font-weight: bold;">-arrowside</span>

and <span style="font-weight: bold;">-arrowgravity</span> options.</li>

  <li>Columns can be moved by drag-and-drop. See <span

 style="font-weight: bold;">column dragconfigure</span> in the help

file.</li>

  <li>Columns can be specified in new ways. See the COLUMN DESCRIPTION

section in the help file.</li>

  <li>Added new section DYNAMIC EVENTS to the help file.</li>

  <li>Added new section PER-STATE OPTIONS to the help file.</li>

  <li>The new style layout option <span style="font-weight: bold;">-indent</span>

allows elements to be displayed in the button/line area. See the <span

 style="font-weight: bold;">style layout</span> command in the help

file and the new demo "Firefox Privacy".</li>

  <li>The new item description <span style="font-weight: bold;">end</span>

is equivalent to <span style="font-weight: bold;">last</span>.</li>

  <li><span style="color: rgb(255, 0, 0);">If you have version 1.1

installed, replace the old pkgIndex.tcl file with the one from this

version (but replace the version number 2.0 with 1.1).<span

 style="color: rgb(0, 0, 0);"> Otherwise the old pkgIndex.tcl file will

set the TREECTRL_LIBRARY variable which will override where the library

scripts are found.</span></span></li>

</ul>

<h2>Demo Changes</h2>

<ul>

  <li>New demo "Firefox Privacy". Demonstrates the new <span

 style="font-weight: bold;">window</span> element type and <span

 style="font-weight: bold;">-indent</span> style layout option.</li>

  <li>New demo "Textvariable". Demonstrates the new <span

 style="font-weight: bold;">-textvariable</span> option of the <span

 style="font-weight: bold;">text</span> element.</li>

  <li>Added a new Event Browser window to display events generated by

the main treectrl widget.</li>

  <li>The context menu can be popped up in all the demo lists. A

&lt;Control-ButtonPress-1&gt; binding for this was added under OSX/Aqua.</li>

  <li>In the "Explorer" demos, the file name is hidden while editing

the file name.</li>

</ul>

</body>

</html>