File: hierarchy.n.html

package info (click to toggle)
itcl3.0 3.0.1-6
  • links: PTS
  • area: main
  • in suites: sarge
  • size: 10,128 kB
  • ctags: 3,519
  • sloc: tcl: 32,416; ansic: 12,683; sh: 3,917; makefile: 692; awk: 273; perl: 265
file content (835 lines) | stat: -rw-r--r-- 23,190 bytes parent folder | download | duplicates (8)
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
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
<!-- manual page source format generated by RosettaMan v2.5a6, -->
<!-- available via anonymous ftp from ftp.cs.berkeley.edu:/ucb/people/phelps/tcltk/rman.tar.Z -->
<HTML>
<HEAD>
<TITLE>man page(1) manual page</TITLE>
</HEAD>
<BODY>
<A HREF="#toc">Table of Contents</A><P>
_________________________________________________________________
<P>

<H2><A NAME="sect1" HREF="#toc1"><B>NAME</B></A></H2>

hierarchy - Create and manipulate a hierarchy widget
<P>

<H2><A NAME="sect2" HREF="#toc2"><B>SYNOPSIS</B></A></H2>

<B>hierarchy</B> <I>pathName</I> ?<I>options</I>?
<P>

<H2><A NAME="sect3" HREF="#toc3"><B>INHERITANCE</B></A></H2>

itk::Widget &lt;- Labeledwidget &lt;- Scrolledwidget &lt;- Hierarchy
<P>

<H2><A NAME="sect4" HREF="#toc4"><B>STANDARD</B> <B>OPTIONS</B></A></H2>

<DL>
<DT><B>activeBackground</B> <DD>              <B>activeForegroundbackgroundborderWidth</B>
<B>cursor</B>          <B>disabledForeground</B>             <B>foregroundhighlightColor</B>
</DD>
</DL>
<DL>
<DT><B>highlightThickness</B> <DD>            <B>relief</B>          <B>selectBackgroundselectForeground</B>
<P>
</DD>
</DL>
See the &quot;options&quot; manual entry for details on the standard
options.
<P>

<H2><A NAME="sect5" HREF="#toc5"><B>ASSOCIATED</B> <B>OPTIONS</B></A></H2>

<B>activeRelief</B>    <B>elementBorderWidth</B>             <B>jumptroughColor</B>
<P>
See the &quot;scrollbar&quot; widget manual entry for details on the
above associated options.
<P>
<B>spacing1</B>        <B>spacing2</B>       <B>spacing3</B>        <B>tabs</B>
<P>
See the &quot;text&quot; widget manual entry for details on the above
associated options.
<P>

<H2><A NAME="sect6" HREF="#toc6"><B>INHERITED</B> <B>OPTIONS</B></A></H2>

<B>labelBitmap</B>     <B>labelFont</B>      <B>labelImage</B>      <B>labelMargin</B>
<DL>
<DT><B>labelPos</B> <DD>       <B>labelText</B>      <B>labelVariable</B>
<P>
</DD>
</DL>
See the &quot;labeledwidget&quot; class manual entry for details on
the inherited options.
<P>

<H2><A NAME="sect7" HREF="#toc7"><B>WIDGET-SPECIFIC</B> <B>OPTIONS</B></A></H2>

<DL>
<DT>Name: <DD>          <B>alwaysQuery</B>
</DD>
</DL>
<DL>
<DT>Class: <DD>         <B>AlwaysQuery</B>
</DD>
</DL>
<DL>
<DT>Command-Line Switch: <DD>          <B>-alwaysquery</B>
<P>
</DD>
</DL>
Boolean flag which tells the hierarchy widget weather
or not each refresh of the display should be via a new
query using the command value of the -querycommand
option or use the values previous found the last time
the query was made. The default is no.
<P>
<DL>
<DT>Name: <DD>          <B>closedIcon</B>
</DD>
</DL>
<DL>
<DT>Class: <DD>         <B>Icon</B>
</DD>
</DL>
<DL>
<DT>Command-Line Switch: <DD>          <B>-closedicon</B>
<P>
</DD>
</DL>
Specifies the name of an existing closed icon image to
be used in the hierarchy before those nodes that are
collapsed. Should one not be provided, then a folder
icon will be generated, pixmap if possible, bitmap otherwise.
<P>
<DL>
<DT>Name: <DD>          <B>expanded</B>
</DD>
</DL>
<DL>
<DT>Class: <DD>         <B>Expanded</B>
</DD>
</DL>
<DL>
<DT>Command-Line Switch: <DD>          <B>-expanded</B>
<P>
</DD>
</DL>
When true, the hierarchy will be completely expanded
when it is first displayed. A fresh display can be
triggered by resetting the -querycommand option. The
default is false.
<P>
<DL>
<DT>Name: <DD>          <B>filter</B>
</DD>
</DL>
<DL>
<DT>Class: <DD>         <B>Filter</B>
</DD>
</DL>
<DL>
<DT>Command-Line Switch: <DD>          <B>-filter</B>
<P>
</DD>
</DL>
When true only the branch nodes and selected items are
displayed. This gives a compact view of important
items. The default is false.
<P>
<DL>
<DT>Name: <DD>          <B>height</B>
</DD>
</DL>
<DL>
<DT>Class: <DD>         <B>Height</B>
</DD>
</DL>
<DL>
<DT>Command-Line Switch: <DD>          <B>-height</B>
<P>
</DD>
</DL>
Specifies the height of the hierarchy as an entire
unit. The value may be specified in any of the forms
acceptable to <B>Tk_GetPixels</B>. Any additional space
needed to display the other components such as labels,
margins, and scrollbars force the hierarchy to be
compressed. A value of zero along with the same value
for the width causes the value given for the visibleitems
option to be applied which administers
geometry constraints in a different manner.    The
default height is zero.
<P>
<DL>
<DT>Name: <DD>          <B>iconCommand</B>
</DD>
</DL>
<DL>
<DT>Class: <DD>         <B>Command</B>
</DD>
</DL>
<DL>
<DT>Command-Line Switch: <DD>          <B>-iconcommand</B>
<P>
</DD>
</DL>
Specifies a command to be executed upon user selection
via mouse button one of any additional icons given in
the values returned by the command associated with the
-querycommand option. If this command contains &quot;%n",
it is replaced with the name of the node the icon
belongs to. Should it contain &quot;%i&quot; then the icon name
is substituted.
<P>
<DL>
<DT>Name: <DD>          <B>markBackground</B>
</DD>
</DL>
<DL>
<DT>Class: <DD>         <B>Foreground</B>
<P>
</DD>
</DL>
<DL>
<DT>Command-Line Switch: <DD>          <B>-markbackground</B>
<P>
</DD>
</DL>
Specifies the background color to use when displaying
marked nodes.
<P>
<DL>
<DT>Name: <DD>          <B>markForeground</B>
</DD>
</DL>
<DL>
<DT>Class: <DD>         <B>Background</B>
</DD>
</DL>
<DL>
<DT>Command-Line Switch: <DD>          <B>-markforeground</B>
<P>
</DD>
</DL>
Specifies the foreground color to use when displaying
marked nodes.
<P>
<DL>
<DT>Name: <DD>          <B>menuCursor</B>
</DD>
</DL>
<DL>
<DT>Class: <DD>         <B>Cursor</B>
</DD>
</DL>
<DL>
<DT>Command-Line Switch: <DD>          <B>-menucursor</B>
<P>
</DD>
</DL>
Specifies the mouse cursor to be used for the item and
background menus. The value may have any of the forms
accept able to Tk_GetCursor.
<P>
<DL>
<DT>Name: <DD>          <B>nodeIcon</B>
</DD>
</DL>
<DL>
<DT>Class: <DD>         <B>Icon</B>
</DD>
</DL>
<DL>
<DT>Command-Line Switch: <DD>          <B>-nodeicon</B>
<P>
</DD>
</DL>
Specifies the name of an existing node icon image to be
used in the hierarchy before those nodes that are
leafs. Should one not be provided, then a dog-eared
page icon will be generated, pixmap if possible, bitmap
otherwise.
<P>
<DL>
<DT>Name: <DD>          <B>openIcon</B>
</DD>
</DL>
<DL>
<DT>Class: <DD>         <B>Icon</B>
</DD>
</DL>
<DL>
<DT>Command-Line Switch: <DD>          <B>-openicon</B>
<P>
</DD>
</DL>
Specifies the name of an existing open icon image to be
used in the hierarchy before those nodes that are
expanded. Should one not be provided, then an open
folder icon will be generated, pixmap if possible, bitmap
otherwise.
<P>
<DL>
<DT>Name: <DD>          <B>queryCommand</B>
</DD>
</DL>
<DL>
<DT>Class: <DD>         <B>Command</B>
</DD>
</DL>
<DL>
<DT>Command-Line Switch: <DD>          <B>-querycommand</B>
<P>
</DD>
</DL>
Specifies the command executed to query the contents of
each node. If this command contains &quot;%n", it is
replaced with the name of the desired node. In its
simpilest form it should return the children of the
given node as a list which will be depicted in the
display. Since the names of the children are used as
tags in the underlying text widget, each child must be
unique in the hierarchy.    Due to the unique
requirement, the nodes shall be reffered to as uids or
uid in the singular sense. The format of returned list
is
<P>
{uid [uid ...]}
<P>
where uid is a unique id and primary key for the
hierarchy entry
<P>
Should the unique requirement pose a problem, the list
returned can take on another more extended form which
enables the association of text to be displayed with
the uids. The uid must still be unique, but the text
does not have to obey the unique rule. In addition,
the format also allows the specification of additional
tags to be used on the same entry in the hierarchy as
the uid and additional icons to be displayed just
before the node. The tags and icons are considered to
be the property of the user in that the hierarchy
widget will not depend on any of their values. The
extended format is
<P>
{{uid [text [tags [icons]]]} {uid [text [tags
[icons]]]} ...}
<P>
where uid is a unique id and primary key for the
hierarchy entry<BR>

text is the text to be displayed for this uid
tags is a list of user tags to be applied to
the entry<BR>

icons is a list of icons to be displayed in
front of the text
<P>
The hierarchy widget does a look ahead from each node
to determine if the node has a children. This can be
cost some performace with large hierarchies. User's
can avoid this by providing a hint in the user tags. A
tag of &quot;leaf&quot; or &quot;branch&quot; tells the hierarchy widget
the information it needs to know thereby avoiding the
look ahead operation.
<P>
<DL>
<DT>Name: <DD>          <B>hscrollMode</B>
</DD>
</DL>
<DL>
<DT>Class: <DD>         <B>ScrollMode</B>
</DD>
</DL>
<DL>
<DT>Command-Line Switch: <DD>          <B>-hscrollmode</B>
<P>
</DD>
</DL>
Specifies the the display mode to be used for the horizontal
scrollbar: <B>static,</B> <B>dynamic,</B> or <B>none</B>. In static
mode, the scroll bar is displayed at all times.
Dynamic mode displays the scroll bar as required, and
none disables the scroll bar display. The default is
static.
<P>
<DL>
<DT>Name: <DD>          <B>sbWidth</B>
</DD>
</DL>
<DL>
<DT>Class: <DD>         <B>Width</B>
</DD>
</DL>
<DL>
<DT>Command-Line Switch: <DD>          <B>-sbwidth</B>
<P>
</DD>
</DL>
Specifies the width of the scrollbar in any of the
forms acceptable to <B>Tk_GetPixels</B>.
<P>
<DL>
<DT>Name: <DD>          <B>scrollMargin</B>
</DD>
</DL>
<DL>
<DT>Class: <DD>         <B>Margin</B>
</DD>
</DL>
<DL>
<DT>Command-Line Switch: <DD>          <B>-scrollmargin</B>
<P>
</DD>
</DL>
Specifies the distance between the text portion of the
hierarchy and the scrollbars in any of the forms
acceptable to <B>Tk_GetPixels</B>. The default is 3 pixels.
<P>
<DL>
<DT>Name: <DD>          <B>textBackground</B>
</DD>
</DL>
<DL>
<DT>Class: <DD>         <B>Background</B>
</DD>
</DL>
<DL>
<DT>Command-Line Switch: <DD>          <B>-textbackground</B>
<P>
</DD>
</DL>
Specifies the background color for the text portion of
the hierarchy in any of the forms acceptable to
<B>Tk_GetColor</B>.
<P>
<DL>
<DT>Name: <DD>          <B>textFont</B>
</DD>
</DL>
<DL>
<DT>Class: <DD>         <B>Font</B>
</DD>
</DL>
<DL>
<DT>Command-Line Switch: <DD>          <B>-textfont</B>
<P>
</DD>
</DL>
Specifies the font to be used in the text portion of
the hierarchy.
<P>
<DL>
<DT>Name: <DD>          <B>visibleitems</B>
</DD>
</DL>
<DL>
<DT>Class: <DD>         <B>VisibleItems</B>
</DD>
</DL>
<DL>
<DT>Command-Line Switch: <DD>          <B>-visibleitems</B>
<P>
</DD>
</DL>
Specifies the widthxheight in characters and lines for
the hierarchy. This option is only administered if the
width and height options are both set to zero, otherwise
they take precedence. The default value is 80x24.
With the visibleitems option engaged, geometry constraints
are maintained only on the text portion of the
hierarchy. The size of the other components such as
labels, margins, and scroll bars, are additive and
independent, effecting the overall size of the hierarchy.
In contrast, should the width and height options
have non zero values, they are applied to the hierarchy
as a whole. The hierarchy is compressed or expanded to
maintain the geometry constraints.
<P>
<DL>
<DT>Name: <DD>          <B>vscrollMode</B>
</DD>
</DL>
<DL>
<DT>Class: <DD>         <B>ScrollMode</B>
</DD>
</DL>
<DL>
<DT>Command-Line Switch: <DD>          <B>-vscrollmode</B>
<P>
</DD>
</DL>
Specifies the the display mode to be used for the vertical
scrollbar: <B>static,</B> <B>dynamic,</B> or <B>none</B>. In static
mode, the scroll bar is displayed at all times.
Dynamic mode displays the scroll bar as required, and
none disables the scroll bar display. The default is
static.
<P>
<DL>
<DT>Name: <DD>          <B>width</B>
</DD>
</DL>
<DL>
<DT>Class: <DD>         <B>Width</B>
</DD>
</DL>
<DL>
<DT>Command-Line Switch: <DD>          <B>-width</B>
<P>
</DD>
</DL>
Specifies the width of the hierarchy as an entire unit.
The value may be specified in any of the forms acceptable
to <B>Tk_GetPixels</B>. Any additional space needed to
display the other components such as labels, margins,
and scrollbars force the text portion of the hierarchy
to be compressed. A value of zero along with the same
value for the height causes the value given for the
visibleitems option to be applied which administers
geometry constraints in a different manner.    The
default width is zero.
<P>
_________________________________________________________________
<P>

<H2><A NAME="sect8" HREF="#toc8"><B>DESCRIPTION</B></A></H2>

The <B>hierarchy</B> command creates a hierarchical data view
widget. It allows the graphical management of a a list of
nodes that can be expanded or collapsed. Individual nodes
can be highlighted. Clicking with the right mouse button on
any item brings up a special item menu. Clicking on the
background area brings up a different popup menu. Options
exist to provide user control over the loading of the nodes
and actions associated with node selection. Since the
hierarchy is based on the scrolledtext widget, it includes
options to control the method in which the scrollbars are
displayed, i.e. statically or dynamically. Options also
exist for adding a label to the hierarchy and controlling
its position.
<P>

<H2><A NAME="sect9" HREF="#toc9"><B>METHODS</B></A></H2>

The <B>hierarchy</B> command creates a new Tcl command whose name
is <I>pathName</I>. This command may be used to invoke various
operations on the widget. It has the following general
form:
<P>
<I>pathName</I> <I>option</I> ?<I>arg</I> <I>arg</I> ...?
<P>
<I>Option</I> and the <I>arg</I>s determine the exact behavior of the command.
The following commands are possible for hierarchy
widgets:
<P>

<H2><A NAME="sect10" HREF="#toc10"><B>ASSOCIATED</B> <B>METHODS</B></A></H2>

<DL>
<DT><B>bbox</B> <DD>           <B>compare</B>        <B>debug</B>           <B>delete</B>
<B>dlineinfo</B>       <B>dump</B>           <B>get</B>             <B>index</B>
<B>insert</B>          <B>scan</B>           <B>search</B>          <B>see</B>
</DD>
</DL>
<DL>
<DT><B>tag</B> <DD>            <B>window</B>         <B>xview</B>           <B>yview</B>
<P>
</DD>
</DL>
See the &quot;text&quot; manual entry for details on the standard
methods.
<P>

<H2><A NAME="sect11" HREF="#toc11"><B>WIDGET-SPECIFIC</B> <B>METHODS</B></A></H2>

<I>pathName</I> <B>cget</B> <I>option</I><BR>

Returns the current value of the configuration option
given by <I>option</I>. <I>Option</I> may have any of the values
accepted by the <B>hierarchy</B> command.
<P>
<I>pathName</I> <B>clear</B><BR>

Removes all items from the hierarchy display including
all tags and icons. The display will remain empty until
the -filter or -querycommand options are set.
<P>
<I>pathName</I> <B>collapse</B> <I>uid</I><BR>

Collapses the hierarchy beneath the node with the
specified unique id by one level. Since this can take
a moment for large hierarchies, the cursor will be
changed to a watch during the collapse. Also, if any
of the nodes beneath the node being collapsed are
selected, their status is changed to unselected.
<P>
<I>pathName</I> <B>configure</B> ?<I>option</I>? ?<I>value</I> <I>option</I> <I>value</I> ...?
Query or modify the configuration options of the
widget. If no <I>option</I> is specified, returns a list
describing all of the available options for <I>pathName</I>
(see <B>Tk_ConfigureInfo</B> for information on the format of
this list). If <I>option</I> is specified with no <I>value</I>, then
the command returns a list describing the one named
option (this list will be identical to the corresponding
sublist of the value returned if no <I>option</I> is
specified). If one or more <I>option</I> - <I>value</I> pairs are
specified, then the command modifies the given widget
option(s) to have the given value(s); in this case the
command returns an empty string. <I>Option</I> may have any
of the values accepted by the <B>hierarchy</B> command.
<P>
<I>pathName</I> <B>current</B><BR>

Returns the tags for the node that was most recently
selected by the right mouse button when the item menu
was posted. Usually used by the code in the item menu
to figure out what item is being manipulated.
<P>
<I>pathName</I> <B>draw</B> ?<I>when</I>?<BR>

Performs a complete redraw of the entire hierarchy.
<P>
When may be either -now or -eventually where the latter
means the draw can be performed after idle.
<P>
<I>pathName</I> <B>expand</B> <I>uid</I><BR>

Expands the hierarchy beneath the node with the specified
unique id by one level. Since this can take a
moment for large hierarchies, the cursor will be
changed to a watch during the expansion.
<P>
<I>pathName</I> <B>mark</B> <I>option</I> ?<I>arg</I> <I>arg</I> ...?<BR>

This command is used to manipulate marks which is quite
similar to selection, adding a secondary means of
hilighting an item in the hierarchy. The exact
behavior of the command depends on the <I>option</I> argument
that follows the <B>mark</B> argument. The following forms of
the command are currently supported:
<P>
<I>pathName</I> <B>mark</B> <B>clear</B><BR>

Clears all the currently marked nodes in the
hierarchy.
<P>
<I>pathName</I> <B>mark</B> <B>add</B> <I>uid</I> ?<I>uid</I> <I>uid</I> ...?
Marks the nodes with the specified uids in the
hierarchy using the <B>-markbackground</B> and <B>-markforeground</B>
options and without affecting the mark
state of any other nodes that were already marked.
<P>
<I>pathName</I> <B>mark</B> <B>remove</B> <I>uid</I> ?<I>uid</I> <I>uid</I> ...?
Unmarks the nodes with the specified uids in the
hierarchy without affecting the mark state of any
other nodes that were already marked.
<P>
<I>pathName</I> <B>mark</B> <B>get</B><BR>

Returns a list of the unique ids that are
currently marked.
<P>
<I>pathName</I> <B>refresh</B> <I>uid</I><BR>

Performs a redraw of a specific node that has the given
uid. If the node is not currently visible or in other
words already drawn on the text, then no action is
taken.
<P>
<I>pathName</I> <B>prune</B> <I>uid</I><BR>

Removes the node specified by the given uid from the
hierarchy. Should the node have children, then all of
its children will be removed as well.
<P>
<I>pathName</I> <B>selection</B> <I>option</I> ?<I>arg</I> <I>arg</I> ...?<BR>

This command is used to manipulate the selection of
nodes in the hierarchy. The exact behavior of the command
depends on the <I>option</I> argument that follows the
<B>selection</B> argument. The following forms of the command
are currently supported:
<P>
<I>pathName</I> <B>selection</B> <B>clear</B><BR>

Clears all the currently selected nodes in the
hierarchy.
<P>
<I>pathName</I> <B>selection</B> <B>add</B> <I>uid</I> ?<I>uid</I> <I>uid</I> ...?
Selects the nodes with the specified uids in the
hierarchy using the <B>-selectionbackground</B> and
<B>-selectionforeground</B> options and without affecting
the selection state of any other nodes that were
already selected.
<P>
<I>pathName</I> <B>selection</B> <B>remove</B> <I>uid</I> ?<I>uid</I> <I>uid</I> ...?
Deselects the nodes with the specified uids in the
hierarchy without affecting the selection state of
any other nodes that were already selected.
<P>
<I>pathName</I> <B>selection</B> <B>get</B><BR>

Returns a list of the unique ids that are
currently selected.<BR>

A nodes selection status is also dependent on it being visible.
If a node is selected and its parent is then collapsed
making the selected node not visible, then its selection
status is changed to unselected.
<P>
<I>pathName</I> <B>toggle</B> <I>uid</I><BR>

Toggles the hierarchy beneath the node with the specified
unique id. If the hierarchy is currently
expanded, then it is collapsed, and vice-versa.
<P>

<H2><A NAME="sect12" HREF="#toc12"><B>COMPONENTS</B></A></H2>

<DL>
<DT>Name: <DD>          <B>list</B>
</DD>
</DL>
<DL>
<DT>Class: <DD>         <B>Text</B>
<P>
</DD>
</DL>
The list component is the text widget in which the
hierarchy is displayed. See the &quot;text&quot; widget manual
entry for details on the text component item.
<P>
<DL>
<DT>Name: <DD>          <B>bgMenu</B>
</DD>
</DL>
<DL>
<DT>Class: <DD>         <B>Menu</B>
<P>
</DD>
</DL>
The bgMenu component is the popup menu which is
displayed upon pressing the right mouse button in the
background, i.e. not over a specific node. Menu items
can be added along with their commands via the component
command. See the &quot;menu&quot; widget manual entry for
details on the bgMenu component item.
<P>
<DL>
<DT>Name: <DD>          <B>horizsb</B>
</DD>
</DL>
<DL>
<DT>Class: <DD>         <B>Scrollbar</B>
<P>
</DD>
</DL>
The horizsb component is the horizontal scroll bar.
See the &quot;scrollbar&quot; widget manual entry for details on
the horizsb component item.
<P>
<DL>
<DT>Name: <DD>          <B>itemMenu</B>
</DD>
</DL>
<DL>
<DT>Class: <DD>         <B>Menu</B>
<P>
</DD>
</DL>
The itemMenu component is the popup menu which is
displayed upon selection of a hierarchy node with the
right mouse button. Menu items can be added along with
their commands via the component command. See the
&quot;menu&quot; widget manual entry for details on the itemMenu
component item.
<P>
<DL>
<DT>Name: <DD>          <B>vertsb</B>
</DD>
</DL>
<DL>
<DT>Class: <DD>         <B>Scrollbar</B>
<P>
</DD>
</DL>
The vertsb component is the vertical scroll bar. See
the &quot;scrollbar&quot; widget manual entry for details on the
vertsb component item.
<P>

<H2><A NAME="sect13" HREF="#toc13"><B>EXAMPLE</B></A></H2>

proc get_files {file} {<BR>

global env
<P>
if {$file == &quot;"} {<BR>

set dir $env(HOME)<BR>

} else {<BR>

set dir $file<BR>

}
<P>
if {[catch {cd $dir}] != 0} {<BR>

return &quot;"<BR>

}
<P>
set rlist &quot;"
<P>
foreach file [lsort [glob -nocomplain *]] {
lappend rlist [list [file join $dir $file] $file]
}
<P>
return $rlist<BR>

}
<P>
<DL>
<DT>hierarchy .h -querycommand &quot;get_files %n&quot; -visibleitems 30x15 <DD>    -labeltext $env(HOME)
pack .h -side left -expand yes -fill both
<P>
</DD>
</DL>

<H2><A NAME="sect14" HREF="#toc14"><B>AUTHOR</B></A></H2>

Mark L. Ulferts
<P>
Michael J. McLennan
<P>

<H2><A NAME="sect15" HREF="#toc15"><B>KEYWORDS</B></A></H2>

hierarchy, text, widget
<P>

<HR><P>
<A NAME="toc"><B>Table of Contents</B></A><P>
<UL>
<LI><A NAME="toc1" HREF="#sect1">NAME</A></LI>
<LI><A NAME="toc2" HREF="#sect2">SYNOPSIS</A></LI>
<LI><A NAME="toc3" HREF="#sect3">INHERITANCE</A></LI>
<LI><A NAME="toc4" HREF="#sect4">STANDARD OPTIONS</A></LI>
<LI><A NAME="toc5" HREF="#sect5">ASSOCIATED OPTIONS</A></LI>
<LI><A NAME="toc6" HREF="#sect6">INHERITED OPTIONS</A></LI>
<LI><A NAME="toc7" HREF="#sect7">WIDGET-SPECIFIC OPTIONS</A></LI>
<LI><A NAME="toc8" HREF="#sect8">DESCRIPTION</A></LI>
<LI><A NAME="toc9" HREF="#sect9">METHODS</A></LI>
<LI><A NAME="toc10" HREF="#sect10">ASSOCIATED METHODS</A></LI>
<LI><A NAME="toc11" HREF="#sect11">WIDGET-SPECIFIC METHODS</A></LI>
<LI><A NAME="toc12" HREF="#sect12">COMPONENTS</A></LI>
<LI><A NAME="toc13" HREF="#sect13">EXAMPLE</A></LI>
<LI><A NAME="toc14" HREF="#sect14">AUTHOR</A></LI>
<LI><A NAME="toc15" HREF="#sect15">KEYWORDS</A></LI>
</UL>
</BODY></HTML>