1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
3 <HEAD><TITLE>treeview manual page - BLT Built-In Commands</TITLE><!--#include virtual="/man/maninc.html"-->
4 <link rel="stylesheet" href="../docs.css" type="text/css" media="all">
8 <DD><A HREF="treeview.htm#M2" NAME="L4310">NAME</A>
9 <DL><DD>treeview - Create and manipulate hierarchical table widgets</DD></DL>
10 <DD><A HREF="treeview.htm#M3" NAME="L4311">SYNOPSIS</A>
13 <DD><A HREF="treeview.htm#M4" NAME="L4312">DESCRIPTION</A>
14 <DD><A HREF="treeview.htm#M5" NAME="L4313">INTRODUCTION</A>
15 <DD><A HREF="treeview.htm#M6" NAME="L4314">TREE DATA OBJECT</A>
16 <DD><A HREF="treeview.htm#M7" NAME="L4315">SYNTAX</A>
17 <DD><A HREF="treeview.htm#M8" NAME="L4316">IDS AND TAGS</A>
18 <DD><A HREF="treeview.htm#M9" NAME="L4317">SPECIAL NODE IDS</A>
19 <DL class="special node ids">
20 <DD><A HREF="treeview.htm#M10" NAME="L4318"><B>active</B></A>
21 <DD><A HREF="treeview.htm#M11" NAME="L4319"><B>anchor</B></A>
22 <DD><A HREF="treeview.htm#M12" NAME="L4320"><B>bottom</B></A>
23 <DD><A HREF="treeview.htm#M13" NAME="L4321"><B>current</B></A>
24 <DD><A HREF="treeview.htm#M14" NAME="L4322"><B>down</B></A>
25 <DD><A HREF="treeview.htm#M15" NAME="L4323"><B>end</B></A>
26 <DD><A HREF="treeview.htm#M16" NAME="L4324"><B>focus</B></A>
27 <DD><A HREF="treeview.htm#M17" NAME="L4325"><B>last</B></A>
28 <DD><A HREF="treeview.htm#M18" NAME="L4326"><B>mark</B></A>
29 <DD><A HREF="treeview.htm#M19" NAME="L4327"><B>next</B></A>
30 <DD><A HREF="treeview.htm#M20" NAME="L4328"><B>nextsibling</B></A>
31 <DD><A HREF="treeview.htm#M21" NAME="L4329"><B>parent</B></A>
32 <DD><A HREF="treeview.htm#M22" NAME="L4330"><B>prev</B></A>
33 <DD><A HREF="treeview.htm#M23" NAME="L4331"><B>prevsibling</B></A>
34 <DD><A HREF="treeview.htm#M24" NAME="L4332"><B>root</B></A>
35 <DD><A HREF="treeview.htm#M25" NAME="L4333"><B>tail</B></A>
36 <DD><A HREF="treeview.htm#M26" NAME="L4334"><B>top</B></A>
37 <DD><A HREF="treeview.htm#M27" NAME="L4335"><B>up</B></A>
38 <DD><A HREF="treeview.htm#M28" NAME="L4336"><B>view.top</B></A>
39 <DD><A HREF="treeview.htm#M29" NAME="L4337"><B>view.bottom</B></A>
40 <DD><A HREF="treeview.htm#M30" NAME="L4338"><B>@</B><I>x</I><B>,</B><I>y</I></A>
41 <DD><A HREF="treeview.htm#M31" NAME="L4339"><B>@</B><I>ID</I><B>-></B><I>LABEL</I>-><I>LABEL</I>...</A>
43 <DD><A HREF="treeview.htm#M32" NAME="L4340">DATA FIELDS</A>
44 <DD><A HREF="treeview.htm#M33" NAME="L4341">ENTRY BINDINGS</A>
45 <DD><A HREF="treeview.htm#M34" NAME="L4342">TREEVIEW OPERATIONS</A>
46 <DL class="treeview operations">
47 <DD><A HREF="treeview.htm#M35" NAME="L4343"><I>pathName </I><B>bbox</B> ?<B>-screen</B>? <I>tagOrId...</I></A>
48 <DL class="treeview operations">
49 <DD><A HREF="treeview.htm#M36" NAME="L4344"><I>x</I></A>
50 <DD><A HREF="treeview.htm#M37" NAME="L4345"><I>y</I></A>
51 <DD><A HREF="treeview.htm#M38" NAME="L4346"><I>width</I></A>
52 <DD><A HREF="treeview.htm#M39" NAME="L4347"><I>height</I></A>
54 <DD><A HREF="treeview.htm#M40" NAME="L4348"><I>pathName </I><B>bind</B> <I>tagName</I> ?<I>sequence command</I>?</A>
55 <DD><A HREF="treeview.htm#M41" NAME="L4349"><I>pathName </I><B>button </B><I>operation</I> ?<I>args</I>?</A>
56 <DL class="treeview operations">
57 <DD><A HREF="treeview.htm#M42" NAME="L4350"><I>pathName </I><B>button activate</B> <I>tagOrId</I></A>
58 <DD><A HREF="treeview.htm#M43" NAME="L4351"><I>pathName </I><B>button bind</B> <I>tagName</I> ?<I>sequence command</I>?</A>
59 <DD><A HREF="treeview.htm#M44" NAME="L4352"><I>pathName </I><B>button cget</B> <I>option</I></A>
60 <DD><A HREF="treeview.htm#M45" NAME="L4353"><I>pathName </I><B>button configure</B> ?<I>option</I>? ?<I>value option value ...</I>?</A>
62 <DD><A HREF="treeview.htm#M46" NAME="L4354"><I>pathName </I><B>cget</B> <I>option</I></A>
63 <DD><A HREF="treeview.htm#M47" NAME="L4355"><I>pathName </I><B>close </B>?<B>-recurse</B>? ?<B>-trees</B>? <I>tagOrId...</I></A>
64 <DD><A HREF="treeview.htm#M48" NAME="L4356"><I>pathName </I><B>column </B><I>operation</I> ?<I>args</I>?</A>
65 <DL class="treeview operations">
66 <DD><A HREF="treeview.htm#M49" NAME="L4357"><I>pathName </I><B>column activate</B> <I>column</I></A>
67 <DD><A HREF="treeview.htm#M50" NAME="L4358"><I>pathName </I><B>column bbox</B> <I>column entry</I></A>
68 <DD><A HREF="treeview.htm#M51" NAME="L4359"><I>pathName </I><B>column bind</B> <I>column</I> ?<I>sequence command</I>?</A>
69 <DD><A HREF="treeview.htm#M52" NAME="L4360"><I>pathName </I><B>column cget</B> <I>name</I> <I>option</I></A>
70 <DD><A HREF="treeview.htm#M53" NAME="L4361"><I>pathName </I><B>column configure</B> <I>name</I> ?<I>name</I> ...? ?<I>option</I>? ?<I>value option value </I> ...?</A>
71 <DD><A HREF="treeview.htm#M54" NAME="L4362"><I>pathName </I><B>column current</B></A>
72 <DD><A HREF="treeview.htm#M55" NAME="L4363"><I>pathName </I><B>column delete</B> <I>field</I> ?<I>field</I>...?</A>
73 <DD><A HREF="treeview.htm#M56" NAME="L4364"><I>pathName </I><B>column index</B> <I>index</I></A>
74 <DD><A HREF="treeview.htm#M57" NAME="L4365"><I>pathName </I><B>column insert</B> <I>position</I> <I>field</I> ?<I>field</I> ...? ?<I>options</I>...?</A>
75 <DD><A HREF="treeview.htm#M58" NAME="L4366"><I>pathName </I><B>column invoke</B> <I>field</I></A>
76 <DD><A HREF="treeview.htm#M59" NAME="L4367"><I>pathName </I><B>column isset ?</B><I>startOrTag</I>? ?<I>end</I>?</A>
77 <DD><A HREF="treeview.htm#M60" NAME="L4368"><I>pathName </I><B>column istree </B><I>field</I></A>
78 <DD><A HREF="treeview.htm#M61" NAME="L4369"><I>pathName </I><B>column move </B><I>name</I> <I>dest</I></A>
79 <DD><A HREF="treeview.htm#M62" NAME="L4370"><I>pathName </I><B>column names ?</B><I>-visible</I>? ?<I>PATTERN</I>?</A>
80 <DD><A HREF="treeview.htm#M63" NAME="L4371"><I>pathName </I><B>column nearest</B> <I>x</I> ?<I>y</I>?</A>
81 <DD><A HREF="treeview.htm#M64" NAME="L4372"><I>pathName </I><B>column offsets</B></A>
82 <DD><A HREF="treeview.htm#M65" NAME="L4373"><I>pathName </I><B>column resize op ...</B></A>
83 <DD><A HREF="treeview.htm#M66" NAME="L4374"><I>pathName </I><B>column see</B> ?<B>-anchor</B> <I>anchor</I>? <I>field</I></A>
84 <DD><A HREF="treeview.htm#M67" NAME="L4375"><I>pathName </I><B>column values</B> ?<B>-visible</B>? ?<B>-default value</B>? <I>field</I> ?<I>start</I>? ?<I>end</I>?</A>
86 <DD><A HREF="treeview.htm#M68" NAME="L4376"><I>pathName </I><B>configure</B> ?<I>option</I>? ?<I>value option value ...</I>?</A>
87 <DD><A HREF="treeview.htm#M69" NAME="L4377"><I>pathName </I><B>curselection</B></A>
88 <DD><A HREF="treeview.htm#M70" NAME="L4378"><I>pathName </I><B>delete </B><I>tagnode</I>...</A>
89 <DD><A HREF="treeview.htm#M71" NAME="L4379"><I>pathName </I><B>edit ?</B><I>-test -root</I>? <I>X Y</I></A>
90 <DD><A HREF="treeview.htm#M72" NAME="L4380"><I>pathName </I><B>entry </B><I>operation</I> ?<I>args</I>?</A>
91 <DL class="treeview operations">
92 <DD><A HREF="treeview.htm#M73" NAME="L4381"><I>pathName </I><B>entry activate</B> <I>tagOrId</I></A>
93 <DD><A HREF="treeview.htm#M74" NAME="L4382"><I>pathName </I><B>entry cget</B> <I>option</I></A>
94 <DD><A HREF="treeview.htm#M75" NAME="L4383"><I>pathName </I><B>entry children</B> <I>tagOrId</I> ?<I>first</I>? ?<I>last</I>?</A>
95 <DD><A HREF="treeview.htm#M76" NAME="L4384"><I>pathName </I><B>entry configure</B> <I>tagnode</I> ?<I>option</I>? ?<I>value option value ...</I>?</A>
96 <DD><A HREF="treeview.htm#M77" NAME="L4385"><I>pathName </I><B>entry delete</B> <I>tagOrId</I> ?<I>first</I> ?<I>last</I>?</A>
97 <DD><A HREF="treeview.htm#M78" NAME="L4386"><I>pathName </I><B>entry depth </B><I>tagOrId</I></A>
98 <DD><A HREF="treeview.htm#M79" NAME="L4387"><I>pathName </I><B>entry down </B><I>tagOrId</I></A>
99 <DD><A HREF="treeview.htm#M80" NAME="L4388"><I>pathName </I><B>entry get</B> <I>tagOrId</I> ?<I>key</I>? ?<I>default</I>?</A>
100 <DD><A HREF="treeview.htm#M81" NAME="L4389"><I>pathName </I><B>entry isbefore </B><I>tagOrId1</I> <I>tagOrId2</I></A>
101 <DD><A HREF="treeview.htm#M82" NAME="L4390"><I>pathName </I><B>entry ishidden </B><I>tagOrId</I></A>
102 <DD><A HREF="treeview.htm#M83" NAME="L4391"><I>pathName </I><B>entry isopen </B><I>tagOrId</I></A>
103 <DD><A HREF="treeview.htm#M84" NAME="L4392"><I>pathName </I><B>entry isset </B> <I>tagOrId col</I></A>
104 <DD><A HREF="treeview.htm#M85" NAME="L4393"><I>pathName </I><B>entry isvisible </B><I>tagOrId</I></A>
105 <DD><A HREF="treeview.htm#M86" NAME="L4394"><I>pathName </I><B>entry next </B><I>tagOrId</I></A>
106 <DD><A HREF="treeview.htm#M87" NAME="L4395"><I>pathName </I><B>entry parent </B><I>tagOrId</I></A>
107 <DD><A HREF="treeview.htm#M88" NAME="L4396"><I>pathName </I><B>entry prev </B><I>tagOrId</I></A>
108 <DD><A HREF="treeview.htm#M89" NAME="L4397"><I>pathName </I><B>entry relabel </B><I>tagOrId newLabel</I></A>
109 <DD><A HREF="treeview.htm#M90" NAME="L4398"><I>pathName </I><B>entry select </B><I>tagOrId</I></A>
110 <DD><A HREF="treeview.htm#M91" NAME="L4399"><I>pathName </I><B>entry set </B> <I>tagOrId col</I> ?<I>value col value ...</I>?</A>
111 <DD><A HREF="treeview.htm#M92" NAME="L4400"><I>pathName </I><B>entry sibling ?-before</B>? <I>tagOrId</I></A>
112 <DD><A HREF="treeview.htm#M93" NAME="L4401"><I>pathName </I><B>entry size</B> <B>-recurse</B> <I>tagOrId</I></A>
113 <DD><A HREF="treeview.htm#M94" NAME="L4402"><I>pathName </I><B>entry unset </B> <I>tagOrId col</I></A>
114 <DD><A HREF="treeview.htm#M95" NAME="L4403"><I>pathName </I><B>entry up </B><I>tagOrId</I></A>
115 <DD><A HREF="treeview.htm#M96" NAME="L4404"><I>pathName </I><B>entry value </B> <I>tagOrId</I> ?<I>col</I>?</A>
117 <DD><A HREF="treeview.htm#M97" NAME="L4405"><I>pathName </I><B>find </B>?<I>flags</I>? <I>first</I> <I>last</I></A>
118 <DL class="treeview operations">
119 <DD><A HREF="treeview.htm#M98" NAME="L4406"><B>-addtag NAME</B></A>
120 <DD><A HREF="treeview.htm#M99" NAME="L4407"><B>-command</B> <I>command</I></A>
121 <DD><A HREF="treeview.htm#M100" NAME="L4408"><B>-column</B><I> col</I></A>
122 <DD><A HREF="treeview.htm#M101" NAME="L4409"><B>-count</B></A>
123 <DD><A HREF="treeview.htm#M102" NAME="L4410"><B>-depth</B> <I>number</I></A>
124 <DD><A HREF="treeview.htm#M103" NAME="L4411"><B>-exact</B></A>
125 <DD><A HREF="treeview.htm#M104" NAME="L4412"><B>-exec</B><I> string</I></A>
126 <DL class="treeview operations">
127 <DD><A HREF="treeview.htm#M105" NAME="L4413"><B>%#</B></A>
128 <DD><A HREF="treeview.htm#M106" NAME="L4414"><B>%W</B></A>
129 <DD><A HREF="treeview.htm#M107" NAME="L4415"><B>%p</B></A>
130 <DD><A HREF="treeview.htm#M108" NAME="L4416"><B>%P</B></A>
131 <DD><A HREF="treeview.htm#M109" NAME="L4417"><B>%V</B></A>
132 <DD><A HREF="treeview.htm#M110" NAME="L4418"><B>%F</B></A>
133 <DD><A HREF="treeview.htm#M111" NAME="L4419"><B>%C</B></A>
134 <DD><A HREF="treeview.htm#M112" NAME="L4420"><B>%%</B></A>
136 <DD><A HREF="treeview.htm#M113" NAME="L4421"><B>-glob</B></A>
137 <DD><A HREF="treeview.htm#M114" NAME="L4422"><B>-invert</B></A>
138 <DD><A HREF="treeview.htm#M115" NAME="L4423"><B>-isclosed</B></A>
139 <DD><A HREF="treeview.htm#M116" NAME="L4424"><B>-ishidden</B></A>
140 <DD><A HREF="treeview.htm#M117" NAME="L4425"><B>-isleaf</B></A>
141 <DD><A HREF="treeview.htm#M118" NAME="L4426"><B>-ismapped</B></A>
142 <DD><A HREF="treeview.htm#M119" NAME="L4427"><B>-isopen</B></A>
143 <DD><A HREF="treeview.htm#M120" NAME="L4428"><B>-istree</B></A>
144 <DD><A HREF="treeview.htm#M121" NAME="L4429"><B>-limit</B><I> number</I></A>
145 <DD><A HREF="treeview.htm#M122" NAME="L4430"><B>-maxdepth</B></A>
146 <DD><A HREF="treeview.htm#M123" NAME="L4431"><B>-mindepth</B></A>
147 <DD><A HREF="treeview.htm#M124" NAME="L4432"><B>-name</B><I> pattern</I></A>
148 <DD><A HREF="treeview.htm#M125" NAME="L4433"><B>-nocase</B></A>
149 <DD><A HREF="treeview.htm#M126" NAME="L4434"><B>-notop</B></A>
150 <DD><A HREF="treeview.htm#M127" NAME="L4435"><B>-regexp</B></A>
151 <DD><A HREF="treeview.htm#M128" NAME="L4436"><B>-reldepth</B></A>
152 <DD><A HREF="treeview.htm#M129" NAME="L4437"><B>-return</B><I> col</I></A>
153 <DD><A HREF="treeview.htm#M130" NAME="L4438"><B>-top </B><I>node</I></A>
154 <DD><A HREF="treeview.htm#M131" NAME="L4439"><B>-useformat</B></A>
155 <DD><A HREF="treeview.htm#M132" NAME="L4440"><B>-uselabel</B></A>
156 <DD><A HREF="treeview.htm#M133" NAME="L4441"><B>-usepath</B></A>
157 <DD><A HREF="treeview.htm#M134" NAME="L4442"><B>-userow</B></A>
158 <DD><A HREF="treeview.htm#M135" NAME="L4443"><B>-visible</B></A>
159 <DD><A HREF="treeview.htm#M136" NAME="L4444"><B>-withouttag NAME</B></A>
160 <DD><A HREF="treeview.htm#M137" NAME="L4445"><B>-withtag NAME</B></A>
161 <DD><A HREF="treeview.htm#M138" NAME="L4446"><B>-var </B><I>variable</I></A>
162 <DD><A HREF="treeview.htm#M139" NAME="L4447"><B>-option</B> <I>name value</I></A>
163 <DD><A HREF="treeview.htm#M140" NAME="L4448"><B>--</B></A>
165 <DD><A HREF="treeview.htm#M141" NAME="L4449"><I>pathName </I><B>focus </B>?<I>tagOrId</I>?</A>
166 <DD><A HREF="treeview.htm#M142" NAME="L4450"><I>pathName </I><B>get</B> ?<B>-full</B>? ?<B>-labels</B>? <I>tagnode</I> <I>tagnode</I>...</A>
167 <DD><A HREF="treeview.htm#M143" NAME="L4451"><I>pathName </I><B>hide </B>?<B>flags</B>? <I>tagOrId</I>...</A>
168 <DL class="treeview operations">
169 <DD><A HREF="treeview.htm#M144" NAME="L4452"><B>-column</B><I> col</I></A>
170 <DD><A HREF="treeview.htm#M145" NAME="L4453"><B>-depth</B> <I>number</I></A>
171 <DD><A HREF="treeview.htm#M146" NAME="L4454"><B>-exact</B></A>
172 <DD><A HREF="treeview.htm#M147" NAME="L4455"><B>-glob</B></A>
173 <DD><A HREF="treeview.htm#M148" NAME="L4456"><B>-invert</B></A>
174 <DD><A HREF="treeview.htm#M149" NAME="L4457"><B>-maxdepth</B></A>
175 <DD><A HREF="treeview.htm#M150" NAME="L4458"><B>-mindepth</B></A>
176 <DD><A HREF="treeview.htm#M151" NAME="L4459"><B>-name</B><I> pattern</I></A>
177 <DD><A HREF="treeview.htm#M152" NAME="L4460"><B>-nocase</B></A>
178 <DD><A HREF="treeview.htm#M153" NAME="L4461"><B>-option name value</B></A>
179 <DD><A HREF="treeview.htm#M154" NAME="L4462"><B>-regexp</B></A>
180 <DD><A HREF="treeview.htm#M155" NAME="L4463"><B>-uselabel</B></A>
181 <DD><A HREF="treeview.htm#M156" NAME="L4464"><B>-usepath</B></A>
182 <DD><A HREF="treeview.htm#M157" NAME="L4465"><B>-withouttag NAME</B></A>
183 <DD><A HREF="treeview.htm#M158" NAME="L4466"><B>-withtag NAME</B></A>
184 <DD><A HREF="treeview.htm#M159" NAME="L4467"><B>--</B></A>
186 <DD><A HREF="treeview.htm#M160" NAME="L4468"><I>pathName </I><B>index </B>?<B>-at</B> <I>tagOrId</I>? ?<B>-path</B>? ?<B>-quiet</B>? <I>string</I></A>
187 <DD><A HREF="treeview.htm#M161" NAME="L4469"><I>pathName </I><B>insert</B> ?<B>-node </B><I>num</I>? ?<B>-at </B><I>tagOrId</I>? ?<B>-styles </B><I>styleslist</I>? ?<B>-tags </B><I>tagslist</I>? <I>position</I> ?<I>path</I>? ?<I>options...</I>? ?<I>path</I>? ?<I>options...</I>?</A>
188 <DD><A HREF="treeview.htm#M162" NAME="L4470"><I>pathName </I><B>move </B><I>tagnode</I> <I>how</I> <I>destId</I></A>
189 <DL class="treeview operations">
190 <DD><A HREF="treeview.htm#M163" NAME="L4471"><B>before</B></A>
191 <DD><A HREF="treeview.htm#M164" NAME="L4472"><B>after</B></A>
192 <DD><A HREF="treeview.htm#M165" NAME="L4473"><B>into</B></A>
194 <DD><A HREF="treeview.htm#M166" NAME="L4474"><I>pathName </I><B>nearest</B> ?<B>-root</B>? ?<B>-strict</B>? <I>x y</I> ?<I>varName</I>?</A>
195 <DD><A HREF="treeview.htm#M167" NAME="L4475"><I>pathName </I><B>open </B>?<B>-recurse</B>? ?<B>-trees</B>? <I>tagnode...</I></A>
196 <DD><A HREF="treeview.htm#M168" NAME="L4476"><I>pathName </I><B>range</B> ?<B>-open</B>? <I>first last</I></A>
197 <DD><A HREF="treeview.htm#M169" NAME="L4477"><I>pathName </I><B>scan</B> <I>option args</I></A>
198 <DL class="treeview operations">
199 <DD><A HREF="treeview.htm#M170" NAME="L4478"><I>pathName </I><B>scan mark </B><I>x y</I></A>
200 <DD><A HREF="treeview.htm#M171" NAME="L4479"><I>pathName </I><B>scan dragto </B><I>x y</I>.</A>
202 <DD><A HREF="treeview.htm#M172" NAME="L4480"><I>pathName </I><B>see</B> ?<B>-anchor </B><I>anchor</I>? <I>tagOrId</I></A>
203 <DD><A HREF="treeview.htm#M173" NAME="L4481"><I>pathName </I><B>selection </B><I>option arg</I></A>
204 <DL class="treeview operations">
205 <DD><A HREF="treeview.htm#M174" NAME="L4482"><I>pathName </I><B>selection anchor ?</B><I>tagOrId</I>? ?<I>column</I>?</A>
206 <DD><A HREF="treeview.htm#M175" NAME="L4483"><I>pathName </I><B>selection cells</B></A>
207 <DD><A HREF="treeview.htm#M176" NAME="L4484"><I>pathName </I><B>selection clear </B><I>first </I>?<I>last</I>? ?<I>column</I>?</A>
208 <DD><A HREF="treeview.htm#M177" NAME="L4485"><I>pathName </I><B>selection clearall</B></A>
209 <DD><A HREF="treeview.htm#M178" NAME="L4486"><I>pathName </I><B>selection mark </B><I>tagOrId</I> ?<I>column</I>?</A>
210 <DD><A HREF="treeview.htm#M179" NAME="L4487"><I>pathName </I><B>selection includes </B><I>tagOrId</I> ?<I>column</I>?</A>
211 <DD><A HREF="treeview.htm#M180" NAME="L4488"><I>pathName </I><B>selection present</B></A>
212 <DD><A HREF="treeview.htm#M181" NAME="L4489"><I>pathName </I><B>selection set </B><I>first </I>?<I>last</I>? ?<I>column</I>?</A>
213 <DD><A HREF="treeview.htm#M182" NAME="L4490"><I>pathName </I><B>selection toggle </B><I>first </I>?<I>last</I>? ?<I>column</I>?</A>
215 <DD><A HREF="treeview.htm#M183" NAME="L4491"><I>pathName </I><B>show </B>?<B>flags</B>? <I>tagOrId</I>...</A>
216 <DD><A HREF="treeview.htm#M184" NAME="L4492"><I>pathName </I><B>sort</B> ?<I>operation</I>? <I>args...</I></A>
217 <DL class="treeview operations">
218 <DD><A HREF="treeview.htm#M185" NAME="L4493"><I>pathName </I><B>sort auto</B> ?<I>boolean</I></A>
219 <DD><A HREF="treeview.htm#M186" NAME="L4494"><I>pathName </I><B>sort cget</B> <I>option</I></A>
220 <DD><A HREF="treeview.htm#M187" NAME="L4495"><I>pathName </I><B>sort configure</B> ?<I>option</I>? ?<I>value option value ...</I>?</A>
221 <DL class="treeview operations">
222 <DD><A HREF="treeview.htm#M188" NAME="L4496"><B>-column</B><I> string</I></A>
223 <DD><A HREF="treeview.htm#M189" NAME="L4497"><B>-command</B><I> string</I></A>
224 <DD><A HREF="treeview.htm#M190" NAME="L4498"><B>-decreasing</B><I> boolean</I></A>
225 <DD><A HREF="treeview.htm#M191" NAME="L4499"><B>-mode</B><I> string</I></A>
226 <DD><A HREF="treeview.htm#M192" NAME="L4500"><B>-setflat</B><I> bool</I></A>
227 <DL class="treeview operations">
228 <DD><A HREF="treeview.htm#M193" NAME="L4501"><B>ascii</B></A>
229 <DD><A HREF="treeview.htm#M194" NAME="L4502"><B>dictionary</B></A>
230 <DD><A HREF="treeview.htm#M195" NAME="L4503"><B>integer</B></A>
231 <DD><A HREF="treeview.htm#M196" NAME="L4504"><B>real</B></A>
232 <DD><A HREF="treeview.htm#M197" NAME="L4505"><B>command</B></A>
235 <DD><A HREF="treeview.htm#M198" NAME="L4506"><I>pathName </I><B>sort once</B> ?<I>flags</I>? <I>tagOrId...</I></A>
236 <DL class="treeview operations">
237 <DD><A HREF="treeview.htm#M199" NAME="L4507"><B>-recurse</B></A>
240 <DD><A HREF="treeview.htm#M200" NAME="L4508"><I>pathName </I><B>style </B><I>operation</I> ?<I>args</I>?</A>
241 <DL class="treeview operations">
242 <DD><A HREF="treeview.htm#M201" NAME="L4509"><I>pathName </I><B>style activate</B> <I>entry column</I></A>
243 <DD><A HREF="treeview.htm#M202" NAME="L4510"><I>pathName </I><B>style cget</B> <I>stylename option</I></A>
244 <DD><A HREF="treeview.htm#M203" NAME="L4511"><I>pathName </I><B>style configure</B> ?<I>stylename option</I>? ?<I>value option value ...</I>?</A>
245 <DD><A HREF="treeview.htm#M204" NAME="L4512"><I>pathName </I><B>style create</B> <I>...</I>?</A>
246 <DL class="treeview operations">
247 <DD><A HREF="treeview.htm#M205" NAME="L4513"><I>pathName </I><B>style create barbox</B> <I>stylename</I> ?<I>option value option value ...</I>?</A>
248 <DD><A HREF="treeview.htm#M206" NAME="L4514"><I>pathName </I><B>style create checkbox</B> <I>stylename</I> ?<I>option value option value ...</I>?</A>
249 <DD><A HREF="treeview.htm#M207" NAME="L4515"><I>pathName </I><B>style create combobox</B> <I>stylename</I> ?<I>option value option value ...</I>?</A>
250 <DD><A HREF="treeview.htm#M208" NAME="L4516"><I>pathName </I><B>style create textbox</B> <I>stylename</I> ?<I>option value option value ...</I>?</A>
251 <DD><A HREF="treeview.htm#M209" NAME="L4517"><I>pathName </I><B>style create windowbox</B> ?<I>stylename</I>? ?<I>option value option value ...</I>?</A>
253 <DD><A HREF="treeview.htm#M210" NAME="L4518"><I>pathName </I><B>style find</B> <I>stylename ?column? ?node? ...</I></A>
254 <DD><A HREF="treeview.htm#M211" NAME="L4519"><I>pathName </I><B>style forget</B> <I>stylename ...</I></A>
255 <DD><A HREF="treeview.htm#M212" NAME="L4520"><I>pathName </I><B>style get</B> <I>column tagorid</I></A>
256 <DD><A HREF="treeview.htm#M213" NAME="L4521"><I>pathName </I><B>style highlight</B> <I>stylename ?on|off?</I></A>
257 <DD><A HREF="treeview.htm#M214" NAME="L4522"><I>pathName </I><B>style names</B></A>
258 <DD><A HREF="treeview.htm#M215" NAME="L4523"><I>pathName </I><B>style set</B> <I>stylename column node ...</I></A>
259 <DD><A HREF="treeview.htm#M216" NAME="L4524"><I>pathName </I><B>style slaves</B> ?<B>-col </B><I>col</I>? ?<B>-id </B><I>node</I>? ?<B>-style </B><I>styleName</I>? ?<B>-visible </B><I>bool</I>? ?<B>-info </B><I>path</I>?</A>
261 <DD><A HREF="treeview.htm#M217" NAME="L4525"><I>pathName </I><B>tag </B><I>operation args</I></A>
262 <DL class="treeview operations">
263 <DD><A HREF="treeview.htm#M218" NAME="L4526"><I>pathName</I> <B>tag add</B> <I>string</I> ?<I>id</I>...?</A>
264 <DD><A HREF="treeview.htm#M219" NAME="L4527"><I>pathName</I> <B>tag delete</B> <I>string</I> <I>tagnode</I>...</A>
265 <DD><A HREF="treeview.htm#M220" NAME="L4528"><I>treeName</I> <B>tag exists</B> <I>string</I> ?<I>id</I>?</A>
266 <DD><A HREF="treeview.htm#M221" NAME="L4529"><I>pathName</I> <B>tag forget</B> <I>string</I></A>
267 <DD><A HREF="treeview.htm#M222" NAME="L4530"><I>pathName</I> <B>tag names</B> ?<I>id</I>?</A>
268 <DD><A HREF="treeview.htm#M223" NAME="L4531"><I>pathName</I> <B>tag nodes</B> <I>name</I> ?<I>name</I> ...?</A>
270 <DD><A HREF="treeview.htm#M224" NAME="L4532"><I>pathName </I><B>toggle </B><I>tagnode</I></A>
271 <DD><A HREF="treeview.htm#M225" NAME="L4533"><I>pathName </I><B>xview </B><I>args</I></A>
272 <DL class="treeview operations">
273 <DD><A HREF="treeview.htm#M226" NAME="L4534"><I>pathName </I><B>xview</B></A>
274 <DD><A HREF="treeview.htm#M227" NAME="L4535"><I>pathName </I><B>xview</B> <I>tagOrId</I></A>
275 <DD><A HREF="treeview.htm#M228" NAME="L4536"><I>pathName </I><B>xview moveto</B><I> fraction</I></A>
276 <DD><A HREF="treeview.htm#M229" NAME="L4537"><I>pathName </I><B>xview scroll </B><I>number what</I></A>
278 <DD><A HREF="treeview.htm#M230" NAME="L4538"><I>pathName </I><B>yview </B><I>?args</I>?</A>
279 <DL class="treeview operations">
280 <DD><A HREF="treeview.htm#M231" NAME="L4539"><I>pathName </I><B>yview</B></A>
281 <DD><A HREF="treeview.htm#M232" NAME="L4540"><I>pathName </I><B>yview</B> <I>tagOrId</I></A>
282 <DD><A HREF="treeview.htm#M233" NAME="L4541"><I>pathName </I><B>yview moveto</B><I> fraction</I></A>
283 <DD><A HREF="treeview.htm#M234" NAME="L4542"><I>pathName </I><B>yview scroll </B><I>number what</I></A>
286 <DD><A HREF="treeview.htm#M235" NAME="L4543">TREEVIEW EDITING</A>
287 <DD><A HREF="treeview.htm#M236" NAME="L4544">TREEVIEW OPTIONS</A>
288 <DL class="treeview options">
289 <DD><A HREF="treeview.htm#M237" NAME="L4545"><B>-activeicons </B><I>images</I></A>
290 <DD><A HREF="treeview.htm#M238" NAME="L4546"><B>-activeleaficons </B><I>images</I></A>
291 <DD><A HREF="treeview.htm#M239" NAME="L4547"><B>-allowduplicates </B><I>boolean</I></A>
292 <DD><A HREF="treeview.htm#M240" NAME="L4548"><B>-altstyle </B><I>stylename</I></A>
293 <DD><A HREF="treeview.htm#M241" NAME="L4549"><B>-autocreate </B><I>boolean</I></A>
294 <DD><A HREF="treeview.htm#M242" NAME="L4550"><B>-background </B><I>color</I></A>
295 <DD><A HREF="treeview.htm#M243" NAME="L4551"><B>-borderwidth </B><I>pixels</I></A>
296 <DD><A HREF="treeview.htm#M244" NAME="L4552"><B>-button </B><I>string</I></A>
297 <DD><A HREF="treeview.htm#M245" NAME="L4553"><B>-closecommand </B><I>string</I></A>
298 <DL class="treeview options">
299 <DD><A HREF="treeview.htm#M246" NAME="L4554"><B>%W</B></A>
300 <DD><A HREF="treeview.htm#M247" NAME="L4555"><B>%p</B></A>
301 <DD><A HREF="treeview.htm#M248" NAME="L4556"><B>%P</B></A>
302 <DD><A HREF="treeview.htm#M249" NAME="L4557"><B>%#</B></A>
303 <DD><A HREF="treeview.htm#M250" NAME="L4558"><B>%%</B></A>
305 <DD><A HREF="treeview.htm#M251" NAME="L4559"><B>-columnshowhighlight </B><I>bool</I></A>
306 <DD><A HREF="treeview.htm#M252" NAME="L4560"><B>-cursor </B><I>cursor</I></A>
307 <DD><A HREF="treeview.htm#M253" NAME="L4561"><B>-dashes </B><I>number</I></A>
308 <DD><A HREF="treeview.htm#M254" NAME="L4562"><B>-emptystyle </B><I>stylename</I></A>
309 <DD><A HREF="treeview.htm#M255" NAME="L4563"><B>-entryshowhighlight </B><I>bool</I></A>
310 <DD><A HREF="treeview.htm#M256" NAME="L4564"><B>-exportselection </B><I>boolean</I></A>
311 <DD><A HREF="treeview.htm#M257" NAME="L4565"><B>-fillnull </B><I>boolean</I></A>
312 <DD><A HREF="treeview.htm#M258" NAME="L4566"><B>-flat </B><I>boolean</I></A>
313 <DD><A HREF="treeview.htm#M259" NAME="L4567"><B>-focusdashes </B><I>dashList</I></A>
314 <DD><A HREF="treeview.htm#M260" NAME="L4568"><B>-focusforeground </B><I>color</I></A>
315 <DD><A HREF="treeview.htm#M261" NAME="L4569"><B>-focusheight </B><I>value</I></A>
316 <DD><A HREF="treeview.htm#M262" NAME="L4570"><B>-font </B><I>fontName</I></A>
317 <DD><A HREF="treeview.htm#M263" NAME="L4571"><B>-foreground </B><I>color</I></A>
318 <DD><A HREF="treeview.htm#M264" NAME="L4572"><B>-height </B><I>pixels</I></A>
319 <DD><A HREF="treeview.htm#M265" NAME="L4573"><B>-hidedataicons </B><I>boolean</I></A>
320 <DD><A HREF="treeview.htm#M266" NAME="L4574"><B>-hidedatatext </B><I>boolean</I></A>
321 <DD><A HREF="treeview.htm#M267" NAME="L4575"><B>-hideicons </B><I>boolean</I></A>
322 <DD><A HREF="treeview.htm#M268" NAME="L4576"><B>-hideleaves </B><I>boolean</I></A>
323 <DD><A HREF="treeview.htm#M269" NAME="L4577"><B>-hideroot </B><I>boolean</I></A>
324 <DD><A HREF="treeview.htm#M270" NAME="L4578"><B>-highlightbackground </B><I>color</I></A>
325 <DD><A HREF="treeview.htm#M271" NAME="L4579"><B>-highlightcolor </B><I>color</I></A>
326 <DD><A HREF="treeview.htm#M272" NAME="L4580"><B>-highlightthickness </B><I>pixels</I></A>
327 <DD><A HREF="treeview.htm#M273" NAME="L4581"><B>-icons </B><I>images</I></A>
328 <DD><A HREF="treeview.htm#M274" NAME="L4582"><B>-imagecmd </B><I>scriptcmd</I></A>
329 <DD><A HREF="treeview.htm#M275" NAME="L4583"><B>-inlinedata </B><I>bool</I></A>
330 <DD><A HREF="treeview.htm#M276" NAME="L4584"><B>-insertfirst</B><I>num</I></A>
331 <DD><A HREF="treeview.htm#M277" NAME="L4585"><B>-leaficons </B><I>images</I></A>
332 <DD><A HREF="treeview.htm#M278" NAME="L4586"><B>-levelpad </B><I>pixels</I></A>
333 <DD><A HREF="treeview.htm#M279" NAME="L4587"><B>-levelstyles </B><I>stylenames</I></A>
334 <DD><A HREF="treeview.htm#M280" NAME="L4588"><B>-linecolor </B><I>color</I></A>
335 <DD><A HREF="treeview.htm#M281" NAME="L4589"><B>-linespacing </B><I>pixels</I></A>
336 <DD><A HREF="treeview.htm#M282" NAME="L4590"><B>-linewidth </B><I>pixels</I></A>
337 <DD><A HREF="treeview.htm#M283" NAME="L4591"><B>-minheight </B><I>pixels</I></A>
338 <DD><A HREF="treeview.htm#M284" NAME="L4592"><B>-nextauto</B><I>num</I></A>
339 <DD><A HREF="treeview.htm#M285" NAME="L4593"><B>-nextsubauto</B><I>num</I></A>
340 <DD><A HREF="treeview.htm#M286" NAME="L4594"><B>-newtags </B><I>boolean</I></A>
341 <DD><A HREF="treeview.htm#M287" NAME="L4595"><B>-noautocloseleaf </B><I>boolean</I></A>
342 <DD><A HREF="treeview.htm#M288" NAME="L4596"><B>-nofocusselectbackground </B><I>color</I></A>
343 <DD><A HREF="treeview.htm#M289" NAME="L4597"><B>-nofocusselectforeground </B><I>color</I></A>
344 <DD><A HREF="treeview.htm#M290" NAME="L4598"><B>-openanchor </B><I>string</I></A>
345 <DD><A HREF="treeview.htm#M291" NAME="L4599"><B>-opencommand </B><I>string</I></A>
346 <DL class="treeview options">
347 <DD><A HREF="treeview.htm#M292" NAME="L4600"><B>%W</B></A>
348 <DD><A HREF="treeview.htm#M293" NAME="L4601"><B>%p</B></A>
349 <DD><A HREF="treeview.htm#M294" NAME="L4602"><B>%P</B></A>
350 <DD><A HREF="treeview.htm#M295" NAME="L4603"><B>%#</B></A>
351 <DD><A HREF="treeview.htm#M296" NAME="L4604"><B>%%</B></A>
353 <DD><A HREF="treeview.htm#M297" NAME="L4605"><B>-relief </B><I>relief</I></A>
354 <DD><A HREF="treeview.htm#M298" NAME="L4606"><B>-resizecursor </B><I>string</I></A>
355 <DD><A HREF="treeview.htm#M299" NAME="L4607"><B>-rootnode </B><I>num</I></A>
356 <DD><A HREF="treeview.htm#M300" NAME="L4608"><B>-scrollmode </B><I>mode</I></A>
357 <DL class="treeview options">
358 <DD><A HREF="treeview.htm#M301" NAME="L4609"><B>listbox</B></A>
359 <DD><A HREF="treeview.htm#M302" NAME="L4610"><B>hierbox</B></A>
360 <DD><A HREF="treeview.htm#M303" NAME="L4611"><B>canvas</B></A>
362 <DD><A HREF="treeview.htm#M304" NAME="L4612"><B>-scrolltile </B><I>bool</I></A>
363 <DD><A HREF="treeview.htm#M305" NAME="L4613"><B>-selectbackground </B><I>color</I></A>
364 <DD><A HREF="treeview.htm#M306" NAME="L4614"><B>-selectborderwidth </B><I>pixels</I></A>
365 <DD><A HREF="treeview.htm#M307" NAME="L4615"><B>-selectcommand </B><I>string</I></A>
366 <DD><A HREF="treeview.htm#M308" NAME="L4616"><B>-selectforeground</B> <I>color</I>\fB</A>
367 <DD><A HREF="treeview.htm#M309" NAME="L4617"><B>-selectmode </B><I>mode</I></A>
368 <DD><A HREF="treeview.htm#M310" NAME="L4618"><B>-selectrelief </B><I>relief</I></A>
369 <DD><A HREF="treeview.htm#M311" NAME="L4619"><B>-selecttile </B><I>image</I></A>
370 <DD><A HREF="treeview.htm#M312" NAME="L4620"><B>-separator </B><I>string</I></A>
371 <DD><A HREF="treeview.htm#M313" NAME="L4621"><B>-showfull </B><I>boolean</I></A>
372 <DD><A HREF="treeview.htm#M314" NAME="L4622"><B>-showtitles </B><I>boolean</I></A>
373 <DD><A HREF="treeview.htm#M315" NAME="L4623"><B>-sortselection </B><I>boolean</I></A>
374 <DD><A HREF="treeview.htm#M316" NAME="L4624"><B>-stylecommand </B><I>string</I></A>
375 <DD><A HREF="treeview.htm#M317" NAME="L4625"><B>-substyle </B><I>stylename</I></A>
376 <DD><A HREF="treeview.htm#M318" NAME="L4626"><B>-takefocus</B> <I>focus</I></A>
377 <DD><A HREF="treeview.htm#M319" NAME="L4627"><B>-tile </B><I>image</I></A>
378 <DD><A HREF="treeview.htm#M320" NAME="L4628"><B>-titlefont </B><I>font</I></A>
379 <DD><A HREF="treeview.htm#M321" NAME="L4629"><B>-titlepad </B><I>N</I></A>
380 <DD><A HREF="treeview.htm#M322" NAME="L4630"><B>-tree </B><I>tree</I></A>
381 <DD><A HREF="treeview.htm#M323" NAME="L4631"><B>-trim </B><I>string</I></A>
382 <DD><A HREF="treeview.htm#M324" NAME="L4632"><B>-underline </B><I>height</I></A>
383 <DD><A HREF="treeview.htm#M325" NAME="L4633"><B>-width </B><I>pixels</I></A>
384 <DD><A HREF="treeview.htm#M326" NAME="L4634"><B>-xscrollcommand </B><I>string</I></A>
385 <DD><A HREF="treeview.htm#M327" NAME="L4635"><B>-xscrollincrement</B> <I>pixels</I></A>
386 <DD><A HREF="treeview.htm#M328" NAME="L4636"><B>-yscrollcommand </B><I>string</I></A>
387 <DD><A HREF="treeview.htm#M329" NAME="L4637"><B>-yscrollincrement</B> <I>pixels</I></A>
389 <DD><A HREF="treeview.htm#M330" NAME="L4638">ENTRY OPTIONS</A>
390 <DL class="entry options">
391 <DD><A HREF="treeview.htm#M331" NAME="L4639"><B>-activeicons </B><I>images</I></A>
392 <DD><A HREF="treeview.htm#M332" NAME="L4640"><B>-bindtags </B><I>tagList</I></A>
393 <DD><A HREF="treeview.htm#M333" NAME="L4641"><B>-button </B><I>string</I></A>
394 <DD><A HREF="treeview.htm#M334" NAME="L4642"><B>-closecommand </B><I>string</I></A>
395 <DL class="entry options">
396 <DD><A HREF="treeview.htm#M335" NAME="L4643"><B>%W</B></A>
397 <DD><A HREF="treeview.htm#M336" NAME="L4644"><B>%p</B></A>
398 <DD><A HREF="treeview.htm#M337" NAME="L4645"><B>%P</B></A>
399 <DD><A HREF="treeview.htm#M338" NAME="L4646"><B>%#</B></A>
400 <DD><A HREF="treeview.htm#M339" NAME="L4647"><B>%%</B></A>
402 <DD><A HREF="treeview.htm#M340" NAME="L4648"><B>-data </B><I>list</I></A>
403 <DD><A HREF="treeview.htm#M341" NAME="L4649"><B>-font </B><I>fontName</I></A>
404 <DD><A HREF="treeview.htm#M342" NAME="L4650"><B>-forcetree </B><I>bool</I></A>
405 <DD><A HREF="treeview.htm#M343" NAME="L4651"><B>-foreground </B><I>color</I></A>
406 <DD><A HREF="treeview.htm#M344" NAME="L4652"><B>-height </B><I>num</I></A>
407 <DD><A HREF="treeview.htm#M345" NAME="L4653"><B>-hide </B><I>bool</I></A>
408 <DD><A HREF="treeview.htm#M346" NAME="L4654"><B>-icons </B><I>images</I></A>
409 <DD><A HREF="treeview.htm#M347" NAME="L4655"><B>-label </B><I>string</I></A>
410 <DD><A HREF="treeview.htm#M348" NAME="L4656"><B>-opencommand </B><I>string</I></A>
411 <DL class="entry options">
412 <DD><A HREF="treeview.htm#M349" NAME="L4657"><B>%W</B></A>
413 <DD><A HREF="treeview.htm#M350" NAME="L4658"><B>%p</B></A>
414 <DD><A HREF="treeview.htm#M351" NAME="L4659"><B>%P</B></A>
415 <DD><A HREF="treeview.htm#M352" NAME="L4660"><B>%#</B></A>
416 <DD><A HREF="treeview.htm#M353" NAME="L4661"><B>%%</B></A>
418 <DD><A HREF="treeview.htm#M354" NAME="L4662"><B>-shadow </B><I>color</I></A>
419 <DD><A HREF="treeview.htm#M355" NAME="L4663"><B>-state </B><I>value</I></A>
420 <DD><A HREF="treeview.htm#M356" NAME="L4664"><B>-style </B><I>stylename</I></A>
421 <DD><A HREF="treeview.htm#M357" NAME="L4665"><B>-sublabel </B><I>string</I></A>
422 <DD><A HREF="treeview.htm#M358" NAME="L4666"><B>-underline </B><I>num</I></A>
423 <DD><A HREF="treeview.htm#M359" NAME="L4667"><B>-userdata </B><I>list</I></A>
425 <DD><A HREF="treeview.htm#M360" NAME="L4668">BUTTON OPTIONS</A>
426 <DL class="button options">
427 <DD><A HREF="treeview.htm#M361" NAME="L4669"><B>-activebackground </B><I>color</I></A>
428 <DD><A HREF="treeview.htm#M362" NAME="L4670"><B>-activeforeground </B><I>color</I></A>
429 <DD><A HREF="treeview.htm#M363" NAME="L4671"><B>-background </B><I>color</I></A>
430 <DD><A HREF="treeview.htm#M364" NAME="L4672"><B>-borderwidth </B><I>pixels</I></A>
431 <DD><A HREF="treeview.htm#M365" NAME="L4673"><B>-closerelief </B><I>relief</I></A>
432 <DD><A HREF="treeview.htm#M366" NAME="L4674"><B>-cursor </B><I>cursor</I></A>
433 <DD><A HREF="treeview.htm#M367" NAME="L4675"><B>-foreground </B><I>color</I></A>
434 <DD><A HREF="treeview.htm#M368" NAME="L4676"><B>-images </B><I>images</I></A>
435 <DD><A HREF="treeview.htm#M369" NAME="L4677"><B>-openrelief </B><I>relief</I></A>
436 <DD><A HREF="treeview.htm#M370" NAME="L4678"><B>-size </B><I>pixels</I></A>
438 <DD><A HREF="treeview.htm#M371" NAME="L4679">STYLE OPTIONS</A>
439 <DL class="style options">
440 <DD><A HREF="treeview.htm#M372" NAME="L4680"><B>-activebackground </B><I>color</I></A>
441 <DD><A HREF="treeview.htm#M373" NAME="L4681"><B>-activeforeground </B><I>color</I></A>
442 <DD><A HREF="treeview.htm#M374" NAME="L4682"><B>-background </B><I>color</I></A>
443 <DD><A HREF="treeview.htm#M375" NAME="L4683"><B>-cursor </B><I>cursorname</I></A>
444 <DD><A HREF="treeview.htm#M376" NAME="L4684"><B>-font </B><I>fontName</I></A>
445 <DD><A HREF="treeview.htm#M377" NAME="L4685"><B>-foreground </B><I>color</I></A>
446 <DD><A HREF="treeview.htm#M378" NAME="L4686"><B>-gap </B><I>N</I></A>
447 <DD><A HREF="treeview.htm#M379" NAME="L4687"><B>-hide </B><I>bool</I></A>
448 <DD><A HREF="treeview.htm#M380" NAME="L4688"><B>-highlightbackground </B><I>color</I></A>
449 <DD><A HREF="treeview.htm#M381" NAME="L4689"><B>-highlightforeground </B><I>color</I></A>
450 <DD><A HREF="treeview.htm#M382" NAME="L4690"><B>-icon </B><I>name</I></A>
451 <DD><A HREF="treeview.htm#M383" NAME="L4691"><B>-priority</B> <I>N</I></A>
452 <DD><A HREF="treeview.htm#M384" NAME="L4692"><B>-shadow </B><I>shadow</I></A>
453 <DD><A HREF="treeview.htm#M385" NAME="L4693"><B>-tile </B><I>img</I></A>
454 <DD><A HREF="treeview.htm#M386" NAME="L4694">The following additional configuration options are available for textbox:</A>
455 <DD><A HREF="treeview.htm#M387" NAME="L4695"><B>-formatcmd </B><I>scriptcmd</I></A>
456 <DD><A HREF="treeview.htm#M388" NAME="L4696"><B>-iconside </B><I>N</I></A>
457 <DD><A HREF="treeview.htm#M389" NAME="L4697"><B>-side </B><I>N</I></A>
458 <DD><A HREF="treeview.htm#M390" NAME="L4698">The following additional configuration options are available for combobox:</A>
459 <DD><A HREF="treeview.htm#M391" NAME="L4699"><B>-borderwidth </B><I>pixel</I></A>
460 <DD><A HREF="treeview.htm#M392" NAME="L4700"><B>-buttonborderwidth </B><I>pixel</I></A>
461 <DD><A HREF="treeview.htm#M393" NAME="L4701"><B>-buttonrelief </B><I>relief</I></A>
462 <DD><A HREF="treeview.htm#M394" NAME="L4702"><B>-choicecmd </B><I>cmd</I></A>
463 <DD><A HREF="treeview.htm#M395" NAME="L4703"><B>-choices </B><I>lst</I></A>
464 <DD><A HREF="treeview.htm#M396" NAME="L4704">The following additional configuration options are available for checkbox:</A>
465 <DD><A HREF="treeview.htm#M397" NAME="L4705"><B>-boxcolor </B><I>color</I></A>
466 <DD><A HREF="treeview.htm#M398" NAME="L4706"><B>-boxsize </B><I>num</I></A>
467 <DD><A HREF="treeview.htm#M399" NAME="L4707"><B>-checkcolor </B><I>color</I></A>
468 <DD><A HREF="treeview.htm#M400" NAME="L4708"><B>-fillcolor </B><I>color</I></A>
469 <DD><A HREF="treeview.htm#M401" NAME="L4709"><B>-linewidth </B><I>num</I></A>
470 <DD><A HREF="treeview.htm#M402" NAME="L4710"><B>-offvalue </B><I>val</I></A>
471 <DD><A HREF="treeview.htm#M403" NAME="L4711"><B>-onvalue </B><I>val</I></A>
472 <DD><A HREF="treeview.htm#M404" NAME="L4712"><B>-showvalue </B><I>bool</I></A>
473 <DD><A HREF="treeview.htm#M405" NAME="L4713">The following additional configuration options are available for barbox:</A>
474 <DD><A HREF="treeview.htm#M406" NAME="L4714"><B>-barbg </B><I>color</I></A>
475 <DD><A HREF="treeview.htm#M407" NAME="L4715"><B>-boxcolor </B><I>color</I></A>
476 <DD><A HREF="treeview.htm#M408" NAME="L4716"><B>-barfg </B><I>color</I></A>
477 <DD><A HREF="treeview.htm#M409" NAME="L4717"><B>-barheight </B><I>num</I></A>
478 <DD><A HREF="treeview.htm#M410" NAME="L4718"><B>-barwidth </B><I>num</I></A>
479 <DD><A HREF="treeview.htm#M411" NAME="L4719"><B>-filltile </B><I>tile</I></A>
480 <DD><A HREF="treeview.htm#M412" NAME="L4720"><B>-formatcmd </B><I>scriptcmd</I></A>
481 <DD><A HREF="treeview.htm#M413" NAME="L4721"><B>-linewidth </B><I>num</I></A>
482 <DD><A HREF="treeview.htm#M414" NAME="L4722"><B>-maxvalue </B><I>val</I></A>
483 <DD><A HREF="treeview.htm#M415" NAME="L4723"><B>-minvalue </B><I>val</I></A>
484 <DD><A HREF="treeview.htm#M416" NAME="L4724"><B>-showvalue </B><I>bool</I></A>
485 <DD><A HREF="treeview.htm#M417" NAME="L4725">Only the following configuration options are available with windowbox:</A>
486 <DD><A HREF="treeview.htm#M418" NAME="L4726"><B>-minheight </B><I>num</I></A>
487 <DD><A HREF="treeview.htm#M419" NAME="L4727"><B>-minwidth </B><I>num</I></A>
488 <DD><A HREF="treeview.htm#M420" NAME="L4728"><B>-windowcmd </B><I>string</I></A>
489 <DL class="style options">
490 <DD><A HREF="treeview.htm#M421" NAME="L4729"><B>%W</B></A>
491 <DD><A HREF="treeview.htm#M422" NAME="L4730"><B>%p</B></A>
492 <DD><A HREF="treeview.htm#M423" NAME="L4731"><B>%P</B></A>
493 <DD><A HREF="treeview.htm#M424" NAME="L4732"><B>%#</B></A>
494 <DD><A HREF="treeview.htm#M425" NAME="L4733"><B>%C</B></A>
495 <DD><A HREF="treeview.htm#M426" NAME="L4734"><B>%%</B></A>
498 <DD><A HREF="treeview.htm#M427" NAME="L4735">COLUMN OPTIONS</A>
499 <DL class="column options">
500 <DD><A HREF="treeview.htm#M428" NAME="L4736"><B>-activetitlebackground </B><I>color</I></A>
501 <DD><A HREF="treeview.htm#M429" NAME="L4737"><B>-activetitleforeground </B><I>color</I></A>
502 <DD><A HREF="treeview.htm#M430" NAME="L4738"><B>-autowidth </B><I>value</I></A>
503 <DD><A HREF="treeview.htm#M431" NAME="L4739"><B>-background </B><I>color</I></A>
504 <DD><A HREF="treeview.htm#M432" NAME="L4740"><B>-bindtags </B><I>string</I></A>
505 <DD><A HREF="treeview.htm#M433" NAME="L4741"><B>-borderwidth </B><I>pixels</I></A>
506 <DD><A HREF="treeview.htm#M434" NAME="L4742"><B>-colorpattern </B><I>patcolors</I></A>
507 <DD><A HREF="treeview.htm#M435" NAME="L4743"><B>-colorregexp </B><I>patcolors</I></A>
508 <DD><A HREF="treeview.htm#M436" NAME="L4744"><B>-command </B><I>string</I></A>
509 <DL class="column options">
510 <DD><A HREF="treeview.htm#M437" NAME="L4745"><B>%W</B></A>
511 <DD><A HREF="treeview.htm#M438" NAME="L4746"><B>%C</B></A>
512 <DD><A HREF="treeview.htm#M439" NAME="L4747"><B>%%</B></A>
514 <DD><A HREF="treeview.htm#M440" NAME="L4748"><B>-edit </B><I>num</I></A>
515 <DD><A HREF="treeview.htm#M441" NAME="L4749"><B>-editopts </B><I>values</I></A>
516 <DL class="column options">
517 <DD><A HREF="treeview.htm#M442" NAME="L4750"><I>-auto bool</I></A>
518 <DD><A HREF="treeview.htm#M443" NAME="L4751"><I>-editcmd cmd</I></A>
519 <DD><A HREF="treeview.htm#M444" NAME="L4752"><I>-embed bool</I></A>
520 <DD><A HREF="treeview.htm#M445" NAME="L4753"><I>-endcmd cmd</I></A>
521 <DD><A HREF="treeview.htm#M446" NAME="L4754"><I>-leafs bool</I></A>
522 <DD><A HREF="treeview.htm#M447" NAME="L4755"><I>-nottnull bool</I></A>
523 <DD><A HREF="treeview.htm#M448" NAME="L4756"><I>-opts values</I></A>
524 <DD><A HREF="treeview.htm#M449" NAME="L4757"><I>-readonly bool</I></A>
525 <DD><A HREF="treeview.htm#M450" NAME="L4758"><I>-sel bool</I></A>
526 <DD><A HREF="treeview.htm#M451" NAME="L4759"><I>-startcmd cmd</I></A>
527 <DD><A HREF="treeview.htm#M452" NAME="L4760"><I>-titles bool</I></A>
528 <DD><A HREF="treeview.htm#M453" NAME="L4761"><I>-widget wid</I></A>
529 <DD><A HREF="treeview.htm#M454" NAME="L4762"><I>-withtag tag</I></A>
530 <DD><A HREF="treeview.htm#M455" NAME="L4763"><I>-withouttag tag</I></A>
531 <DD><A HREF="treeview.htm#M456" NAME="L4764"><I>-wrap value</I></A>
533 <DD><A HREF="treeview.htm#M457" NAME="L4765"><B>-fillcmd </B><I>scriptcmd</I></A>
534 <DD><A HREF="treeview.htm#M458" NAME="L4766"><B>-hide </B><I>boolean</I></A>
535 <DD><A HREF="treeview.htm#M459" NAME="L4767"><B>-justify </B><I>justify</I></A>
536 <DD><A HREF="treeview.htm#M460" NAME="L4768"><B>-max </B><I>size</I></A>
537 <DD><A HREF="treeview.htm#M461" NAME="L4769"><B>-min </B><I>size</I></A>
538 <DD><A HREF="treeview.htm#M462" NAME="L4770"><B>-pad </B><I>pad</I></A>
539 <DD><A HREF="treeview.htm#M463" NAME="L4771"><B>-relief </B><I>relief</I></A>
540 <DD><A HREF="treeview.htm#M464" NAME="L4772"><B>-ruledashes </B><I>value</I></A>
541 <DD><A HREF="treeview.htm#M465" NAME="L4773"><B>-scrolltile </B><I>bool</I></A>
542 <DD><A HREF="treeview.htm#M466" NAME="L4774"><B>-sortcommand </B><I>script</I></A>
543 <DD><A HREF="treeview.htm#M467" NAME="L4775"><B>-sortmode </B><I>mode</I></A>
544 <DD><A HREF="treeview.htm#M468" NAME="L4776"><B>-state </B><I>state</I></A>
545 <DD><A HREF="treeview.htm#M469" NAME="L4777"><B>-style </B><I>stylename</I></A>
546 <DD><A HREF="treeview.htm#M470" NAME="L4778"><B>-tile </B><I>image</I></A>
547 <DD><A HREF="treeview.htm#M471" NAME="L4779"><B>-title </B><I>string</I></A>
548 <DD><A HREF="treeview.htm#M472" NAME="L4780"><B>-titlearrow </B><I>value</I></A>
549 <DD><A HREF="treeview.htm#M473" NAME="L4781"><B>-titlebackground </B><I>color</I></A>
550 <DD><A HREF="treeview.htm#M474" NAME="L4782"><B>-titleborderwidth </B><I>size</I></A>
551 <DD><A HREF="treeview.htm#M475" NAME="L4783"><B>-titlefont </B><I>font</I></A>
552 <DD><A HREF="treeview.htm#M476" NAME="L4784"><B>-titlejustify </B><I>just</I></A>
553 <DD><A HREF="treeview.htm#M477" NAME="L4785"><B>-titleforeground </B><I>color</I></A>
554 <DD><A HREF="treeview.htm#M478" NAME="L4786"><B>-titlerelief </B><I>relief</I></A>
555 <DD><A HREF="treeview.htm#M479" NAME="L4787"><B>-titleshadow </B><I>color</I></A>
556 <DD><A HREF="treeview.htm#M480" NAME="L4788"><B>-titlestyle </B><I>style</I></A>
557 <DD><A HREF="treeview.htm#M481" NAME="L4789"><B>-width </B><I>num</I></A>
558 <DD><A HREF="treeview.htm#M482" NAME="L4790"><B>-underline </B><I>num</I></A>
559 <DD><A HREF="treeview.htm#M483" NAME="L4791"><B>-validatecmd </B><I>command</I></A>
561 <DL class="column options">
562 <DD><A HREF="treeview.htm#M484" NAME="L4792"><B>-weight </B><I>float</I></A>
563 <DD><A HREF="treeview.htm#M485" NAME="L4793"><B>-width </B><I>pixels</I></A>
565 <DD><A HREF="treeview.htm#M486" NAME="L4794">EMBEDDED WINDOWS</A>
566 <DD><A HREF="treeview.htm#M487" NAME="L4795">OLD TEXT EDITING OPTIONS</A>
567 <DL class="old text editing options">
568 <DD><A HREF="treeview.htm#M488" NAME="L4796"><B>-background </B><I>color</I></A>
569 <DD><A HREF="treeview.htm#M489" NAME="L4797"><B>-borderwidth </B><I>pixels</I></A>
570 <DD><A HREF="treeview.htm#M490" NAME="L4798"><B>-exportselection </B><I>boolean</I></A>
571 <DD><A HREF="treeview.htm#M491" NAME="L4799"><B>-relief </B><I>relief</I></A>
572 <DD><A HREF="treeview.htm#M492" NAME="L4800"><B>-selectbackground </B><I>color</I></A>
573 <DD><A HREF="treeview.htm#M493" NAME="L4801"><B>-selectborderwidth </B><I>pixels</I></A>
574 <DD><A HREF="treeview.htm#M494" NAME="L4802"><B>-selectforeground </B><I>color</I></A>
575 <DD><A HREF="treeview.htm#M495" NAME="L4803"><B>-selectrelief </B><I>relief</I></A>
577 <DD><A HREF="treeview.htm#M496" NAME="L4804">DEFAULT BINDINGS</A>
578 <DL class="default bindings">
580 <DD><A HREF="treeview.htm#M497" NAME="L4805">WIDGET BINDINGS</A>
581 <DL class="widget bindings">
582 <DD><A HREF="treeview.htm#M498" NAME="L4806"><B><ButtonPress-2></B></A>
583 <DD><A HREF="treeview.htm#M499" NAME="L4807"><B><B2-Motion></B></A>
584 <DD><A HREF="treeview.htm#M500" NAME="L4808"><B><ButtonRelease-2></B></A>
585 <DD><A HREF="treeview.htm#M501" NAME="L4809"><B><B1-Leave></B></A>
586 <DD><A HREF="treeview.htm#M502" NAME="L4810"><B><B1-Enter></B></A>
587 <DD><A HREF="treeview.htm#M503" NAME="L4811"><B><KeyPress-Up></B></A>
588 <DD><A HREF="treeview.htm#M504" NAME="L4812"><B><KeyPress-Down></B></A>
589 <DD><A HREF="treeview.htm#M505" NAME="L4813"><B><Shift-KeyPress-Up></B></A>
590 <DD><A HREF="treeview.htm#M506" NAME="L4814"><B><Shift-KeyPress-Down></B></A>
591 <DD><A HREF="treeview.htm#M507" NAME="L4815"><B><KeyPress-Prior></B></A>
592 <DD><A HREF="treeview.htm#M508" NAME="L4816"><B><KeyPress-Next></B></A>
593 <DD><A HREF="treeview.htm#M509" NAME="L4817"><B><KeyPress-Left></B></A>
594 <DD><A HREF="treeview.htm#M510" NAME="L4818"><B><KeyPress-Right></B></A>
595 <DD><A HREF="treeview.htm#M511" NAME="L4819"><B><KeyPress-space></B></A>
596 <DD><A HREF="treeview.htm#M512" NAME="L4820"><B><KeyRelease-space></B></A>
597 <DD><A HREF="treeview.htm#M513" NAME="L4821"><B><KeyPress-Return></B></A>
598 <DD><A HREF="treeview.htm#M514" NAME="L4822"><B><KeyRelease-Return></B></A>
599 <DD><A HREF="treeview.htm#M515" NAME="L4823"><B><KeyPress></B></A>
600 <DD><A HREF="treeview.htm#M516" NAME="L4824"><B><KeyPress-Home></B></A>
601 <DD><A HREF="treeview.htm#M517" NAME="L4825"><B><KeyPress-End></B></A>
602 <DD><A HREF="treeview.htm#M518" NAME="L4826"><B><Control-a></B></A>
603 <DD><A HREF="treeview.htm#M519" NAME="L4827"><B><Control-o></B></A>
604 <DD><A HREF="treeview.htm#M520" NAME="L4828"><B><Control-Shift-O></B></A>
605 <DD><A HREF="treeview.htm#M521" NAME="L4829"><B><Double-ButtonRelease-1></B></A>
606 <DD><A HREF="treeview.htm#M522" NAME="L4830"><B><Alt-Double-ButtonRelease-1></B></A>
607 <DD><A HREF="treeview.htm#M523" NAME="L4831"><B><Control-KeyPress-minus></B></A>
608 <DD><A HREF="treeview.htm#M524" NAME="L4832"><B><KeyPress-F1></B></A>
609 <DD><A HREF="treeview.htm#M525" NAME="L4833"><B><KeyPress-F2></B></A>
610 <DD><A HREF="treeview.htm#M526" NAME="L4834"><B><KeyPress-F3></B></A>
611 <DD><A HREF="treeview.htm#M527" NAME="L4835"><B><KeyPress-F4></B></A>
612 <DD><A HREF="treeview.htm#M528" NAME="L4836"><B><Control-Shift-O></B></A>
613 <DD><A HREF="treeview.htm#M529" NAME="L4837"><B><Control-Shift-C></B></A>
615 <DD><A HREF="treeview.htm#M530" NAME="L4838">BUTTON BINDINGS</A>
616 <DL class="button bindings">
617 <DD><A HREF="treeview.htm#M531" NAME="L4839"><B><Enter></B></A>
618 <DD><A HREF="treeview.htm#M532" NAME="L4840"><B><Leave></B></A>
619 <DD><A HREF="treeview.htm#M533" NAME="L4841"><B><ButtonRelease-1></B></A>
621 <DD><A HREF="treeview.htm#M534" NAME="L4842">ENTRY BINDINGS</A>
622 <DL class="entry bindings">
623 <DD><A HREF="treeview.htm#M535" NAME="L4843"><B><Enter></B></A>
624 <DD><A HREF="treeview.htm#M536" NAME="L4844"><B><Leave></B></A>
625 <DD><A HREF="treeview.htm#M537" NAME="L4845"><B><ButtonPress-1></B></A>
626 <DD><A HREF="treeview.htm#M538" NAME="L4846"><B><Double-ButtonPress-1></B></A>
627 <DD><A HREF="treeview.htm#M539" NAME="L4847"><B><B1-Motion></B></A>
628 <DD><A HREF="treeview.htm#M540" NAME="L4848"><B><ButtonRelease-1></B></A>
629 <DD><A HREF="treeview.htm#M541" NAME="L4849"><B><Shift-ButtonPress-1></B></A>
630 <DD><A HREF="treeview.htm#M542" NAME="L4850"><B><Shift-Double-ButtonPress-1></B></A>
631 <DD><A HREF="treeview.htm#M543" NAME="L4851"><B><Shift-B1-Motion></B></A>
632 <DD><A HREF="treeview.htm#M544" NAME="L4852"><B><Shift-ButtonRelease-1></B></A>
633 <DD><A HREF="treeview.htm#M545" NAME="L4853"><B><Control-ButtonPress-1></B></A>
634 <DD><A HREF="treeview.htm#M546" NAME="L4854"><B><Control-Double-ButtonPress-1></B></A>
635 <DD><A HREF="treeview.htm#M547" NAME="L4855"><B><Control-B1-Motion></B></A>
636 <DD><A HREF="treeview.htm#M548" NAME="L4856"><B><Control-ButtonRelease-1></B></A>
637 <DD><A HREF="treeview.htm#M549" NAME="L4857"><B><Control-Shift-ButtonPress-1></B></A>
638 <DD><A HREF="treeview.htm#M550" NAME="L4858"><B><Control-Shift-Double-ButtonPress-1></B></A>
639 <DD><A HREF="treeview.htm#M551" NAME="L4859"><B><Control-Shift-B1-Motion></B></A>
641 <DD><A HREF="treeview.htm#M552" NAME="L4860">COLUMN BINDINGS</A>
642 <DL class="column bindings">
643 <DD><A HREF="treeview.htm#M553" NAME="L4861"><B><Enter></B></A>
644 <DD><A HREF="treeview.htm#M554" NAME="L4862"><B><Leave></B></A>
645 <DD><A HREF="treeview.htm#M555" NAME="L4863"><B><ButtonRelease-1></B></A>
647 <DD><A HREF="treeview.htm#M556" NAME="L4864">COLUMN RULE BINDINGS</A>
648 <DL class="column rule bindings">
649 <DD><A HREF="treeview.htm#M557" NAME="L4865"><B><Enter></B></A>
650 <DD><A HREF="treeview.htm#M558" NAME="L4866"><B><Leave></B></A>
651 <DD><A HREF="treeview.htm#M559" NAME="L4867"><B><ButtonPress-1></B></A>
652 <DD><A HREF="treeview.htm#M560" NAME="L4868"><B><B1-Motion></B></A>
653 <DD><A HREF="treeview.htm#M561" NAME="L4869"><B><ButtonRelease-1></B></A>
655 <DD><A HREF="treeview.htm#M562" NAME="L4870">QUICKSTART</A>
656 <DD><A HREF="treeview.htm#M563" NAME="L4871">EXAMPLE</A>
657 <DD><A HREF="treeview.htm#M564" NAME="L4872">OLD TREEVIEW EDITS</A>
658 <DL class="old treeview edits">
659 <DD><A HREF="treeview.htm#M565" NAME="L4873">When editing the subwidget .edit is available.</A>
660 <DD><A HREF="treeview.htm#M566" NAME="L4874"><I>pathName.</I><B>edit </B><I>operation</I> ?<I>args</I>?</A>
661 <DL class="old treeview edits">
662 <DD><A HREF="treeview.htm#M567" NAME="L4875"><I>pathName.</I><B>edit apply</B></A>
663 <DD><A HREF="treeview.htm#M568" NAME="L4876"><I>pathName.</I><B>edit cancel</B></A>
664 <DD><A HREF="treeview.htm#M569" NAME="L4877"><I>pathName.</I><B>edit cget</B><I> value</I></A>
665 <DD><A HREF="treeview.htm#M570" NAME="L4878"><I>pathName.</I><B>edit configure</B> ?<I>option value</I>?</A>
667 <DD><A HREF="treeview.htm#M571" NAME="L4879"><I>pathName.</I><B>edit delete</B><I> first last</I></A>
668 <DD><A HREF="treeview.htm#M572" NAME="L4880"><I>pathName.</I><B>edit get</B> ?<I>-root</I>? <I>x y</I></A>
669 <DD><A HREF="treeview.htm#M573" NAME="L4881"><I>pathName.</I><B>edit icursor</B><I> index</I></A>
670 <DD><A HREF="treeview.htm#M574" NAME="L4882"><I>pathName.</I><B>edit index</B><I> index</I></A>
671 <DD><A HREF="treeview.htm#M575" NAME="L4883"><I>pathName.</I><B>edit insert</B><I> index string</I></A>
672 <DD><A HREF="treeview.htm#M576" NAME="L4884"><I>pathName.</I><B>edit selection</B><I> args</I></A>
673 <DL class="old treeview edits">
674 <DD><A HREF="treeview.htm#M577" NAME="L4885"><I>pathName.</I><B>edit selection adjust</B><I> index</I></A>
675 <DD><A HREF="treeview.htm#M578" NAME="L4886"><I>pathName.</I><B>edit selection clear</B></A>
676 <DD><A HREF="treeview.htm#M579" NAME="L4887"><I>pathName.</I><B>edit selection from</B><I> index</I></A>
677 <DD><A HREF="treeview.htm#M580" NAME="L4888"><I>pathName.</I><B>edit selection present</B></A>
678 <DD><A HREF="treeview.htm#M581" NAME="L4889"><I>pathName.</I><B>edit selection range</B><I> start end</I></A>
679 <DD><A HREF="treeview.htm#M582" NAME="L4890"><I>pathName.</I><B>edit selection to</B><I> index</I></A>
682 <DD><A HREF="treeview.htm#M583" NAME="L4891">NOTES</A>
683 <DD><A HREF="treeview.htm#M584" NAME="L4892">KEYWORDS</A>
685 <H3><A NAME="M2">NAME</A></H3>
686 treeview - Create and manipulate hierarchical table widgets
687 <H3><A NAME="M3">SYNOPSIS</A></H3>
688 <B>treeview</B> <I>pathName </I>?<I>options</I>?<BR>
689 <H3><A NAME="M4">DESCRIPTION</A></H3>
690 The <B>treeview</B> widget displays a <B><A HREF="../TclCmd/tree.htm">tree</A></B> of data and provides
691 data sharing (via <I>tree data objects</I>) and the ability to tag
693 <H3><A NAME="M5">INTRODUCTION</A></H3>
694 The <B>treeview</B> widget is used to display hierarchical data. Data is
695 represented as nodes in a general-ordered tree. Each node may have
696 sub-nodes and these nodes can in turn has their own children.
698 A node is displayed as a row entry in the widget. Each entry has a
699 text label and icon. When a node has children, its entry is drawn
700 with a small button to the left of the label. Clicking the mouse over
701 this button opens or closes the node. When a node is <I>open</I>, its
702 children are exposed. When it is <I>closed</I>, the children and their
703 descedants are hidden. The button is normally a <B>+</B> or
704 <B>-</B> symbol (ala Windows Explorer), but can be replaced with a
705 pair of Tk images (open and closed images).
707 If the node has data associated with it, they can be displayed in
708 columns running vertically on either side the tree.
709 Data may be set using an entries <B>-data</B> option,the <B>entry set</B>
710 subcommand, or via the <B><A HREF="../TclCmd/tree.htm">tree</A></B> data object.
712 the color, font, etc of each entry. Any entry label or data field can
714 <H3><A NAME="M6">TREE DATA OBJECT</A></H3>
715 The tree is not stored inside the widget but in a tree data object
716 (see the <B><A HREF="../TclCmd/tree.htm">tree</A></B> command for a further explanation). Tree data
717 objects can be shared among different clients, such as a
718 <B>treeview</B> widget or the <B><A HREF="../TclCmd/tree.htm">tree</A></B> command. You can walk the
719 tree and manage its data with the <B><A HREF="../TclCmd/tree.htm">tree</A></B> command tree, while
720 displaying it with the <B>treeview</B> widget. Whenever the tree is
721 updated, the <B>treeview</B> widget is automatically redrawn.
723 By default, the <B>treeview</B> widget creates its own internal tree object
724 and this initially contains just a root node. But if you wish
725 to share a tree, you can
726 created one with the <B><A HREF="../TclCmd/tree.htm">tree</A></B> command and set it via the <B>-tree</B>
727 configuration option. <B>Treeview</B> widgets can share this tree
728 object, and even display a sub-node as the root of the tree.
730 A tree object has both a Tcl and C API. You can insert or delete
731 nodes using <B>treeview</B> widget or <B><A HREF="../TclCmd/tree.htm">tree</A></B> command operations,
732 but also from C code. For example, you can load the tree from your C
733 code while still managing and displaying the tree from Tcl. The widget
734 is automatically notified whenever the tree is modified via C or Tcl.
735 <H3><A NAME="M7">SYNTAX</A></H3>
736 <dl><dd><table border="0"><tr><td><p style="font-size:12px;padding-left:.5em;padding-right:.5em;"><B>treeview </B><I>pathName </I>?<I>option value</I>?...</table></dl>
737 The <B>treeview</B> command creates a new window <I>pathName</I> and
738 makes it into a <B>treeview</B> widget. At the time this command is
739 invoked, there must not exist a window named <I>pathName</I>, but
740 <I>pathName</I>'s parent must exist. Additional options may be
741 specified on the command line or in the option database to configure
742 aspects of the widget such as its colors and font. See the
743 <B>configure</B> operation below for the exact details about what
744 <I>option</I> and <I>value</I> pairs are valid.
746 If successful, <B>treeview</B> returns the path name of the widget. It
747 also creates a new Tcl command by the same name. You can use this
748 command to invoke various operations that query or modify the widget.
750 <dl><dd><table border="0"><tr><td><p style="font-size:12px;padding-left:.5em;padding-right:.5em;"><I>pathName operation</I> ?<I>arg</I>?...</table></dl>
751 Both <I>operation</I> and its arguments determine the exact behavior of
752 the command. The operations available are described in the
754 <H3><A NAME="M8">IDS AND TAGS</A></H3>
755 Nodes can be inserted into a tree using the <B>treeview</B> widget
756 <PRE>blt::treeview .t
757 set node [.t insert end root "one"]</PRE>
758 or <B><A HREF="../TclCmd/tree.htm">tree</A></B> command.
759 <PRE>set tree [blt::tree create]
760 set node [$tree insert root "one"]</PRE>
761 In both cases, a number identifying the node is returned (the value of
762 <B>$node</B>). This serial number or <I>id</I> uniquely identifies
763 the node. Please note that you can't infer a location or position of
764 a node from its id. The only exception is that the root node is
765 always id <B>0</B>. Since nodes may have the same labels or be moved
766 within the tree, ids provide an convenient way to identify nodes. If
767 a tree is shared, the ids will be the same regardless if you are using
768 by the <B>treeview</B> widget or the <B><A HREF="../TclCmd/tree.htm">tree</A></B> command. Ids are
769 recycled when the node deleted.
771 A node may also have any number of <I>tags</I> associated with it. A
772 tag is just a string of characters, and it may take any form except
773 that of an integer. For example, "<B>x123</B>" is valid, but
774 "<B>123</B>" isn't. The same tag may be associated with many
775 different nodes. This is typically done to associate a group of
776 nodes. Many operations in the <B>treeview</B> widget take either node
777 ids or tag names as arguments. Using a tag says to apply the operation
778 to all nodes with that tag.
780 The tag <B>all</B> is implicitly associated with every node in
781 the tree. It may be used to invoke operations on all the nodes in the
784 Commands that take a <I>tagnode</I>
785 will also accept a list of zero or more integer node numbers.
786 A node-list must contain only integers,
787 and the list can not have any leading spaces.
788 Node lists can simplify the use of iterating commands.
789 Tags and taglist are more widely used in tree than in treeview.
791 Tags may be shared, just like trees, between clients. For example,
792 you can use the tags created by the <B><A HREF="../TclCmd/tree.htm">tree</A></B> command with
793 <B>treeview</B> widgets.
794 <H3><A NAME="M9">SPECIAL NODE IDS</A></H3>
795 There are also several special non-numeric ids. Special ids differ
796 from tags in that they are always translated to their numeric
797 equivalent. They also take precedence over tags. For example, you
798 can't use a tag name that is a special id. These ids are specific to
799 the <B>treeview</B> widget.
801 <DL class="special node ids">
802 <DT><A NAME="M10"><B>active</B></A><DD>
803 The node where the mouse pointer is currently located.
804 When a node is active, it is drawn using its active icon
805 (see the <B>-activeicon</B> option).
806 The <B>active</B> id is changed automatically by moving the mouse
807 pointer over another node or by using the <B>entry activate</B>
808 operation. Note that there can be only one active node at a time.
809 <P><DT><A NAME="M11"><B>anchor</B></A><DD>
810 The node representing the fixed end of the current selection.
811 The anchor is set by the <B><A HREF="../TkCmd/selection.htm">selection anchor</A></B> operation.
812 <P><DT><A NAME="M12"><B>bottom</B></A><DD>
813 The last viewable node.
814 <P><DT><A NAME="M13"><B>current</B></A><DD>
815 The node where the mouse pointer is currently located.
816 But unlike <B>active</B>, this id changes while the
817 selection is dragged. It is used to determine the
818 current node during button drags.
819 <P><DT><A NAME="M14"><B>down</B></A><DD>
820 The next open node from the current focus. The <B>down</B> of
821 the last open node is the same.
822 <P><DT><A NAME="M15"><B>end</B></A><DD>
823 The last node at depth 1 in tree.
824 <P><DT><A NAME="M16"><B>focus</B></A><DD>
825 The node that currently has focus. When a node has focus,
826 it receives key events. To indicate focus, the node
827 is drawn with a dotted line around its label. You can change the
828 focus using the <B><A HREF="../TkCmd/focus.htm">focus</A></B> operation.
829 <P><DT><A NAME="M17"><B>last</B></A><DD>
831 <P><DT><A NAME="M18"><B>mark</B></A><DD>
832 The node representing the non-fixed end of the current selection.
833 The mark is set by the <B><A HREF="../TkCmd/selection.htm">selection mark</A></B> operation.
834 <P><DT><A NAME="M19"><B>next</B></A><DD>
835 The next open node from the current focus. But unlike <B>down</B>,
836 when the focus is on last open node, <B><A HREF="../TclCmd/next.htm">next</A></B> wraps around to the
838 <P><DT><A NAME="M20"><B>nextsibling</B></A><DD>
839 The next sibling from the node with the current focus. If the node
840 is already the last sibling then it is the <B>nextsibling</B>.
841 <P><DT><A NAME="M21"><B>parent</B></A><DD>
842 The parent of the node with the current focus. The <B>parent</B>
843 of the root is also the root.
844 <P><DT><A NAME="M22"><B>prev</B></A><DD>
845 The last open node from the current focus. But unlike <B>up</B>,
846 when the focus is at root, <B>last</B> wraps around to the last
847 open node in the tree.
848 <P><DT><A NAME="M23"><B>prevsibling</B></A><DD>
849 The previous sibling from the node with the current focus. If the node
850 is already the first sibling then it is the <B>prevsibling</B>.
851 <P><DT><A NAME="M24"><B>root</B></A><DD>
852 The root node. You can also use id <B>0</B> to indicate
854 <P><DT><A NAME="M25"><B>tail</B></A><DD>
855 The last node in the tree, viewable or not.
856 <P><DT><A NAME="M26"><B>top</B></A><DD>
858 <P><DT><A NAME="M27"><B>up</B></A><DD>
859 The last open node (in depth-first order) from the current focus. The
860 <B>up</B> of the root node (i.e. the root has focus) is also the root.
861 <P><DT><A NAME="M28"><B>view.top</B></A><DD>
862 First node that's current visible in the widget.
863 <P><DT><A NAME="M29"><B>view.bottom</B></A><DD>
864 Last node that's current visible in the widget.
865 <P><DT><A NAME="M30"><B>@</B><I>x</I><B>,</B><I>y</I></A><DD>
866 Indicates the node that covers the point in the treeview window
867 specified by <I>x</I> and <I>y</I> (in pixel coordinates). If no
868 part of the entryd covers that point, then the closest node to that
870 <P><DT><A NAME="M31"><B>@</B><I>ID</I><B>-></B><I>LABEL</I>-><I>LABEL</I>...</A><DD>
871 Lookup via node labels, eg. <I>0->Main->Users</I>.
872 Quotes can be used around labels that use reserved words or contain
873 spaces, eg. <I>0->"Main"->'User Groups'</I>.
874 See the <B><A HREF="../TclCmd/tree.htm">tree</A></B> man page for more details.
877 A node may be specified as an id or tag. If the specifier is an
878 integer then it is assumed to refer to the single node with that id.
879 If the specifier is not an integer, it's checked to see if it's a
880 special id (such as focus). Otherwise, it's assumed to be tag. Some
881 operations only operate on a single node at a time; if a tag refers to
882 more than one node, then an error is generated.
883 <H3><A NAME="M32">DATA FIELDS</A></H3>
884 A node in the tree can have <I>data field</I>. A data field is a
885 name-value pair, used to represent arbitrary data in the node. Nodes
886 can contain different fields (they aren't required to contain the same
887 fields). You can optionally display these fields in the
888 <B>treeview</B> widget in columns running on either side of the
889 displayed tree. A node's value for the field is drawn in the column
890 along side its node in the hierarchy. Any node that doesn't have a
891 specific field is left blank. Columns can be interactively resized,
893 <H3><A NAME="M33">ENTRY BINDINGS</A></H3>
894 You can bind Tcl commands to be invoked when events occur on nodes
895 (much like Tk canvas items). You can bind a node using its id or
896 its <I>bindtags</I>. Bindtags are simply names that associate a
897 binding with one or more nodes. There is a built-in tag <B>all</B>
898 that all node entries automatically have.
899 <H3><A NAME="M34">TREEVIEW OPERATIONS</A></H3>
900 The <B>treeview</B> operations are the invoked by specifying
901 the widget's pathname, the operation, and any arguments that pertain
902 to that operation. The general form is:
904 <PRE><I>pathName operation </I>?<I>arg arg ...</I>?</PRE>
906 <I>Operation</I> and the <I>arg</I>s determine the exact behavior of the
907 command. The following operation are available for <B>treeview</B> widgets:
909 <DL class="treeview operations">
910 <DT><A NAME="M35"><I>pathName </I><B>bbox</B> ?<B>-screen</B>? <I>tagOrId...</I></A><DD>
911 Returns a list of 4 numbers, representing a bounding box of around
912 the specified entries. The entries is given by one or more <I>tagOrId</I>
914 If the <B>-screen</B> flag is given, then the x-y coordinates
915 of the bounding box are returned as screen coordinates, not
916 virtual coordinates. Virtual coordinates start from <B>0</B> from the
917 root node and include the title.
918 If the <B>-world</B> flag is given, then the y coordinate
919 the title height is added in.
920 The returned list contains the following values.
922 <DL class="treeview operations">
923 <DT><A NAME="M36"><I>x</I></A><DD>
924 X-coordinate of the upper-left corner of the bounding box.
925 <P><DT><A NAME="M37"><I>y</I></A><DD>
926 Y-coordinate of the upper-left corner of the bounding box.
927 <P><DT><A NAME="M38"><I>width</I></A><DD>
928 Width of the bounding box.
929 <P><DT><A NAME="M39"><I>height</I></A><DD>
930 Height of the bounding box.
932 <P><DT><A NAME="M40"><I>pathName </I><B>bind</B> <I>tagName</I> ?<I>sequence command</I>?</A><DD>
933 Associates <I>command</I> with <I>tagName</I> such that whenever the
934 event sequence given by <I>sequence</I> occurs for a node with this
935 tag, <I>command</I> will be invoked. The syntax is similar to the
936 <B><A HREF="../TkCmd/bind.htm">bind</A></B> command except that it operates on <B>treeview</B> entries,
938 The <I>tagName</I> can be an entry or tag, or predefined tags such
939 as <B>all</B>, <B><A HREF="../TkCmd/entry.htm">Entry</A></B> or <B><A HREF="../TkCmd/button.htm">Button</A></B>.
940 See the <B><A HREF="../TkCmd/bind.htm">bind</A></B> manual entry for
941 complete details on <I>sequence</I> and the substitutions performed on
942 <I>command</I> before invoking it.
944 If all arguments are specified then a new binding is created, replacing
945 any existing binding for the same <I>sequence</I> and <I>tagName</I>.
946 If the first character of <I>command</I> is <B>+</B> then <I>command</I>
947 augments an existing binding rather than replacing it.
948 If no <I>command</I> argument is provided then the command currently
949 associated with <I>tagName</I> and <I>sequence</I> (it's an error occurs
950 if there's no such binding) is returned. If both <I>command</I> and
951 <I>sequence</I> are missing then a list of all the event sequences for
952 which bindings have been defined for <I>tagName</I>.
953 <P><DT><A NAME="M41"><I>pathName </I><B>button </B><I>operation</I> ?<I>args</I>?</A><DD>
954 This command is used to control the button selectors within a
955 <B>treeview</B> widget.
956 It has several forms, depending on <I>operation</I>:
958 <DL class="treeview operations">
959 <DT><A NAME="M42"><I>pathName </I><B>button activate</B> <I>tagOrId</I></A><DD>
960 Designates the node given by <I>tagOrId</I> as active.
961 When a node is active it's entry is drawn using its active icon
962 (see the <B>-activeicon</B> option).
963 Note that there can be only one active entry at a time.
964 The special id <B>active</B> indicates the currently active node.
965 <P><DT><A NAME="M43"><I>pathName </I><B>button bind</B> <I>tagName</I> ?<I>sequence command</I>?</A><DD>
966 Associates <I>command</I> with <I>tagName</I> such that whenever the
967 event sequence given by <I>sequence</I> occurs for an button of a
968 node entry with this tag, <I>command</I> will be invoked. The syntax is
969 similar to the <B><A HREF="../TkCmd/bind.htm">bind</A></B> command except that it operates on
970 <B>treeview</B> buttons, rather than widgets. See the <B><A HREF="../TkCmd/bind.htm">bind</A></B>
971 manual entry for complete details on <I>sequence</I> and the
972 substitutions performed on <I>command</I> before invoking it.
974 If all arguments are specified then a new binding is created, replacing
975 any existing binding for the same <I>sequence</I> and <I>tagName</I>.
976 If the first character of <I>command</I> is <B>+</B> then <I>command</I>
977 augments an existing binding rather than replacing it.
978 If no <I>command</I> argument is provided then the command currently
979 associated with <I>tagName</I> and <I>sequence</I> (it's an error occurs
980 if there's no such binding) is returned. If both <I>command</I> and
981 <I>sequence</I> are missing then a list of all the event sequences for
982 which bindings have been defined for <I>tagName</I>.
983 <P><DT><A NAME="M44"><I>pathName </I><B>button cget</B> <I>option</I></A><DD>
984 Returns the current value of the configuration option given
986 <I>Option</I> may have any of the values accepted by the <B>configure</B>
987 operation described below.
988 <P><DT><A NAME="M45"><I>pathName </I><B>button configure</B> ?<I>option</I>? ?<I>value option value ...</I>?</A><DD>
989 Query or modify the configuration options of the widget.
990 If no <I>option</I> is specified, returns a list describing all of
991 the available options for <I>pathName</I> (see <B><A HREF="../TkLib/ConfigWidg.htm">Tk_ConfigureInfo</A></B> for
992 information on the format of this list). If <I>option</I> is specified
993 with no <I>value</I>, then the command returns a list describing the
994 one named option (this list will be identical to the corresponding
995 sublist of the value returned if no <I>option</I> is specified). If
996 one or more <I>option-value</I> pairs are specified, then the command
997 modifies the given widget option(s) to have the given value(s); in
998 this case the command returns an empty string.
999 <I>Option</I> and <I>value</I> are described in the section
1002 <P><DT><A NAME="M46"><I>pathName </I><B>cget</B> <I>option</I></A><DD>
1003 Returns the current value of the configuration option given
1005 <I>Option</I> may have any of the values accepted by the <B>configure</B>
1006 operation described below.
1007 <P><DT><A NAME="M47"><I>pathName </I><B>close </B>?<B>-recurse</B>? ?<B>-trees</B>? <I>tagOrId...</I></A><DD>
1008 Closes the node specified by <I>tagOrId</I>. In addition, if a Tcl
1009 script was specified by the <B>-closecommand</B> option, it is
1010 invoked. If the node is already closed, this command has no effect.
1011 If the <B>-recurse</B> flag is present, each child node is
1013 The <B>-trees</B> flag is like <B>-recurse</B> but operates only on nodes
1014 with children, excluding the <I>root</I>.
1015 <P><DT><A NAME="M48"><I>pathName </I><B>column </B><I>operation</I> ?<I>args</I>?</A><DD>
1016 The following operations are available for treeview columns.
1018 <DL class="treeview operations">
1019 <DT><A NAME="M49"><I>pathName </I><B>column activate</B> <I>column</I></A><DD>
1020 Sets the active column to <I>column</I>. <I>Column</I> is the
1021 name of a column in the widget.
1022 When a column is active, it's drawn using its <B>-activetitlebackground</B>
1023 and <B>-activetitleforeground</B> options. If <I>column</I> is the <B>""</B>,
1024 then no column will be active. If no column argument is provided, then
1025 the name of the currently active column is returned.
1026 <P><DT><A NAME="M50"><I>pathName </I><B>column bbox</B> <I>column entry</I></A><DD>
1027 Returns a list of 4 numbers, representing a bounding box of around
1028 the specified entries cell. Giving an entry of <B>-1</B> matches the title row.
1029 <P><DT><A NAME="M51"><I>pathName </I><B>column bind</B> <I>column</I> ?<I>sequence command</I>?</A><DD>
1030 Associates <I>command</I> with <I>column</I> such that whenever the
1031 event sequence given by <I>sequence</I> occurs for a column
1032 node entry with this tag, <I>command</I> will be invoked. The syntax is
1033 similar to the <B><A HREF="../TkCmd/bind.htm">bind</A></B> command except that it operates on
1034 <B>treeview</B> colunns, rather than widgets. See the <B><A HREF="../TkCmd/bind.htm">bind</A></B>
1035 manual entry for complete details on <I>sequence</I> and the
1036 substitutions performed on <I>command</I> before invoking it.
1037 <P><DT><A NAME="M52"><I>pathName </I><B>column cget</B> <I>name</I> <I>option</I></A><DD>
1038 Returns the current value of the column configuration option given
1039 by <I>option</I> for <I>name</I>. <I>Name</I> is the name of column
1040 that corresponds to a data field.
1041 <I>Option</I> may have any of the values accepted by the <B>configure</B>
1042 operation described below.
1043 <P><DT><A NAME="M53"><I>pathName </I><B>column configure</B> <I>name</I> ?<I>name</I> ...? ?<I>option</I>? ?<I>value option value </I> ...?</A><DD>
1044 Query or modify the configuration options of one or more columns
1045 <I>name</I>. <I>Name</I> is the name of the column corresponding
1047 If no <I>option</I> is specified, returns a list describing all of
1048 the available options for <I>pathName</I> (see <B><A HREF="../TkLib/ConfigWidg.htm">Tk_ConfigureInfo</A></B> for
1049 information on the format of this list). If <I>option</I> is specified
1050 with no <I>value</I>, then the command returns a list describing the
1051 one named option (this list will be identical to the corresponding
1052 sublist of the value returned if no <I>option</I> is specified). If
1053 one or more <I>option-value</I> pairs are specified, then the command
1054 modifies the given widget option(s) to have the given value(s); in
1055 this case the command returns an empty string.
1056 <I>Option</I> and <I>value</I> are described in the section
1058 <P><DT><A NAME="M54"><I>pathName </I><B>column current</B></A><DD>
1059 Get column currently under the mouse.
1060 <P><DT><A NAME="M55"><I>pathName </I><B>column delete</B> <I>field</I> ?<I>field</I>...?</A><DD>
1061 Deletes one of more columns designated by <I>field</I>.
1062 Requests to delete the tree column are silently ignored.
1063 Note that this does not delete the data fields themselves.
1064 <P><DT><A NAME="M56"><I>pathName </I><B>column index</B> <I>index</I></A><DD>
1065 Return the integer for index. May use "end" or "end-N".
1066 <P><DT><A NAME="M57"><I>pathName </I><B>column insert</B> <I>position</I> <I>field</I> ?<I>field</I> ...? ?<I>options</I>...?</A><DD>
1067 Inserts one (or more) columns designated by <I>field</I>.
1069 each entry node's data field using this name. If the node doesn't
1070 define the given field, the cell is left blank.
1072 indicates where in the list of columns to add the new column. It may be
1073 either a name, a number or <B>end</B>.
1074 If multiple <I>fields</I> are given, they may not start with a dash.
1075 If <I>field</I> is the empty string or <B>#auto</B>,
1076 a name is generated prefixed by the string <B>Col</B> plus a unique integer.
1077 If <I>field</I> ends with <B>#auto</B>, the generated name uses it's prefix
1079 The returned values is the created column names.
1080 Note that the predefined tree column (ie. <I>BLT-TreeView</I>)
1081 is aliased by <I>Col0</I>.
1082 <P><DT><A NAME="M58"><I>pathName </I><B>column invoke</B> <I>field</I></A><DD>
1083 Invokes the Tcl command associated with the column <I>field</I>,
1084 if there is one (using the column's <B>-command</B> option).
1085 The command is ignored if the column's <B>-state</B> option
1086 set to <B>disabled</B>.
1087 <P><DT><A NAME="M59"><I>pathName </I><B>column isset ?</B><I>startOrTag</I>? ?<I>end</I>?</A><DD>
1088 Returns list of data columns for elements in range
1089 actually having data values set in them.
1090 One possible use for this might be hiding columns which are empty.
1091 With no arguments, checks only entries on the visible screen.
1092 With one argument, checks all entries matching a tag or id.
1093 With two arguments, checks all entries between start and end range.
1094 <P><DT><A NAME="M60"><I>pathName </I><B>column istree </B><I>field</I></A><DD>
1095 Return 1 if column is the tree column.
1096 <P><DT><A NAME="M61"><I>pathName </I><B>column move </B><I>name</I> <I>dest</I></A><DD>
1097 Moves the column <I>name</I> to the destination position.
1098 <I>Dest</I> is the offset, name of another column or a screen position
1099 in the form <B>@</B><I>x</I><B>,</B><I>y</I>.
1100 <P><DT><A NAME="M62"><I>pathName </I><B>column names ?</B><I>-visible</I>? ?<I>PATTERN</I>?</A><DD>
1101 Returns a list of the names of all columns in the widget.
1102 The list is ordered as the columns are drawn from left-to-right.
1103 If -visible, then display only columns where -hide is 0.
1104 A pattern may be specified to limit results.
1105 <P><DT><A NAME="M63"><I>pathName </I><B>column nearest</B> <I>x</I> ?<I>y</I>?</A><DD>
1106 Returns the name of the column closest to the given X-Y screen
1107 coordinate. If you provide a <I>y</I> argument (it's optional),
1108 a name is returned only when if the point is over a column's title.
1109 <P><DT><A NAME="M64"><I>pathName </I><B>column offsets</B></A><DD>
1110 Returns the starting offsets for each column.
1111 <P><DT><A NAME="M65"><I>pathName </I><B>column resize op ...</B></A><DD>
1112 Operations for resize where op is one of activate, anchor, mark or set.
1113 <P><DT><A NAME="M66"><I>pathName </I><B>column see</B> ?<B>-anchor</B> <I>anchor</I>? <I>field</I></A><DD>
1114 Adjusts the view so that the column given by <I>field</I> is
1115 visible in the widget window.
1116 The node's position on the screen can be set using the
1117 <B>-anchor</B> flag. Its value is a Tk anchor position: <B>w, c, e</B>.
1118 <P><DT><A NAME="M67"><I>pathName </I><B>column values</B> ?<B>-visible</B>? ?<B>-default value</B>? <I>field</I> ?<I>start</I>? ?<I>end</I>?</A><DD>
1119 Returns a list of data values for a column.
1120 The -visible flag excludes the values that are hidden or inside closed subtrees.
1121 The root nodes does not get included when <I>-hideroot</I> is true.
1122 The -default option specifies a value to substitute for unset data column cells.
1124 <P><DT><A NAME="M68"><I>pathName </I><B>configure</B> ?<I>option</I>? ?<I>value option value ...</I>?</A><DD>
1125 Query or modify the configuration options of the widget.
1126 If no <I>option</I> is specified, returns a list describing all of
1127 the available options for <I>pathName</I> (see <B><A HREF="../TkLib/ConfigWidg.htm">Tk_ConfigureInfo</A></B> for
1128 information on the format of this list). If <I>option</I> is specified
1129 with no <I>value</I>, then the command returns a list describing the
1130 one named option (this list will be identical to the corresponding
1131 sublist of the value returned if no <I>option</I> is specified). If
1132 one or more <I>option-value</I> pairs are specified, then the command
1133 modifies the given widget option(s) to have the given value(s); in
1134 this case the command returns an empty string.
1135 <I>Option</I> and <I>value</I> are described in the section
1137 <P><DT><A NAME="M69"><I>pathName </I><B>curselection</B></A><DD>
1138 Returns a list containing the ids of all of the entries that are
1140 If there are no entries selected, then the empty string is returned.
1141 <P><DT><A NAME="M70"><I>pathName </I><B>delete </B><I>tagnode</I>...</A><DD>
1142 Deletes one or more entries given by <I>tagnode</I> and its children.
1143 <P><DT><A NAME="M71"><I>pathName </I><B>edit ?</B><I>-test -root</I>? <I>X Y</I></A><DD>
1144 Test if edit is complete.
1145 <P><DT><A NAME="M72"><I>pathName </I><B>entry </B><I>operation</I> ?<I>args</I>?</A><DD>
1146 The following operations are available for treeview entries.
1148 <DL class="treeview operations">
1149 <DT><A NAME="M73"><I>pathName </I><B>entry activate</B> <I>tagOrId</I></A><DD>
1150 Sets the active entry to the one specified by <I>tagOrId</I>.
1151 When an entry is active it is drawn using its active icon
1152 (see the <B>-activeicon</B> and <B>-activeleaficon</B> options).
1153 The special id of the currently active node is <B>active</B>.
1154 Note that there can be only one active node at a time and
1155 currently icons must be the same size/shape as the backgrounds are not cleared.
1156 But <B><A HREF="../TkCmd/bind.htm">bind</A></B> can be used to overcome these limitations.
1157 <P><DT><A NAME="M74"><I>pathName </I><B>entry cget</B> <I>option</I></A><DD>
1158 Returns the current value of the configuration option given
1160 <I>Option</I> may have any of the values accepted by the <B>configure</B>
1161 operation described below.
1162 <P><DT><A NAME="M75"><I>pathName </I><B>entry children</B> <I>tagOrId</I> ?<I>first</I>? ?<I>last</I>?</A><DD>
1163 Returns a list of ids for the given range of children of <I>tagOrId</I>.
1164 <I>TagOrId</I> is the id or tag of the node to be examined.
1165 If only a <I>first</I> argument is present, then the id
1166 of the that child at that numeric position is returned. If both <I>first</I>
1167 and <I>last</I> arguments are given, then the ids of all the children
1168 in that range are returned. Otherwise the ids of all children
1170 <P><DT><A NAME="M76"><I>pathName </I><B>entry configure</B> <I>tagnode</I> ?<I>option</I>? ?<I>value option value ...</I>?</A><DD>
1171 Query or modify the configuration options of the widget.
1172 If no <I>option</I> is specified, returns a list describing all of
1173 the available options for <I>tagnode</I> (see <B><A HREF="../TkLib/ConfigWidg.htm">Tk_ConfigureInfo</A></B> for
1174 information on the format of this list). If <I>option</I> is specified
1175 with no <I>value</I>, then the command returns a list describing the
1176 one named option (this list will be identical to the corresponding
1177 sublist of the value returned if no <I>option</I> is specified). If
1178 one or more <I>option-value</I> pairs are specified, then the command
1179 modifies the given widget option(s) to have the given value(s); in
1180 this case the command returns an empty string.
1181 <I>Option</I> and <I>value</I> are described below:
1182 <P><DT><A NAME="M77"><I>pathName </I><B>entry delete</B> <I>tagOrId</I> ?<I>first</I> ?<I>last</I>?</A><DD>
1183 Deletes the one or more children nodes of the parent <I>tagOrId</I>.
1184 If <I>first</I> and <I>last</I> arguments are present, they are
1185 positions designating a range of children nodes to be deleted.
1186 <P><DT><A NAME="M78"><I>pathName </I><B>entry depth </B><I>tagOrId</I></A><DD>
1187 Return tree depth of node where root is 0.
1188 <P><DT><A NAME="M79"><I>pathName </I><B>entry down </B><I>tagOrId</I></A><DD>
1189 The next open node from the given node. The <B>down</B> of
1190 the last open node is the same.
1191 <P><DT><A NAME="M80"><I>pathName </I><B>entry get</B> <I>tagOrId</I> ?<I>key</I>? ?<I>default</I>?</A><DD>
1192 Return a key-field value for an entry.
1193 When no <I>key</I> is given, returns the values of all visible columns.
1194 If the given <I>key</I> is undefined, return <I>default</I> if given, else
1196 Unlike <B>entry set</B>, the tree
1197 is accessed directly so keys not having associated columns are supported.
1198 <P><DT><A NAME="M81"><I>pathName </I><B>entry isbefore </B><I>tagOrId1</I> <I>tagOrId2</I></A><DD>
1199 Returns 1 if <I>tagOrId1</I> is before <I>tagOrId2</I> and 0 otherwise.
1200 <P><DT><A NAME="M82"><I>pathName </I><B>entry ishidden </B><I>tagOrId</I></A><DD>
1201 Returns 1 if the node is currently hidden and 0 otherwise. A node is
1202 also hidden if any of its ancestor nodes are closed or hidden.
1203 <P><DT><A NAME="M83"><I>pathName </I><B>entry isopen </B><I>tagOrId</I></A><DD>
1204 Returns 1 if the node is currently open and 0 otherwise.
1205 <P><DT><A NAME="M84"><I>pathName </I><B>entry isset </B> <I>tagOrId col</I></A><DD>
1206 Return true if the entry sets a column-field (has a value).
1207 The entry and column both must exist.
1208 <P><DT><A NAME="M85"><I>pathName </I><B>entry isvisible </B><I>tagOrId</I></A><DD>
1209 Returns 1 if node is not hidden, inside a closed subtree.
1210 <P><DT><A NAME="M86"><I>pathName </I><B>entry next </B><I>tagOrId</I></A><DD>
1211 The next open node from the given node. But unlike <B>down</B>,
1212 when the focus is on last open node, <B><A HREF="../TclCmd/next.htm">next</A></B> wraps around to the
1214 <P><DT><A NAME="M87"><I>pathName </I><B>entry parent </B><I>tagOrId</I></A><DD>
1215 Returns parent of the given node.
1216 <P><DT><A NAME="M88"><I>pathName </I><B>entry prev </B><I>tagOrId</I></A><DD>
1217 The last open node from the given node. But unlike <B>up</B>,
1218 when the focus is at root, <B>last</B> wraps around to the last
1219 open node in the tree.
1220 <P><DT><A NAME="M89"><I>pathName </I><B>entry relabel </B><I>tagOrId newLabel</I></A><DD>
1221 Change the tree node label associated with an entry.
1222 This sets the tree node <I>label</I>;
1223 ie. the value returned by the <B>get</B> command.
1224 Note this is not the same thing as the
1225 treeview entries <B>-label</B> option.
1226 Also, the <B>-allowduplicates</B> option must be enabled to use this command
1227 as no duplicate checking will be performed.
1228 <P><DT><A NAME="M90"><I>pathName </I><B>entry select </B><I>tagOrId</I></A><DD>
1229 Make the given node visible and give it the focus.
1230 When in single selectmode, select it (calls <I>::blt::tv::MoveFocus</I>)
1231 <P><DT><A NAME="M91"><I>pathName </I><B>entry set </B> <I>tagOrId col</I> ?<I>value col value ...</I>?</A><DD>
1232 Get or set column-fields for an entry. Provides a simple
1233 way to read or update fields from the <I>-data</I> option of an entry.
1234 <P><DT><A NAME="M92"><I>pathName </I><B>entry sibling ?-before</B>? <I>tagOrId</I></A><DD>
1235 The next/previous sibling from the given node. If the node
1236 is already the last/first sibling then nothing is returned.
1237 <P><DT><A NAME="M93"><I>pathName </I><B>entry size</B> <B>-recurse</B> <I>tagOrId</I></A><DD>
1238 Returns the number of children for parent node <I>tagOrId</I>.
1239 If the <B>-recurse</B> flag is set, the number of all
1240 its descendants is returned. The node itself is not counted.
1241 <P><DT><A NAME="M94"><I>pathName </I><B>entry unset </B> <I>tagOrId col</I></A><DD>
1242 Unset a column-field for an entry.
1243 <P><DT><A NAME="M95"><I>pathName </I><B>entry up </B><I>tagOrId</I></A><DD>
1244 The last open node (in depth-first order) from the given node. The
1245 <B>up</B> of the last node is itself.
1246 <P><DT><A NAME="M96"><I>pathName </I><B>entry value </B> <I>tagOrId</I> ?<I>col</I>?</A><DD>
1247 Return the value for an entry column, or all visible columns
1248 if <I>col</I> not given.
1249 Unlike <B>entry set</B>, this gives access to the formatted value
1250 from <B>-formatcmd</B> (if there was one).
1252 <P><DT><A NAME="M97"><I>pathName </I><B>find </B>?<I>flags</I>? <I>first</I> <I>last</I></A><DD>
1253 Finds for all entries matching the criteria given by <I>flags</I>. A
1254 list of ids for all matching nodes is returned. <I>First</I> and
1255 <I>last</I> are ids designating the range of the search in
1256 depth-first order. If <I>last</I> is before <I>first</I>, then nodes
1257 are searched in reverse order. The valid flags are:
1259 <DL class="treeview operations">
1260 <DT><A NAME="M98"><B>-addtag NAME</B></A><DD>
1261 Add tag to each matching entry.
1262 <P><DT><A NAME="M99"><B>-command</B> <I>command</I></A><DD>
1263 Invoke <I>command</I> for each matching node. Before <I>command</I> is
1264 invoked, the id of the node is appended. If <I>command</I>
1265 generates an error, processing stops and the <B>find</B> operation
1267 <P><DT><A NAME="M100"><B>-column</B><I> col</I></A><DD>
1268 Match name against value of given column. Must be used with
1269 <I>-name</I> and can not use with <I>-usepath</I>.
1270 <P><DT><A NAME="M101"><B>-count</B></A><DD>
1271 Just return the number of matches.
1272 <P><DT><A NAME="M102"><B>-depth</B> <I>number</I></A><DD>
1273 Entry must be at depth <I>number</I>.
1274 <P><DT><A NAME="M103"><B>-exact</B></A><DD>
1275 Patterns must match exactly. The is the default.
1276 <P><DT><A NAME="M104"><B>-exec</B><I> string</I></A><DD>
1277 Specifies a Tcl script to be evaluated for each matching node.
1278 If <B>-var</B> was also specified, that variable is set with the value of
1279 the node id before each evaluation. Otherwise,
1280 percent sustitutions are performed: note this is much
1281 less efficient than using either <B>-var</B> or <B>-command</B>
1283 The result of each eval gets appended to the return list, unless
1284 the script issues a CONTINUE, in which case that node is skipped.
1286 The available percent substitutions on <I>string</I> are:
1288 <DL class="treeview operations">
1289 <DT><A NAME="M105"><B>%#</B></A><DD>
1291 <P><DT><A NAME="M106"><B>%W</B></A><DD>
1292 The pathname of the widget.
1293 <P><DT><A NAME="M107"><B>%p</B></A><DD>
1294 The name of the node.
1295 <P><DT><A NAME="M108"><B>%P</B></A><DD>
1296 The full pathname of the node.
1297 <P><DT><A NAME="M109"><B>%V</B></A><DD>
1298 The current value (the node name, node label or column value).
1299 <P><DT><A NAME="M110"><B>%F</B></A><DD>
1300 Like <B>%V</B>, but returns the on-screen value (from -formatcmd).
1301 <P><DT><A NAME="M111"><B>%C</B></A><DD>
1303 <P><DT><A NAME="M112"><B>%%</B></A><DD>
1304 Translates to a single percent.
1306 <P><DT><A NAME="M113"><B>-glob</B></A><DD>
1307 Use global pattern matching. Matching is done in a fashion
1308 similar to that used by <B><A HREF="../TclCmd/string.htm">string match</A></B>.
1309 <P><DT><A NAME="M114"><B>-invert</B></A><DD>
1310 Invert the meaning of the pattern match for <B>-name</B>.
1311 <P><DT><A NAME="M115"><B>-isclosed</B></A><DD>
1312 Include only entries that are closed.
1313 <P><DT><A NAME="M116"><B>-ishidden</B></A><DD>
1314 Include only entries that are hidden, either because the entry
1315 has set -hide, or is has style that is hidden.
1316 The root node is not included.
1317 <P><DT><A NAME="M117"><B>-isleaf</B></A><DD>
1318 Entry must not have child nodes.
1319 <P><DT><A NAME="M118"><B>-ismapped</B></A><DD>
1320 Include only entries that are currently all or partly drawn on screen.
1321 The root node is not included.
1322 <P><DT><A NAME="M119"><B>-isopen</B></A><DD>
1323 Include only entries that are opened.
1324 <P><DT><A NAME="M120"><B>-istree</B></A><DD>
1325 Entry must have child nodes.
1326 <P><DT><A NAME="M121"><B>-limit</B><I> number</I></A><DD>
1327 Stop searching after <I>number</I> matches.
1328 <P><DT><A NAME="M122"><B>-maxdepth</B></A><DD>
1329 Entry must be at depth or lower.
1330 <P><DT><A NAME="M123"><B>-mindepth</B></A><DD>
1331 Entry must be at depth or higher.
1332 <P><DT><A NAME="M124"><B>-name</B><I> pattern</I></A><DD>
1333 Specifies pattern to match against node names.
1334 <P><DT><A NAME="M125"><B>-nocase</B></A><DD>
1335 Comparisison is ignores case. For -regexp, the target string
1336 gets lower cased (but not the pattern).
1337 <P><DT><A NAME="M126"><B>-notop</B></A><DD>
1338 Exclude the <B>-top</B> or starting node.
1339 <P><DT><A NAME="M127"><B>-regexp</B></A><DD>
1340 Use regular expression pattern matching (i.e. the same as implemented
1341 by the <B><A HREF="../TclCmd/regexp.htm">regexp</A></B> command).
1342 <P><DT><A NAME="M128"><B>-reldepth</B></A><DD>
1343 Change the meaning of <B>-depth</B>, <B>-mindepth</B> and <B>-maxdepth</B>
1344 to be relative to the <B>-top</B> node.
1345 <P><DT><A NAME="M129"><B>-return</B><I> col</I></A><DD>
1346 Instead of the node id, return data value of named column.
1347 If <I>col</I> starts with a %, performs percent substitution
1348 as per <B>-command</B>.
1350 substitution longer than 2 chars will append values as list elements.
1351 <P><DT><A NAME="M130"><B>-top </B><I>node</I></A><DD>
1352 Search is only at <I>node</I> and it's descendants.
1353 The default is the root node.
1354 <P><DT><A NAME="M131"><B>-useformat</B></A><DD>
1355 Compare pattern using <B>-formatcmd</B> value (if there is one) instead key data value.
1356 <P><DT><A NAME="M132"><B>-uselabel</B></A><DD>
1357 Compare pattern using label (if there is one) instead last component of path.
1358 <P><DT><A NAME="M133"><B>-usepath</B></A><DD>
1359 Compare pattern using the full path name.
1360 <P><DT><A NAME="M134"><B>-userow</B></A><DD>
1361 Compare pattern using the node value plus the values of all keys in the row.
1362 If used with <B>-visible</B>, only the visible column keys are used.
1363 <P><DT><A NAME="M135"><B>-visible</B></A><DD>
1364 Exclude values that are hidden or inside closed subtrees.
1365 eg. The root node is excluded if <I>-hideroot</I> is true.
1366 <P><DT><A NAME="M136"><B>-withouttag NAME</B></A><DD>
1367 Match entries without tag.
1368 <P><DT><A NAME="M137"><B>-withtag NAME</B></A><DD>
1369 Match entries with tag.
1370 <P><DT><A NAME="M138"><B>-var </B><I>variable</I></A><DD>
1371 A variable to set with the node id before each iteration of the <B>-exec</B>
1373 <P><DT><A NAME="M139"><B>-option</B> <I>name value</I></A><DD>
1374 Specifies an option name and value
1375 to match against the node entry's configuration option.
1376 <P><DT><A NAME="M140"><B>--</B></A><DD>
1377 Indicates the end of flags.
1379 <P><DT><A NAME="M141"><I>pathName </I><B>focus </B>?<I>tagOrId</I>?</A><DD>
1380 Get or set the focus to the node given by <I>tagOrId</I>. When a node
1381 has focus, it can receive keyboard events.
1382 The special id <B><A HREF="../TkCmd/focus.htm">focus</A></B> designates the node that currently has focus.
1383 <P><DT><A NAME="M142"><I>pathName </I><B>get</B> ?<B>-full</B>? ?<B>-labels</B>? <I>tagnode</I> <I>tagnode</I>...</A><DD>
1384 Translates one or more ids to their node entry names. It returns a list of
1385 names for all the ids specified. If the <B>-full</B>
1386 flag is set, then the full pathnames are returned.
1387 If the <B>-labels</B>
1388 flag is set, then the full pathnames using labels are returned.
1390 Note: Except when a called with a single node id (ie. an integer),
1391 the result will be a list
1392 (or list of lists when -separator isn't set).
1393 <P><DT><A NAME="M143"><I>pathName </I><B>hide </B>?<B>flags</B>? <I>tagOrId</I>...</A><DD>
1394 Hides all nodes matching the criteria given by <I>flags</I>.
1395 If no <I>tagOrId</I> are given, traverses entire tree.
1396 The valid flags are described below:
1398 <DL class="treeview operations">
1399 <DT><A NAME="M144"><B>-column</B><I> col</I></A><DD>
1400 Match name against value of given column. Must be used with
1401 <I>-name</I> and can not use <I>-usepath</I>.
1402 <P><DT><A NAME="M145"><B>-depth</B> <I>number</I></A><DD>
1403 Entry must be at depth <I>number</I>.
1404 <P><DT><A NAME="M146"><B>-exact</B></A><DD>
1405 Match patterns exactly. The is the default.
1406 <P><DT><A NAME="M147"><B>-glob</B></A><DD>
1407 Use global pattern matching. Matching is done in a fashion
1408 similar to that used by <B><A HREF="../TclCmd/string.htm">string match</A></B>.
1409 <P><DT><A NAME="M148"><B>-invert</B></A><DD>
1410 Invert the meaning of the pattern match for <B>-name</B> or <B>-option</B>.
1411 <P><DT><A NAME="M149"><B>-maxdepth</B></A><DD>
1412 Entry must be at depth or lower.
1413 <P><DT><A NAME="M150"><B>-mindepth</B></A><DD>
1414 Entry must be at depth or higher.
1415 <P><DT><A NAME="M151"><B>-name</B><I> pattern</I></A><DD>
1416 Specifies pattern to match against node names.
1417 <P><DT><A NAME="M152"><B>-nocase</B></A><DD>
1418 Ignore case in match.
1419 <P><DT><A NAME="M153"><B>-option name value</B></A><DD>
1420 Specifies an option name and value
1421 to match against the node entry's configuration option.
1422 <P><DT><A NAME="M154"><B>-regexp</B></A><DD>
1423 Use regular expression pattern matching (i.e. the same as implemented
1424 by the <B><A HREF="../TclCmd/regexp.htm">regexp</A></B> command).
1425 <P><DT><A NAME="M155"><B>-uselabel</B></A><DD>
1426 Specifies that the -name pattern is to match the label.
1427 <P><DT><A NAME="M156"><B>-usepath</B></A><DD>
1428 Specifies that the -name pattern is to match the full path.
1429 <P><DT><A NAME="M157"><B>-withouttag NAME</B></A><DD>
1430 Match entries with tag.
1431 <P><DT><A NAME="M158"><B>-withtag NAME</B></A><DD>
1432 Match entries with tag.
1433 <P><DT><A NAME="M159"><B>--</B></A><DD>
1434 Indicates the end of flags.
1436 <P><DT><A NAME="M160"><I>pathName </I><B>index </B>?<B>-at</B> <I>tagOrId</I>? ?<B>-path</B>? ?<B>-quiet</B>? <I>string</I></A><DD>
1437 Returns the id of the node specified by <I>string</I>. <I>String</I>
1438 may be a tag or node id.
1439 Some special ids are normally relative to the node that
1440 has focus but the <B>-at</B> option can be used to change this.
1441 The <B>-path</B> flag does a lookup using <I>String</I> as a path
1442 relative the tree root (unless the <B>-at</B> option is given).
1443 The the <B>-quiet</B> flag is given, lookup failures quietly return
1445 <P><DT><A NAME="M161"><I>pathName </I><B>insert</B> ?<B>-node </B><I>num</I>? ?<B>-at </B><I>tagOrId</I>? ?<B>-styles </B><I>styleslist</I>? ?<B>-tags </B><I>tagslist</I>? <I>position</I> ?<I>path</I>? ?<I>options...</I>? ?<I>path</I>? ?<I>options...</I>?</A><DD>
1446 Inserts one or more nodes at <I>position</I>. <I>Position</I> is the
1447 location (number or <B>end</B>) where the new nodes are added to
1448 the parent node. <I>Path</I> is the pathname of the new node.
1449 Pathnames can be formatted either as a Tcl list (each element is a path
1450 component) or as a string separated by a special character sequence
1451 (using the <B>-separator</B> option). Pathnames are normally
1452 absolute, but the <B>-at</B> switch lets you select a relative
1453 starting point. Its value is the id of the starting node.
1455 If <I>path</I> name and options are ommitted, <I>path</I>
1456 will default to <I>#auto</I>.
1458 A <I>path</I> name of <I>#auto</I> attempts to use
1459 the tree node name as the <I>path</I> name.
1460 For large flat trees setting <B>-allowduplicates</B> to true
1461 can greatly speedup loading #auto as it avoids checking overhead.
1462 This is the fastest way to bulk load large numbers of nodes
1463 (next to using <B>-tree</B>).
1465 If the last component of a <I>path</I> name
1466 ends in <I>#auto</I>, the path is
1467 generated using the string prefix (before #auto)
1468 followed by a sequential number unique within the
1469 parent, eg. <B>.t insert end {users u#auto}</B>.
1471 The <B>-node</B> switch lets you specify a tree node number
1472 directly instead of having one generating automatically.
1473 For multi-node inserts, the node number is incremented.
1475 The <B>-styles</B> switch specifies a list of column/stylename
1476 pairs to set for elements of the <B>-data</B> option.
1478 The <B>-tags</B> switch specifies a list of tags to add
1481 Note that all ancestors of the new node must already exist, unless the
1482 <B>-autocreate</B> option is set. It is also an error if a node
1483 already exists, unless the <B>-allowduplicates</B> option is set.
1485 The <I>option</I> and <I>value</I> arguments
1486 may have any of the values accepted by the
1487 <B>entry configure</B> operation described in the
1488 section below. The returned value is list of ids for
1490 <P><DT><A NAME="M162"><I>pathName </I><B>move </B><I>tagnode</I> <I>how</I> <I>destId</I></A><DD>
1491 Moves the node(s) given by <I>tagnode</I> to the destination node. The
1492 node can not be an ancestor of the destination. <I>DestId</I> is
1493 the id of the destination node and can not be the root of the
1494 tree. In conjunction with <I>how</I>, it describes how the move is
1497 <DL class="treeview operations">
1498 <DT><A NAME="M163"><B>before</B></A><DD>
1499 Moves the node before the destination node.
1500 <P><DT><A NAME="M164"><B>after</B></A><DD>
1501 Moves the node after the destination node.
1502 <P><DT><A NAME="M165"><B>into</B></A><DD>
1503 Moves the node to the end of the destination's list of children.
1505 <P><DT><A NAME="M166"><I>pathName </I><B>nearest</B> ?<B>-root</B>? ?<B>-strict</B>? <I>x y</I> ?<I>varName</I>?</A><DD>
1506 Returns the id of the node entry closest to the given X-Y screen
1507 coordinate. If the coordinate is not directly over any node, then the
1508 nearest node is returned. If the argument <I>varName</I> is present,
1509 this is a Tcl variable that is set to either <B><A HREF="../TkCmd/button.htm">button</A></B>,
1510 <B>icon</B>, <B><A HREF="../TkCmd/label.htm">label</A></B>, <B>title</B>, <B>titlelabel</B>, <B>titleicon</B>, <B>datalabel</B>, <B>dataicon</B>, or <B>""</B> depending what part of the
1511 entry the coordinate lies.
1512 The -root option subtracts the windows root from the coordinates.
1513 The -strict option fails the match if not directly
1514 over a node, eg. in the title or past end of last row.
1515 <P><DT><A NAME="M167"><I>pathName </I><B>open </B>?<B>-recurse</B>? ?<B>-trees</B>? <I>tagnode...</I></A><DD>
1516 Opens the one or more nodes specified by <I>tagnode</I>.
1517 If a node is not already open, the Tcl script specified by the
1518 <B>-opencommand</B> option is invoked. If the <B>-recurse</B> flag
1519 is present, then each descendant is recursively opened.
1520 The <B>-trees</B> flag is like <B>-recurse</B> but operates only on nodes
1522 <P><DT><A NAME="M168"><I>pathName </I><B>range</B> ?<B>-open</B>? <I>first last</I></A><DD>
1523 Returns the ids in depth-first order of the nodes
1524 between the <I>first</I> and <I>last</I> ids. If the <B>-open</B>
1525 flag is present, it indicates to consider only open nodes.
1526 If <I>last</I> is before <I>first</I>, then the ids are
1527 returned in reverse order.
1528 <P><DT><A NAME="M169"><I>pathName </I><B>scan</B> <I>option args</I></A><DD>
1529 This command implements scanning. It has
1530 two forms, depending on <I>option</I>:
1532 <DL class="treeview operations">
1533 <DT><A NAME="M170"><I>pathName </I><B>scan mark </B><I>x y</I></A><DD>
1534 Records <I>x</I> and <I>y</I> and the current view in the treeview
1535 window; used in conjunction with later <B>scan dragto</B> commands.
1536 Typically this command is associated with a mouse button press in
1537 the widget. It returns an empty string.
1538 <P><DT><A NAME="M171"><I>pathName </I><B>scan dragto </B><I>x y</I>.</A><DD>
1539 Computes the difference between its <I>x</I> and <I>y</I>
1540 arguments and the <I>x</I> and <I>y</I> arguments to the last
1541 <B>scan mark</B> command for the widget.
1542 It then adjusts the view by 10 times the
1543 difference in coordinates. This command is typically associated
1544 with mouse motion events in the widget, to produce the effect of
1545 dragging the list at high speed through the window. The return
1546 value is an empty string.
1548 <P><DT><A NAME="M172"><I>pathName </I><B>see</B> ?<B>-anchor </B><I>anchor</I>? <I>tagOrId</I></A><DD>
1549 Adjusts the view of entries so that the node given by <I>tagOrId</I> is
1550 visible in the widget window. It is an error if <B>tagOrId</B> is a
1551 tag that refers to more than one node. The node's position
1552 on the screen can be set using the
1553 <B>-anchor</B> flag. Its value is a Tk anchor position: <B>n, c, s</B>.
1554 <P><DT><A NAME="M173"><I>pathName </I><B>selection </B><I>option arg</I></A><DD>
1555 This command is used to adjust the selection within a <B>treeview</B>
1556 widget. It has several forms, depending on <I>option</I>:
1558 <DL class="treeview operations">
1559 <DT><A NAME="M174"><I>pathName </I><B>selection anchor ?</B><I>tagOrId</I>? ?<I>column</I>?</A><DD>
1560 Sets the selection anchor to the node given by <I>tagOrId</I>.
1561 If <I>tagOrId</I> refers to a non-existent node, then the closest
1563 The selection anchor is the end of the selection that is fixed
1564 while dragging out a selection with the mouse.
1565 The special id <B>anchor</B> may be used to refer to the anchor
1566 node. With no arguments, returns anchor entry and column if any.
1567 <P><DT><A NAME="M175"><I>pathName </I><B>selection cells</B></A><DD>
1568 Returns pairs of nodes and columns for all selected cells.
1569 The -selectmode must be <I>cell</I> or <I>multicell</I>.
1570 <P><DT><A NAME="M176"><I>pathName </I><B>selection clear </B><I>first </I>?<I>last</I>? ?<I>column</I>?</A><DD>
1571 Removes the entries between <I>first</I> and <I>last</I>
1572 (inclusive) from the selection. Both <I>first</I> and
1573 <I>last</I> are ids representing a range of entries.
1574 If <I>last</I> isn't given, then only <I>first</I> is deselected.
1575 Entries outside the selection are not affected.
1576 <P><DT><A NAME="M177"><I>pathName </I><B>selection clearall</B></A><DD>
1577 Clears the entire selection.
1578 <P><DT><A NAME="M178"><I>pathName </I><B>selection mark </B><I>tagOrId</I> ?<I>column</I>?</A><DD>
1579 Sets the selection mark to the node given by <I>tagOrId</I>. This
1580 causes the range of entries between the anchor and the mark to be
1581 temporarily added to the selection. The selection mark is the end of
1582 the selection that is fixed while dragging out a selection with the
1583 mouse. The special id <B>mark</B> may be used to refer to the current
1585 If <I>tagOrId</I> refers to a non-existent node, then the mark
1587 Resetting the mark will unselect
1588 the previous range. Setting the anchor finalizes the range.
1589 <P><DT><A NAME="M179"><I>pathName </I><B>selection includes </B><I>tagOrId</I> ?<I>column</I>?</A><DD>
1590 Returns 1 if the node given by <I>tagOrId</I> is currently
1591 selected, 0 if it isn't.
1592 <P><DT><A NAME="M180"><I>pathName </I><B>selection present</B></A><DD>
1593 Returns 1 if any nodes are currently selected and 0 otherwise.
1594 <P><DT><A NAME="M181"><I>pathName </I><B>selection set </B><I>first </I>?<I>last</I>? ?<I>column</I>?</A><DD>
1595 Selects all of the nodes in the range between
1596 <I>first</I> and <I>last</I>, inclusive, without affecting
1597 the selection state of nodes outside that range.
1598 <P><DT><A NAME="M182"><I>pathName </I><B>selection toggle </B><I>first </I>?<I>last</I>? ?<I>column</I>?</A><DD>
1599 Selects/deselects nodes in the range between
1600 <I>first</I> and <I>last</I>, inclusive, from the selection.
1601 If a node is currently selected, it becomes deselected, and
1604 <P><DT><A NAME="M183"><I>pathName </I><B>show </B>?<B>flags</B>? <I>tagOrId</I>...</A><DD>
1605 Un-hide nodes matching the criteria given by <I>flags</I>.
1606 If no <I>tagOrId</I> are given, traverses entire tree.
1607 The <I>flags</I> are the same as for the <B>hide</B> command.
1608 <P><DT><A NAME="M184"><I>pathName </I><B>sort</B> ?<I>operation</I>? <I>args...</I></A><DD>
1610 <DL class="treeview operations">
1611 <DT><A NAME="M185"><I>pathName </I><B>sort auto</B> ?<I>boolean</I></A><DD>
1612 Turns on/off automatic sorting of node entries. If <I>boolean</I> is
1613 true, entries will be automatically sorted as they are opened,
1614 closed, inserted, or deleted. If no <I>boolean</I> argument is
1615 provided, the current state is returned.
1616 <P><DT><A NAME="M186"><I>pathName </I><B>sort cget</B> <I>option</I></A><DD>
1617 Returns the current value of the configuration option given
1619 <I>Option</I> may have any of the values accepted by the <B>configure</B>
1620 operation described below.
1621 <P><DT><A NAME="M187"><I>pathName </I><B>sort configure</B> ?<I>option</I>? ?<I>value option value ...</I>?</A><DD>
1622 Query or modify the sorting configuration options of the widget.
1623 If no <I>option</I> is specified, returns a list describing all of
1624 the available options for <I>pathName</I> (see <B><A HREF="../TkLib/ConfigWidg.htm">Tk_ConfigureInfo</A></B> for
1625 information on the format of this list). If <I>option</I> is specified
1626 with no <I>value</I>, then the command returns a list describing the
1627 one named option (this list will be identical to the corresponding
1628 sublist of the value returned if no <I>option</I> is specified). If
1629 one or more <I>option-value</I> pairs are specified, then the command
1630 modifies the given sorting option(s) to have the given value(s); in
1631 this case the command returns an empty string.
1632 <I>Option</I> and <I>value</I> are described below:
1634 <DL class="treeview operations">
1635 <DT><A NAME="M188"><B>-column</B><I> string</I></A><DD>
1636 Specifies the column to sort. Entries in the widget are rearranged
1637 according to this column. If <I>column</I> is <B>""</B> then
1638 no sort is performed.
1639 <P><DT><A NAME="M189"><B>-command</B><I> string</I></A><DD>
1640 Specifies a Tcl procedure to be called when sorting nodes.
1641 The procedure is called with three arguments: the pathname of the widget
1642 and the fields of two entries. The procedure returns 1 if the first
1643 node is greater than the second, -1 is the second is greater, and 0
1645 <P><DT><A NAME="M190"><B>-decreasing</B><I> boolean</I></A><DD>
1646 Indicates to sort in ascending/descending order. If <I>boolean</I>
1647 is true, then the entries as in descending order. The default is
1649 <P><DT><A NAME="M191"><B>-mode</B><I> string</I></A><DD>
1650 Specifies how to compare entries when sorting. <I>String</I>
1651 may be one of the following:
1652 <P><DT><A NAME="M192"><B>-setflat</B><I> bool</I></A><DD>
1653 Used by SortColumn to remember if tree was forced to flat by a sort.
1655 <DL class="treeview operations">
1656 <DT><A NAME="M193"><B>ascii</B></A><DD>
1657 Use string comparison based upon the ASCII collation order.
1658 <P><DT><A NAME="M194"><B>dictionary</B></A><DD>
1659 Use dictionary-style comparison. This is the same as <B>ascii</B>
1660 except (a) case is ignored except as a tie-breaker and (b) if two
1661 strings contain embedded numbers, the numbers compare as integers, not
1662 characters. For example, "bigBoy" sorts between
1663 "bigbang" and "bigboy", and "x10y" sorts between "x9y" and "x11y".
1664 <P><DT><A NAME="M195"><B>integer</B></A><DD>
1665 Compares fields as integers.
1666 <P><DT><A NAME="M196"><B>real</B></A><DD>
1667 Compares fields as floating point numbers.
1668 <P><DT><A NAME="M197"><B>command</B></A><DD>
1669 Use the Tcl proc specified by the <B>-command</B> option to compare entries
1670 when sorting. If no command is specified, the sort reverts to
1671 <B>dictionary</B> sorting.
1674 <P><DT><A NAME="M198"><I>pathName </I><B>sort once</B> ?<I>flags</I>? <I>tagOrId...</I></A><DD>
1675 Sorts the children for each entries specified by <I>tagOrId</I>.
1676 By default, entries are sorted by name, but you can specify a
1677 Tcl proc to do your own comparisons.
1679 <DL class="treeview operations">
1680 <DT><A NAME="M199"><B>-recurse</B></A><DD>
1681 Recursively sort the entire branch, not just the children.
1684 <P><DT><A NAME="M200"><I>pathName </I><B>style </B><I>operation</I> ?<I>args</I>?</A><DD>
1685 Styles control how data is to be rendered by the widget.
1686 They are created with the <B>create</B> subcommands (described below)
1687 A default style name <B><A HREF="../TkCmd/text.htm">text</A></B> is builtin. It is of type
1688 <I>textbox</I> and is used as the default style for columns.
1689 Styles may also be applied to entries, individual cells or
1690 widget options. For example, the <B>-altstyle</B> option applies a style to
1691 every second visible row entry while the
1692 <B>-levelstyles</B> option can specify a different style for each node level.
1694 The following operations are available for treeview styles.
1696 <DL class="treeview operations">
1697 <DT><A NAME="M201"><I>pathName </I><B>style activate</B> <I>entry column</I></A><DD>
1698 Turns on/off highlighting for a particular style.
1699 This is only partially implemented.
1700 <P><DT><A NAME="M202"><I>pathName </I><B>style cget</B> <I>stylename option</I></A><DD>
1701 Returns the current value of the configuration option given
1703 <I>Option</I> may have any of the values accepted by the <B>configure</B>
1704 operation described below.
1705 <P><DT><A NAME="M203"><I>pathName </I><B>style configure</B> ?<I>stylename option</I>? ?<I>value option value ...</I>?</A><DD>
1706 Query or modify the configuration options of the widget.
1707 If no <I>option</I> is specified, returns a list describing all of
1708 the available options for <I>pathName</I> (see <B><A HREF="../TkLib/ConfigWidg.htm">Tk_ConfigureInfo</A></B> for
1709 information on the format of this list). If <I>option</I> is specified
1710 with no <I>value</I>, then the command returns a list describing the
1711 one named option (this list will be identical to the corresponding
1712 sublist of the value returned if no <I>option</I> is specified). If
1713 one or more <I>option-value</I> pairs are specified, then the command
1714 modifies the given widget option(s) to have the given value(s); in
1715 this case the command returns an empty string.
1716 <I>Option</I> and <I>value</I> are described below:
1717 <P><DT><A NAME="M204"><I>pathName </I><B>style create</B> <I>...</I>?</A><DD>
1718 Create a named style.
1719 For a full list of style options, see the section
1720 <I>STYLE OPTIONS</I> below.
1722 <DL class="treeview operations">
1723 <DT><A NAME="M205"><I>pathName </I><B>style create barbox</B> <I>stylename</I> ?<I>option value option value ...</I>?</A><DD>
1724 A <B>barbox</B> displays numeric data plus a progressbar.
1725 <P><DT><A NAME="M206"><I>pathName </I><B>style create checkbox</B> <I>stylename</I> ?<I>option value option value ...</I>?</A><DD>
1726 A <B>checkbox</B> style displays boolean or 2-valued data.
1727 <P><DT><A NAME="M207"><I>pathName </I><B>style create combobox</B> <I>stylename</I> ?<I>option value option value ...</I>?</A><DD>
1728 A <B>combobox</B> style displays multi-valued data.
1729 <P><DT><A NAME="M208"><I>pathName </I><B>style create textbox</B> <I>stylename</I> ?<I>option value option value ...</I>?</A><DD>
1730 A <B>textbox</B> style displays general text data.
1731 <P><DT><A NAME="M209"><I>pathName </I><B>style create windowbox</B> ?<I>stylename</I>? ?<I>option value option value ...</I>?</A><DD>
1732 The special style <B>windowbox</B> suports embedding subwindows within data
1735 <P><DT><A NAME="M210"><I>pathName </I><B>style find</B> <I>stylename ?column? ?node? ...</I></A><DD>
1736 Get all entries with the given style for a given column in the given nodes.
1737 When no column is given, looks in entry and data columns.
1738 Duplicates are not eliminated.
1740 <P><DT><A NAME="M211"><I>pathName </I><B>style forget</B> <I>stylename ...</I></A><DD>
1741 Eliminates one or more style names
1742 whose reference count is zero (i.e. no one else is using it).
1743 Requests to delete <B><A HREF="../TkCmd/text.htm">text</A></B> or styles that are still in use are quietly ignored.
1744 <P><DT><A NAME="M212"><I>pathName </I><B>style get</B> <I>column tagorid</I></A><DD>
1745 Return the style(s) for column and nodes.
1747 <P><DT><A NAME="M213"><I>pathName </I><B>style highlight</B> <I>stylename ?on|off?</I></A><DD>
1748 Turns on/off highlighting for a particular style. Used primarily for
1750 <P><DT><A NAME="M214"><I>pathName </I><B>style names</B></A><DD>
1751 Lists the names of all the current styles in the treeview widget.
1752 <P><DT><A NAME="M215"><I>pathName </I><B>style set</B> <I>stylename column node ...</I></A><DD>
1753 Sets a style for a given column for all the ids given.
1754 If column is the tree, sets the entry style,
1755 otherwise sets the style in the data column,
1756 thus setting the style for a single
1757 cell in an entry. The style name may be an empty string to unset the style.
1758 Cells that do not have a value may not have a style set and so are
1760 The number of cells that actually get set with a style is
1762 <P><DT><A NAME="M216"><I>pathName </I><B>style slaves</B> ?<B>-col </B><I>col</I>? ?<B>-id </B><I>node</I>? ?<B>-style </B><I>styleName</I>? ?<B>-visible </B><I>bool</I>? ?<B>-info </B><I>path</I>?</A><DD>
1763 With no arguments, lists all embedded window slaves.
1764 The <I>-col</I> argument shows only windows in the given column.
1765 The <I>-id</I> argument shows only windows for the given entry.
1766 The <I>-style</I> argument shows only windows with the given style.
1767 The <I>-visible</I> argument shows only windows that are visible or invisible.
1768 The <I>-info</I> argument dumps all information for a single window.
1770 <P><DT><A NAME="M217"><I>pathName </I><B>tag </B><I>operation args</I></A><DD>
1771 Tags are a general means of selecting and marking nodes in the tree.
1772 A tag is just a string of characters, and it may take any form except
1773 that of an integer. The same tag may be associated with many
1776 Both <I>operation</I> and its arguments determine the exact behavior of
1777 the command. The operations available for tags are listed below.
1779 <DL class="treeview operations">
1780 <DT><A NAME="M218"><I>pathName</I> <B>tag add</B> <I>string</I> ?<I>id</I>...?</A><DD>
1781 Adds the tag <I>string</I> to one of more entries.
1782 If no nodes are given, just creates the tag.
1783 <P><DT><A NAME="M219"><I>pathName</I> <B>tag delete</B> <I>string</I> <I>tagnode</I>...</A><DD>
1784 Deletes the tag <I>string</I> from one or more entries.
1785 <P><DT><A NAME="M220"><I>treeName</I> <B>tag exists</B> <I>string</I> ?<I>id</I>?</A><DD>
1786 If an <I>id</I> is given, return 1 (or 0) if entry has (or hasn't) the tag.
1787 Otherwise, returns 1 if at least one entry has tag <I>string</I>.
1788 <P><DT><A NAME="M221"><I>pathName</I> <B>tag forget</B> <I>string</I></A><DD>
1789 Removes the tag <I>string</I> from all entries. It's not an error if no
1790 entries are tagged as <I>string</I>.
1791 <P><DT><A NAME="M222"><I>pathName</I> <B>tag names</B> ?<I>id</I>?</A><DD>
1792 Returns a list of tags used. If an <I>id</I> argument
1793 is present, only those tags used by the node designated by <I>id</I>
1795 <P><DT><A NAME="M223"><I>pathName</I> <B>tag nodes</B> <I>name</I> ?<I>name</I> ...?</A><DD>
1796 Returns a list of ids that have any of the <I>name</I> tags. If no node
1797 is tagged as <I>name</I>, then an empty list is returned.
1799 <P><DT><A NAME="M224"><I>pathName </I><B>toggle </B><I>tagnode</I></A><DD>
1800 Opens or closes the node given by <I>tagOrId</I>. If the corresponding
1801 <B>-opencommand</B> or <B>-closecommand</B> option is set, then that
1802 command is also invoked.
1803 <P><DT><A NAME="M225"><I>pathName </I><B>xview </B><I>args</I></A><DD>
1804 This command is used to query and change the horizontal position of the
1805 information in the widget's window. It can take any of the following
1808 <DL class="treeview operations">
1809 <DT><A NAME="M226"><I>pathName </I><B>xview</B></A><DD>
1810 Returns a list containing two elements.
1811 Each element is a real fraction between 0 and 1; together they describe
1812 the horizontal span that is visible in the window.
1813 For example, if the first element is .2 and the second element is .6,
1814 20% of the <B>treeview</B> widget's text is off-screen to the left,
1815 the middle 40% is visible
1816 in the window, and 40% of the text is off-screen to the right.
1817 These are the same values passed to scrollbars via the <B>-xscrollcommand</B>
1819 <P><DT><A NAME="M227"><I>pathName </I><B>xview</B> <I>tagOrId</I></A><DD>
1820 Adjusts the view in the window so that the character position given by
1821 <I>tagOrId</I> is displayed at the left edge of the window.
1822 Character positions are defined by the width of the character <B>0</B>.
1823 <P><DT><A NAME="M228"><I>pathName </I><B>xview moveto</B><I> fraction</I></A><DD>
1824 Adjusts the view in the window so that <I>fraction</I> of the
1825 total width of the <B>treeview</B> widget's text is off-screen to the left.
1826 <I>fraction</I> must be a fraction between 0 and 1.
1827 <P><DT><A NAME="M229"><I>pathName </I><B>xview scroll </B><I>number what</I></A><DD>
1828 This command shifts the view in the window left or right according to
1829 <I>number</I> and <I>what</I>.
1830 <I>Number</I> must be an integer.
1831 <I>What</I> must be either <B>units</B> or <B>pages</B> or an abbreviation
1833 If <I>what</I> is <B>units</B>, the view adjusts left or right by
1834 <I>number</I> character units (the width of the <B>0</B> character)
1835 on the display; if it is <B>pages</B> then the view adjusts by
1836 <I>number</I> screenfuls.
1837 If <I>number</I> is negative then characters farther to the left
1838 become visible; if it is positive then characters farther to the right
1841 <P><DT><A NAME="M230"><I>pathName </I><B>yview </B><I>?args</I>?</A><DD>
1842 This command is used to query and change the vertical position of the
1843 text in the widget's window.
1844 It can take any of the following forms:
1846 <DL class="treeview operations">
1847 <DT><A NAME="M231"><I>pathName </I><B>yview</B></A><DD>
1848 Returns a list containing two elements, both of which are real fractions
1850 The first element gives the position of the node at the
1851 top of the window, relative to the widget as a whole (0.5 means
1852 it is halfway through the treeview window, for example).
1853 The second element gives the position of the node just after
1854 the last one in the window, relative to the widget as a whole.
1855 These are the same values passed to scrollbars via the <B>-yscrollcommand</B>
1857 <P><DT><A NAME="M232"><I>pathName </I><B>yview</B> <I>tagOrId</I></A><DD>
1858 Adjusts the view in the window so that the node given by
1859 <I>tagOrId</I> is displayed at the top of the window.
1860 <P><DT><A NAME="M233"><I>pathName </I><B>yview moveto</B><I> fraction</I></A><DD>
1861 Adjusts the view in the window so that the node given by <I>fraction</I>
1862 appears at the top of the window.
1863 <I>Fraction</I> is a fraction between 0 and 1; 0 indicates the first
1864 node, 0.33 indicates the node one-third the
1865 way through the <B>treeview</B> widget, and so on.
1866 <P><DT><A NAME="M234"><I>pathName </I><B>yview scroll </B><I>number what</I></A><DD>
1867 This command adjusts the view in the window up or down according to
1868 <I>number</I> and <I>what</I>.
1869 <I>Number</I> must be an integer.
1870 <I>What</I> must be either <B>units</B> or <B>pages</B>.
1871 If <I>what</I> is <B>units</B>, the view adjusts up or down by
1872 <I>number</I> lines; if it is <B>pages</B> then
1873 the view adjusts by <I>number</I> screenfuls.
1874 If <I>number</I> is negative then earlier nodes
1875 become visible; if it is positive then later nodes
1879 <H3><A NAME="M235">TREEVIEW EDITING</A></H3>
1880 A column of data is editable when its <B>-edit</B> option is set to True
1881 For column 0, edit changes an entries <I>-label</I> option.
1882 For all other columns, edit will update the <I>-data</I> fields.
1883 Tree data traces can also be used for edit control.
1884 Most of the following applies to textbox styles.
1885 However, combobox and checkbox also generate <<TreeViewEditStart/End>> events
1886 while barbox and windowbox are not editable.
1888 Text editing is aborted with <Escape> and finished with <Return>.
1889 A newline may be inserted with a <Control-r>.
1890 Native Tk widgets are now used for builtin editing, using the
1891 path <B>$w.edit</B>.
1892 By default an <B><A HREF="../TkCmd/entry.htm">entry</A></B> widget will be used, however, column editing options
1893 can be changed via <B>-editopts</B>
1894 and <B>-validatecmd</B>. Moreover, columns with a combobox style
1895 can provide popup list of options in a listbox
1896 using the following style options: <B>-choices, -choicecmd -choiceicons</B>
1897 Two virtual events can be used to gain control the during edit:
1898 <I><<TreeViewEditStart>></I> and <I><<TreeViewEditEnd>></I>.
1899 The column index is passed in %x, and the entry-row index is passed in %y.
1902 bind .t <<TreeViewEditStart>> {EditStart %W %x %y}
1903 bind .t <<TreeViewEditEnd>> {EditEnd %W %x %y}</PRE>
1904 These gain control at the start and end of editing respectively,
1905 and are general alternatives to <I>-editopts</I> -startcmd and -endcmd.
1906 For further details see <I>EditCell</I> in
1907 <B>$blt_library/treeview.tcl</B>.
1908 <H3><A NAME="M236">TREEVIEW OPTIONS</A></H3>
1909 In addition to the <B>configure</B> operation, widget configuration
1910 options may also be set by the Tk <B><A HREF="../TkCmd/option.htm">option</A></B> command. The class
1911 resource name is <B>TreeView</B>.
1912 <PRE>option add *TreeView.Foreground white
1913 option add *TreeView.Background blue</PRE>
1914 The following widget options are available:
1916 <DL class="treeview options">
1917 <DT><A NAME="M237"><B>-activeicons </B><I>images</I></A><DD>
1918 Specifies images to be displayed for an entry's icon
1919 when it is active. <I>Images</I> is a list of two Tk images:
1920 the first image is displayed when the node is open, the
1921 second when it is closed.
1922 <P><DT><A NAME="M238"><B>-activeleaficons </B><I>images</I></A><DD>
1923 Specifies images to be displayed for an leaf entry's icon
1924 when it is active. <I>Images</I> is a list of two Tk images:
1925 the first image is displayed when the node is open, the
1926 second when it is closed.
1927 <P><DT><A NAME="M239"><B>-allowduplicates </B><I>boolean</I></A><DD>
1928 If <I>boolean</I> is true, allow nodes with duplicate pathnames
1929 when inserting new nodes. Otherwise flag an error.
1930 The default is <B>no</B>.
1931 <P><DT><A NAME="M240"><B>-altstyle </B><I>stylename</I></A><DD>
1932 Set a style to use on every other row. This provides a simple way
1933 to implement alternating row colors without explicitly
1934 setting entry options.
1935 <P><DT><A NAME="M241"><B>-autocreate </B><I>boolean</I></A><DD>
1936 If <I>boolean</I> is true, automatically create missing ancestor
1937 nodes when inserting new nodes. Otherwise flag an error.
1938 The default is <B>no</B>.
1939 <P><DT><A NAME="M242"><B>-background </B><I>color</I></A><DD>
1940 Sets the background color of the widget. The default is <B>white</B>.
1941 <P><DT><A NAME="M243"><B>-borderwidth </B><I>pixels</I></A><DD>
1942 Sets the width of the 3-D border around the outside edge of the widget. The
1943 <B>-relief</B> option determines if the border is to be drawn. The
1944 default is <B>2</B>.
1945 <P><DT><A NAME="M244"><B>-button </B><I>string</I></A><DD>
1946 Indicates whether a entries should display button.
1947 If set to anything other than the default of <I>auto</I>, buttons
1948 will not be displayed.
1949 <P><DT><A NAME="M245"><B>-closecommand </B><I>string</I></A><DD>
1950 Specifies a Tcl script to be invoked when a node is closed. You can
1951 overrider this for individual entries using the entry's <B>-closecommand</B>
1952 option. The default is <B>""</B>.
1953 Percent substitutions are performed on <I>string</I> before
1954 it is executed. The following substitutions are valid:
1956 <DL class="treeview options">
1957 <DT><A NAME="M246"><B>%W</B></A><DD>
1958 The pathname of the widget.
1959 <P><DT><A NAME="M247"><B>%p</B></A><DD>
1960 The name of the node.
1961 <P><DT><A NAME="M248"><B>%P</B></A><DD>
1962 The full pathname of the node.
1963 <P><DT><A NAME="M249"><B>%#</B></A><DD>
1965 <P><DT><A NAME="M250"><B>%%</B></A><DD>
1966 Translates to a single percent.
1968 <P><DT><A NAME="M251"><B>-columnshowhighlight </B><I>bool</I></A><DD>
1969 Enable display highlight color when column activated.
1971 <P><DT><A NAME="M252"><B>-cursor </B><I>cursor</I></A><DD>
1972 Specifies the widget's cursor. The default cursor is <B>""</B>.
1973 <P><DT><A NAME="M253"><B>-dashes </B><I>number</I></A><DD>
1974 Sets the dash style of the horizontal and vertical lines drawn connecting
1975 entries. <I>Number</I> is the length in pixels of the dashes and gaps in
1976 the line. If <I>number</I> is <B>0</B>, solid lines will
1977 be drawn. The default is <B>1</B> (dotted).
1978 <P><DT><A NAME="M254"><B>-emptystyle </B><I>stylename</I></A><DD>
1979 Set a style to be used for empty cells.
1980 <P><DT><A NAME="M255"><B>-entryshowhighlight </B><I>bool</I></A><DD>
1981 Enable display highlight color when entry activated.
1983 <P><DT><A NAME="M256"><B>-exportselection </B><I>boolean</I></A><DD>
1984 Indicates if the selection is exported. If the widget is exporting its
1985 selection then it will observe the standard X11 protocols for handling
1986 the selection. Selections are available as type <B><A HREF="../TclCmd/string.htm">STRING</A></B>;
1987 the value of the selection will be the label of the selected nodes,
1988 separated by newlines. The default is <B>no</B>.
1989 <P><DT><A NAME="M257"><B>-fillnull </B><I>boolean</I></A><DD>
1990 Indicates that empty data columns are to be drawn anyways,
1991 and to apply the <I>-nullstyle</I> if defined.
1992 Turning this off will leave unsightly gaps where attributes (eg. background
1993 and underline) were normally expected to be displayed.
1994 The default is <B>yes</B>.
1995 <P><DT><A NAME="M258"><B>-flat </B><I>boolean</I></A><DD>
1996 Indicates whether to display the tree as a flattened list.
1997 If <I>boolean</I> is true, then the hierarchy will be a list of full
1998 paths for the nodes. Hide and show are not supported in flat mode.
1999 This option also has affect on sorting.
2001 for more information.
2002 The default is <B>no</B>.
2003 <P><DT><A NAME="M259"><B>-focusdashes </B><I>dashList</I></A><DD>
2004 Sets the dash style of the outline rectangle drawn around the entry
2005 label of the node that current has focus. <I>Number</I> is the length
2006 in pixels of the dashes and gaps in the line. If
2007 <I>number</I> is <B>0</B>, a solid line will be drawn. The default is
2009 <P><DT><A NAME="M260"><B>-focusforeground </B><I>color</I></A><DD>
2010 Sets the color of the focus rectangle.
2011 The default is <B>black</B>.
2012 <P><DT><A NAME="M261"><B>-focusheight </B><I>value</I></A><DD>
2013 Set the height in pixels to reserve for focus highlighting above
2015 The default is <B>1</B>, but setting this to 0 will result in a
2016 more compact display.
2017 <P><DT><A NAME="M262"><B>-font </B><I>fontName</I></A><DD>
2018 Specifies the font for entry labels. You can override this for individual
2019 entries with the entry's <B>-font</B> configuration option. The default is
2020 <B>*-Helvetica-Bold-R-Normal-*-12-120-*</B>.
2021 <P><DT><A NAME="M263"><B>-foreground </B><I>color</I></A><DD>
2022 Sets the text color of entry labels. You can override this for individual
2023 entries with the entry's <B>-foreground</B> configuration option.
2026 <P><DT><A NAME="M264"><B>-height </B><I>pixels</I></A><DD>
2027 Specifies the requested height of widget. The default is
2029 <P><DT><A NAME="M265"><B>-hidedataicons </B><I>boolean</I></A><DD>
2030 If <I>boolean</I> is true, it indicates that data column icons
2032 should not be displayed. The default is <B>no</B>.
2033 <P><DT><A NAME="M266"><B>-hidedatatext </B><I>boolean</I></A><DD>
2034 If <I>boolean</I> is true, it indicates that that data column text
2035 should not be displayed. The default is <B>no</B>.
2036 <P><DT><A NAME="M267"><B>-hideicons </B><I>boolean</I></A><DD>
2037 If <I>boolean</I> is true, it indicates that tree column icons
2038 should not be displayed. The default is <B>no</B>.
2039 <P><DT><A NAME="M268"><B>-hideleaves </B><I>boolean</I></A><DD>
2040 If <I>boolean</I> is true, it indicates that no leaves
2041 should be displayed. The default is <B>no</B>.
2042 <P><DT><A NAME="M269"><B>-hideroot </B><I>boolean</I></A><DD>
2043 If <I>boolean</I> is true, it indicates that no entry for the root node
2044 should be displayed. The default is <B>no</B>.
2045 <P><DT><A NAME="M270"><B>-highlightbackground </B><I>color</I></A><DD>
2046 Specifies the normal color of the traversal highlight region when
2047 the widget does not have the input focus.
2048 <P><DT><A NAME="M271"><B>-highlightcolor </B><I>color</I></A><DD>
2049 Specifies the color of the traversal highlight rectangle when
2050 the widget has the input focus.
2051 The default is <B>black</B>.
2052 <P><DT><A NAME="M272"><B>-highlightthickness </B><I>pixels</I></A><DD>
2053 Specifies the width of the highlight rectangle indicating when the
2054 widget has input focus. The value may have any of the forms acceptable
2055 to <B><A HREF="../TkLib/GetPixels.htm">Tk_GetPixels</A></B>. If the value is zero, no focus highlight will
2056 be displayed. The default is <B>2</B>.
2057 <P><DT><A NAME="M273"><B>-icons </B><I>images</I></A><DD>
2058 Specifies images for the entry's icon.
2059 <I>Images</I> is a list of two Tk images:
2060 the first image is displayed when the node is open, the
2061 second when it is closed.
2062 <P><DT><A NAME="M274"><B>-imagecmd </B><I>scriptcmd</I></A><DD>
2063 Specifies a command to call the first time an image is displayed.
2064 This handles all images used in any of the <B>-images</B>, <B>-*icon</B>,
2065 and <B>-*icons</B> options.
2066 Percent substitutions is performed on <I>scriptcmd</I> as per <I>find -exec</I>,
2067 with the image name being used as the value (%V).
2068 The main use of <B>-imagecmd</B> is to defer loading images
2069 until they become visible for the first time. Typically this means
2070 icons options are set with blank images which as they become visible
2071 the callback replaces with a real image.
2072 <P><DT><A NAME="M275"><B>-inlinedata </B><I>bool</I></A><DD>
2073 Enables that data column values that start with a <B>@</B> and are
2074 a list of length 2, are to be interpreted as
2075 an inline style or image name.
2076 If value is the name of an image, a style is created
2077 using the name of image with -icon set to that image.
2078 A style is applied to the cell in the manner of <B>style set</B>.
2079 Default is <I>true</I>.
2080 <P><DT><A NAME="M276"><B>-insertfirst</B><I>num</I></A><DD>
2081 Upon inserts use forward search of tree label for num elements,
2082 then fall back to a reverse search. The default is 1,
2083 which provides for very fast insertions
2084 at the begining or near the end of really long trees.
2085 Set to -1 for forward search only, for example, if using <I>-allowduplicates</I>.
2086 <P><DT><A NAME="M277"><B>-leaficons </B><I>images</I></A><DD>
2087 Specifies images for a leaf entry's icons.
2088 <I>Images</I> is a list of two Tk images:
2089 the first image is displayed when the node is open, the
2090 second when it is closed.
2091 <P><DT><A NAME="M278"><B>-levelpad </B><I>pixels</I></A><DD>
2092 Indentation to add when displaying sub-tree levels.
2093 <P><DT><A NAME="M279"><B>-levelstyles </B><I>stylenames</I></A><DD>
2094 Set a list of styles to use for entries at a given level.
2095 The first style is used for entries at level 1, the second for level 2, etc.
2096 This provides a simple way
2097 to specify colors for entries at a given level without explicitly
2098 setting entry options.
2099 <P><DT><A NAME="M280"><B>-linecolor </B><I>color</I></A><DD>
2100 Sets the color of the connecting lines drawn between entries.
2101 The default is <B>black</B>.
2102 <P><DT><A NAME="M281"><B>-linespacing </B><I>pixels</I></A><DD>
2103 Sets the number of pixels spacing between entries.
2104 The default is <B>0</B>.
2105 <P><DT><A NAME="M282"><B>-linewidth </B><I>pixels</I></A><DD>
2106 Set the width of the lines drawn connecting entries. If <I>pixels</I>
2107 is <B>0</B>, no vertical or horizontal lines are drawn.
2108 The default is <B>1</B>.
2109 <P><DT><A NAME="M283"><B>-minheight </B><I>pixels</I></A><DD>
2110 Set the minimum height for entries. Default is <I>0</I>.
2111 <P><DT><A NAME="M284"><B>-nextauto</B><I>num</I></A><DD>
2112 For inserts at the root node, the start number for the next #auto insert.
2113 This is automatically incremented at each insert which
2114 speeds up bulk #auto inserts.
2115 <P><DT><A NAME="M285"><B>-nextsubauto</B><I>num</I></A><DD>
2116 For inserts not into the root node, the number
2117 the next child #auto insert starts it's search from.
2118 The default is <B>1</B>.
2119 <P><DT><A NAME="M286"><B>-newtags </B><I>boolean</I></A><DD>
2120 If <I>boolean</I> is true, when sharing a tree object (see the
2121 <B>-tree</B> option), don't share its tags too.
2122 The default is <B>0</B>.
2123 <P><DT><A NAME="M287"><B>-noautocloseleaf </B><I>boolean</I></A><DD>
2124 If <I>boolean</I> is true, then opening a leaf node will leave it in
2125 open mode. The default is <B>false</B>, which automatically sets the
2126 mode of a leaf node back to closed without invoking <B>-closecommand</B>.
2127 <P><DT><A NAME="M288"><B>-nofocusselectbackground </B><I>color</I></A><DD>
2128 Background select color when focus lost.
2129 <P><DT><A NAME="M289"><B>-nofocusselectforeground </B><I>color</I></A><DD>
2130 Foreground select color when focus lost.
2131 <P><DT><A NAME="M290"><B>-openanchor </B><I>string</I></A><DD>
2132 When a node with children is opened, defines the -anchor used
2133 to the see sub-command. Must be one of: <B>n c s</B>.
2134 The default is <B>c</B>.
2135 <P><DT><A NAME="M291"><B>-opencommand </B><I>string</I></A><DD>
2136 Specifies a Tcl script to be invoked when a node is open.
2137 You can override this for individual entries with the entry's
2138 <B>-opencommand</B> configuration option. The default is <B>""</B>.
2139 Percent substitutions are performed on <I>string</I> before
2140 it is executed. The following substitutions are valid:
2142 <DL class="treeview options">
2143 <DT><A NAME="M292"><B>%W</B></A><DD>
2144 The pathname of the widget.
2145 <P><DT><A NAME="M293"><B>%p</B></A><DD>
2146 The name of the node.
2147 <P><DT><A NAME="M294"><B>%P</B></A><DD>
2148 The full pathname of the node.
2149 <P><DT><A NAME="M295"><B>%#</B></A><DD>
2151 <P><DT><A NAME="M296"><B>%%</B></A><DD>
2152 Translates to a single percent.
2154 <P><DT><A NAME="M297"><B>-relief </B><I>relief</I></A><DD>
2155 Specifies the 3-D effect for the widget. <I>Relief</I>
2156 specifies how the <B>treeview</B> widget should appear relative to widget
2157 it is packed into; for example, <B>raised</B> means the <B>treeview</B> widget
2158 should appear to protrude. The default is <B>sunken</B>.
2159 <P><DT><A NAME="M298"><B>-resizecursor </B><I>string</I></A><DD>
2160 Cursor to use on resize.
2161 <P><DT><A NAME="M299"><B>-rootnode </B><I>num</I></A><DD>
2162 Specifiy the node number that is to be the root.
2163 This allows a subtree to appear as the root.
2164 Multiple treeviews may share a tree with different root nodes,
2165 and thus supporting subviews. Default is 0.
2166 <P><DT><A NAME="M300"><B>-scrollmode </B><I>mode</I></A><DD>
2167 Specifies the style of scrolling to be used.
2168 There are three different modes of scrolling: <B><A HREF="../TkCmd/listbox.htm">listbox</A></B>,
2169 <B><A HREF="../TkCmd/canvas.htm">canvas</A></B>, and <B>hierbox</B>. In <B><A HREF="../TkCmd/listbox.htm">listbox</A></B> mode, the last
2170 entry can always be scrolled to the top of the widget. In <B>hierbox</B>
2171 mode, the last entry is always drawn at the bottom of the widget.
2172 The default is <B>hierbox</B>.
2174 <DL class="treeview options">
2175 <DT><A NAME="M301"><B>listbox</B></A><DD>
2176 Like the <B><A HREF="../TkCmd/listbox.htm">listbox</A></B> widget, the last entry can always be
2177 scrolled to the top of the widget window. This allows the scrollbar
2178 thumb to shrink as the last entry is scrolled upward.
2179 <P><DT><A NAME="M302"><B>hierbox</B></A><DD>
2180 Like the <B>hierbox</B> widget, the last entry can only be
2181 viewed at the bottom of the widget window. The scrollbar
2182 stays a constant size.
2183 <P><DT><A NAME="M303"><B>canvas</B></A><DD>
2184 Like the <B><A HREF="../TkCmd/canvas.htm">canvas</A></B> widget, the entries are bound within
2187 <P><DT><A NAME="M304"><B>-scrolltile </B><I>bool</I></A><DD>
2188 Specifies if tiling should scroll with widget.
2189 The default is <B>false</B>.
2190 <P><DT><A NAME="M305"><B>-selectbackground </B><I>color</I></A><DD>
2191 Sets the background color selected node entries.
2192 The default is <B>#ffffea</B>.
2193 <P><DT><A NAME="M306"><B>-selectborderwidth </B><I>pixels</I></A><DD>
2194 Sets the width of the raised 3-D border drawn around the labels
2195 of selected entries. The default is <B>0</B>.
2196 <P><DT><A NAME="M307"><B>-selectcommand </B><I>string</I></A><DD>
2197 Specifies a Tcl script to invoked when the set of selected
2199 The default is <B>""</B>.
2200 <P><DT><A NAME="M308"><B>-selectforeground</B> <I>color</I>\fB</A><DD>
2201 Sets the color of the labels of selected node entries while the
2203 The default is <B>black</B>.
2204 <P><DT><A NAME="M309"><B>-selectmode </B><I>mode</I></A><DD>
2205 Specifies the selection mode. If <I>mode</I> is
2206 <B>single</B>, only one node can be selected
2207 at a time. If <B>multiple</B> more than one
2208 node can be selected.
2209 If <B>none</B> no selection is displayed.
2210 If <I>cell</I> or <I>multicell</I> then selection is for cells
2211 rather than whole nodes (rows).
2212 The default is <B>single</B>.
2213 <P><DT><A NAME="M310"><B>-selectrelief </B><I>relief</I></A><DD>
2214 Specifies the 3-D effect of the selected text in the edit window.
2215 <I>Relief</I> indicates how the text should appear relative to the edit
2216 window; for example, <B>raised</B> means the text should
2217 appear to protrude. The default is <B>flat</B>.
2218 <P><DT><A NAME="M311"><B>-selecttile </B><I>image</I></A><DD>
2219 Set a tile background image to use for selection.
2220 <P><DT><A NAME="M312"><B>-separator </B><I>string</I></A><DD>
2221 Specifies the character sequence to use when spliting the path components.
2222 The separator may be several characters wide (such as "::")
2223 Consecutive separators in a pathname are treated as one.
2224 If <I>string</I> is the empty string, the pathnames are Tcl lists.
2225 If <I>string</I> is the <B>none</B>, no splitting will is done.
2226 Each element is a path component. The default is <B>""</B>.
2227 <P><DT><A NAME="M313"><B>-showfull </B><I>boolean</I></A><DD>
2228 Show full path name when in <B>-flat</B> mode.
2229 The default is <I>true</I>.
2230 <P><DT><A NAME="M314"><B>-showtitles </B><I>boolean</I></A><DD>
2231 If <I>boolean</I> is false, column titles are not be displayed.
2232 The default is <B>yes</B>.
2233 <P><DT><A NAME="M315"><B>-sortselection </B><I>boolean</I></A><DD>
2234 If <I>boolean</I> is true, nodes in the selection are ordered as they
2235 are currently displayed (depth-first or sorted), not in the order
2236 they were selected. The default is <B>no</B>.
2237 <P><DT><A NAME="M316"><B>-stylecommand </B><I>string</I></A><DD>
2238 Specifies a Tcl command to call when handling
2240 a <I>@style string</I>.
2241 The called command is expected to create
2243 This overrides the default behavior of creating a style with
2244 the same name as the image passed after the @ sign
2245 (see the <I>-inlinedata</I> option).
2246 The call performs the same substitutions as <I>-exec</I> option of
2247 the <B>find</B> command.
2248 <P><DT><A NAME="M317"><B>-substyle </B><I>stylename</I></A><DD>
2249 Set a style for use with the <B>-sublabel</B>.
2250 Note: you can hide all <I>sublabels</I> by using a style
2251 with the <B>-hide</B> option set.
2252 <P><DT><A NAME="M318"><B>-takefocus</B> <I>focus</I></A><DD>
2253 Provides information used when moving the focus from window to window
2254 via keyboard traversal (e.g., Tab and Shift-Tab). If <I>focus</I> is
2255 <B>0</B>, this means that this window should be skipped entirely during
2256 keyboard traversal. <B>1</B> means that the this window should always
2257 receive the input focus. An empty value means that the traversal
2258 scripts make the decision whether to focus on the window.
2259 The default is <B>"1"</B>.
2260 <P><DT><A NAME="M319"><B>-tile </B><I>image</I></A><DD>
2261 Set background tile image.
2262 <P><DT><A NAME="M320"><B>-titlefont </B><I>font</I></A><DD>
2263 Font to use for titles.
2264 <P><DT><A NAME="M321"><B>-titlepad </B><I>N</I></A><DD>
2265 Pad to add above and below title.
2266 <P><DT><A NAME="M322"><B>-tree </B><I>tree</I></A><DD>
2267 Use an externally created data <I>tree</I> object.
2268 Using a <B><A HREF="../TclCmd/tree.htm">tree</A></B> command facilitates data access, tracing, and
2270 <PRE>set t [tree create]
2272 while {[incr n]<30000} {
2273 $t insert end -data {A 0 B 0}
2275 pack [treeview .tv -tree $t]
2276 .tv column insert end A B</PRE>
2277 <P><DT><A NAME="M323"><B>-trim </B><I>string</I></A><DD>
2278 Specifies a string leading characters to trim from entry pathnames
2279 before parsing. This only makes sense if the <B>-separator</B> is also
2280 set. The default is <B>""</B>.
2281 <P><DT><A NAME="M324"><B>-underline </B><I>height</I></A><DD>
2282 Draw an underline of the given height below each entry across its entire width.
2283 Use in conjunction with column reliefs this provides a grid like effect.
2284 The default height is 0.
2285 <P><DT><A NAME="M325"><B>-width </B><I>pixels</I></A><DD>
2286 Sets the requested width of the widget. If <I>pixels</I> is 0, then
2287 the with is computed from the contents of the <B>treeview</B> widget.
2288 The default is <B>200</B>.
2289 <P><DT><A NAME="M326"><B>-xscrollcommand </B><I>string</I></A><DD>
2290 Specifies the prefix for a command used to communicate with horizontal
2291 scrollbars. Whenever the horizontal view in the widget's window
2292 changes, the widget will generate a Tcl command by concatenating the
2293 scroll command and two numbers. If this option is not specified, then
2294 no command will be executed.
2295 <P><DT><A NAME="M327"><B>-xscrollincrement</B> <I>pixels</I></A><DD>
2296 Sets the horizontal scrolling distance. The default is 20 pixels.
2297 <P><DT><A NAME="M328"><B>-yscrollcommand </B><I>string</I></A><DD>
2298 Specifies the prefix for a command used to communicate with vertical
2299 scrollbars. Whenever the vertical view in the widget's window
2300 changes, the widget will generate a Tcl command by concatenating the
2301 scroll command and two numbers. If this option is not specified, then
2302 no command will be executed.
2303 <P><DT><A NAME="M329"><B>-yscrollincrement</B> <I>pixels</I></A><DD>
2304 Sets the vertical scrolling distance. The default is 20 pixels.
2306 <H3><A NAME="M330">ENTRY OPTIONS</A></H3>
2307 Many widget configuration options have counterparts in entries. For
2308 example, there is a <B>-closecommand</B> configuration option for both
2309 widget itself and for individual entries. Options set at the widget
2310 level are global for all entries. If the entry configuration option
2311 is set, then it overrides the widget option. This is done to avoid
2312 wasting memory by replicated options. Most entries will have
2315 There is no resource class or name for entries.
2317 <DL class="entry options">
2318 <DT><A NAME="M331"><B>-activeicons </B><I>images</I></A><DD>
2319 Specifies images to be displayed as the entry's icon
2320 when it is active. This overrides the global <B>-activeicons</B>
2321 configuration option for the specific entry.
2322 <I>Images</I> is a list of two Tk images:
2323 the first image is displayed when the node is open, the
2324 second when it is closed.
2325 <P><DT><A NAME="M332"><B>-bindtags </B><I>tagList</I></A><DD>
2326 Specifies the binding tags for nodes. <I>TagList</I> is a list
2327 of binding tag names. The tags and their order will determine how
2328 events are handled for nodes. Each tag in the list matching the current
2329 event sequence will have its Tcl command executed. The default value
2331 <P><DT><A NAME="M333"><B>-button </B><I>string</I></A><DD>
2332 Indicates whether a button should be displayed on the left side
2333 of the node entry. <I>String</I> can be <B>yes</B>, <B>no</B>,
2334 or <B>auto</B>. If <B>auto</B>, then a button is automatically
2335 displayed if the node has children. This is the default.
2336 <P><DT><A NAME="M334"><B>-closecommand </B><I>string</I></A><DD>
2337 Specifies a Tcl script to be invoked when the node is closed. This
2338 overrides the global <B>-closecommand</B> option for this entry.
2339 The default is <B>""</B>.
2340 Percent substitutions are performed on <I>string</I> before
2341 it is executed. The following substitutions are valid:
2343 <DL class="entry options">
2344 <DT><A NAME="M335"><B>%W</B></A><DD>
2345 The pathname of the widget.
2346 <P><DT><A NAME="M336"><B>%p</B></A><DD>
2347 The name of the node.
2348 <P><DT><A NAME="M337"><B>%P</B></A><DD>
2349 The full pathname of the node.
2350 <P><DT><A NAME="M338"><B>%#</B></A><DD>
2352 <P><DT><A NAME="M339"><B>%%</B></A><DD>
2353 Translates to a single percent.
2355 <P><DT><A NAME="M340"><B>-data </B><I>list</I></A><DD>
2356 Initializes or change data fields for the node. <I>List</I> is a list of
2357 name-value pairs to be set. Note, this can not be used to unset or
2358 forget values for columns, meaning an empty list does nothing.
2359 For unsetting use <B>entry unset</B>.
2360 The default is <B>""</B>.
2361 <P><DT><A NAME="M341"><B>-font </B><I>fontName</I></A><DD>
2362 Sets the font for entry labels. This overrides the widget's
2363 <B>-font</B> option for this node. The default is
2364 <B>*-Helvetica-Bold-R-Normal-*-12-120-*</B>.
2365 <P><DT><A NAME="M342"><B>-forcetree </B><I>bool</I></A><DD>
2366 Force node to be treated as a tree, even if it has no children.
2367 This differs from <I>-button</I> above in that all drawing
2368 and querying aspects of the node are treated as a tree.
2369 This option is useful primarily for deferring loading until a tree is opened.
2370 The default is <B>false</B>.
2371 <P><DT><A NAME="M343"><B>-foreground </B><I>color</I></A><DD>
2372 Sets the text color of the entry label. This overrides the widget's
2373 <B>-foreground</B> configuration option. The default is <B>""</B>.
2374 <P><DT><A NAME="M344"><B>-height </B><I>num</I></A><DD>
2375 Set height for entry.
2376 <P><DT><A NAME="M345"><B>-hide </B><I>bool</I></A><DD>
2378 <P><DT><A NAME="M346"><B>-icons </B><I>images</I></A><DD>
2379 Specifies images to be displayed for the entry's icon.
2380 This overrides the global <B>-icons</B> configuration option.
2381 <I>Images</I> is a list of two Tk images:
2382 the first image is displayed when the node is open, the
2383 second when it is closed.
2384 <P><DT><A NAME="M347"><B>-label </B><I>string</I></A><DD>
2385 Sets the text for the entry's displayed label.
2386 If set to <B>""</B>, the label of the tree node is displayed
2387 The default is <B>""</B> (see <B>entry relabel</B>).
2388 <P><DT><A NAME="M348"><B>-opencommand </B><I>string</I></A><DD>
2389 Specifies a Tcl script to be invoked when the entry is opened.
2390 This overrides the widget's <B>-opencommand</B> option for this node.
2391 The default is <B>""</B>.
2392 Percent substitutions are performed on <I>string</I> before
2393 it is executed. The following substitutions are valid:
2395 <DL class="entry options">
2396 <DT><A NAME="M349"><B>%W</B></A><DD>
2397 The pathname of the widget.
2398 <P><DT><A NAME="M350"><B>%p</B></A><DD>
2399 The name of the node.
2400 <P><DT><A NAME="M351"><B>%P</B></A><DD>
2401 The full pathname of the node.
2402 <P><DT><A NAME="M352"><B>%#</B></A><DD>
2404 <P><DT><A NAME="M353"><B>%%</B></A><DD>
2405 Translates to a single percent.
2407 <P><DT><A NAME="M354"><B>-shadow </B><I>color</I></A><DD>
2408 Set shadow color for text.
2409 <P><DT><A NAME="M355"><B>-state </B><I>value</I></A><DD>
2410 Set the state of the entry where <I>value</I> is one of:
2411 <B>normal</B>, <B>active</B>, <B>disabled</B>.
2412 The default state is <B>normal</B>.
2413 When the state is set to <B>disabled</B>, the text color
2414 displays using <B>-disabledforeground</B> and the
2415 node ignores any attempted <B><A HREF="../TclCmd/open.htm">open</A></B> or <B><A HREF="../TclCmd/close.htm">close</A></B>.
2416 <P><DT><A NAME="M356"><B>-style </B><I>stylename</I></A><DD>
2417 Set the style to use for the entry. This will override the column
2418 style, just as <I>style set</I> will override an entry style.
2419 This is useful mostly for seting bg/fg/font
2420 for a row. Other options may or may not do nothing.
2421 Note, setting icon in a style will apply to all value
2422 columns, but not the tree column.
2423 <P><DT><A NAME="M357"><B>-sublabel </B><I>string</I></A><DD>
2424 Sets the text for the entry's sub-label to be displayed to the right
2425 of the nodes <B>-label</B> value. This is rendered using the
2426 <B>-substyle</B> style.
2427 <P><DT><A NAME="M358"><B>-underline </B><I>num</I></A><DD>
2428 Character to underline in an entries text label. Default is -1.
2429 <P><DT><A NAME="M359"><B>-userdata </B><I>list</I></A><DD>
2430 Extra space available for storing user data.
2432 <H3><A NAME="M360">BUTTON OPTIONS</A></H3>
2433 Button configuration options may also be set by the <B><A HREF="../TkCmd/option.htm">option</A></B> command.
2434 The resource subclass is <B><A HREF="../TkCmd/button.htm">Button</A></B>. The resource name is always
2435 <B><A HREF="../TkCmd/button.htm">button</A></B>.
2436 <PRE>option add *TreeView.Button.Foreground white
2437 option add *TreeView.button.Background blue</PRE>
2438 The following are the configuration options available for buttons.
2440 <DL class="button options">
2441 <DT><A NAME="M361"><B>-activebackground </B><I>color</I></A><DD>
2442 Sets the background color of active buttons. A button
2443 is made active when the mouse passes over it or by the
2444 <B>button activate</B> operation.
2445 <P><DT><A NAME="M362"><B>-activeforeground </B><I>color</I></A><DD>
2446 Sets the foreground color of active buttons. A button
2447 is made active when the mouse passes over it or by the
2448 <B>button activate</B> operation.
2449 <P><DT><A NAME="M363"><B>-background </B><I>color</I></A><DD>
2450 Sets the background of the button. The default is <B>white</B>.
2451 <P><DT><A NAME="M364"><B>-borderwidth </B><I>pixels</I></A><DD>
2452 Sets the width of the 3-D border around the button.
2453 The <B>-relief</B> option determines if a border is to be drawn. The
2454 default is <B>1</B>.
2455 <P><DT><A NAME="M365"><B>-closerelief </B><I>relief</I></A><DD>
2456 Specifies the 3-D effect for the closed button. <I>Relief</I>
2457 indicates how the button should appear relative to the widget;
2458 for example, <B>raised</B> means the button should
2459 appear to protrude. The default is <B>solid</B>.
2460 <P><DT><A NAME="M366"><B>-cursor </B><I>cursor</I></A><DD>
2461 Sets the widget's cursor. The default cursor is <B>""</B>.
2462 <P><DT><A NAME="M367"><B>-foreground </B><I>color</I></A><DD>
2463 Sets the foreground color of buttons.
2464 The default is <B>black</B>.
2465 <P><DT><A NAME="M368"><B>-images </B><I>images</I></A><DD>
2466 Specifies images to be displayed for the button.
2467 <I>Images</I> is a list of two Tk images:
2468 the first image is displayed when the button is open, the
2469 second when it is closed. If the <I>images</I> is the empty string,
2470 then a plus/minus gadget is drawn. The default is <B>""</B>.
2471 <P><DT><A NAME="M369"><B>-openrelief </B><I>relief</I></A><DD>
2472 Specifies the 3-D effect of the open button. <I>Relief</I>
2473 indicates how the button should appear relative to the widget;
2474 for example, <B>raised</B> means the button should
2475 appear to protrude. The default is <B>flat</B>.
2476 <P><DT><A NAME="M370"><B>-size </B><I>pixels</I></A><DD>
2477 Sets the requested size of the button.
2478 The default is <B>0</B>.
2480 <H3><A NAME="M371">STYLE OPTIONS</A></H3>
2481 Five types of styles are defined: <B>textbox, combobox, checkbox, barbox, windowbox</B>.
2482 A <B>barbox</B> provides a progressbar for the values of cells,
2483 and accepts any data that begins with a numeric (eg. "34%").
2484 The special style <B>windowbox</B> supports embedded subwindows within data
2487 The resource subclass is the name of the style, titlized, ie.
2488 <PRE>option add *TreeView.TextBoxStyle.tvBackground white
2489 option add *TreeView.ComboBoxStyle.tvBackground green
2490 option add *TreeView.CheckBoxStyle.tvBackground blue</PRE>
2491 A default textbox style <I>text</I> comes predefined and is set for
2492 each columns <I>-style</I> option.
2493 Styles may also be associated with
2494 entry-rows and/or cells, as follows:
2496 <PRE>treeview .t -width 300 -height 200
2497 pack .t -fill both -expand y
2498 .t col insert end Size Age Weight
2499 .t style create combobox MyStyle0 -bg red
2500 .t style create textbox MyStyle1 -bg blue
2501 .t style create textbox MyStyle2 -bg green
2502 .t style create textbox MyStyle3 -bg orange
2504 .t col conf Size -style MyStyle0
2505 foreach i {Able Baker Charlie} {
2506 .t insert end $i -data {Size 1 Age 2 Weight 3}
2508 .t entry conf 2 -style MyStyle2
2509 .t style set MyStyle3 Weight 3
2511 .t conf -emptystyle MyStyle1</PRE>
2513 See also the widget options <I>-altstyle</I>, <I>-emptystyle</I> and <I>-levelstyles</I>.
2514 The following are available for all but the windowbox type.
2515 Note, some of these options are utilized only in particular contexts:
2517 <DL class="style options">
2518 <DT><A NAME="M372"><B>-activebackground </B><I>color</I></A><DD>
2519 Specifies the active background color of a style.
2520 Alias is <B>-activebg</B>.
2521 <P><DT><A NAME="M373"><B>-activeforeground </B><I>color</I></A><DD>
2522 Specifies the active foreground color of a style.
2523 Alias is <B>-activefg</B>.
2524 <P><DT><A NAME="M374"><B>-background </B><I>color</I></A><DD>
2525 Background color override. Default is empty.
2526 <P><DT><A NAME="M375"><B>-cursor </B><I>cursorname</I></A><DD>
2527 Specifies the cursor of a style. This cursor for the widget when an
2528 element is activated.
2529 <P><DT><A NAME="M376"><B>-font </B><I>fontName</I></A><DD>
2530 Sets the font for a style.
2531 <P><DT><A NAME="M377"><B>-foreground </B><I>color</I></A><DD>
2532 Specifies the foreground color of a style.
2533 Alias is <B>-fg</B>.
2534 <P><DT><A NAME="M378"><B>-gap </B><I>N</I></A><DD>
2536 <P><DT><A NAME="M379"><B>-hide </B><I>bool</I></A><DD>
2537 Values or subtext having a style with hide on are to be hidden.
2538 Columns and entries are unaffected.
2539 <P><DT><A NAME="M380"><B>-highlightbackground </B><I>color</I></A><DD>
2540 Specifies the highlight background color of a style.
2541 Alias is <B>-highlightbg</B>.
2542 <P><DT><A NAME="M381"><B>-highlightforeground </B><I>color</I></A><DD>
2543 Specifies the highlight foreground color of a style.
2544 Alias is <B>-highlightfg</B>.
2545 <P><DT><A NAME="M382"><B>-icon </B><I>name</I></A><DD>
2547 <P><DT><A NAME="M383"><B>-priority</B> <I>N</I></A><DD>
2548 Specifies a priority for the style. Higher priorities
2549 are used for overriding bg/fg/font. The default 0.
2550 <P><DT><A NAME="M384"><B>-shadow </B><I>shadow</I></A><DD>
2552 <P><DT><A NAME="M385"><B>-tile </B><I>img</I></A><DD>
2554 <P><DT><A NAME="M386">The following additional configuration options are available for textbox:</A><DD>
2555 <P><DT><A NAME="M387"><B>-formatcmd </B><I>scriptcmd</I></A><DD>
2556 Command called to format the displayed key-data value.
2557 Percent substitutions are performed on <I>scriptcmd</I> as per <I>find -exec</I>.
2558 The called command returns the value to be displayed.
2559 <P><DT><A NAME="M388"><B>-iconside </B><I>N</I></A><DD>
2560 Specifies which side of the text the icon is placed. Default is left.
2561 <P><DT><A NAME="M389"><B>-side </B><I>N</I></A><DD>
2562 Specifies which side of cell to anchor contents. Default is top.
2563 <P><DT><A NAME="M390">The following additional configuration options are available for combobox:</A><DD>
2564 <P><DT><A NAME="M391"><B>-borderwidth </B><I>pixel</I></A><DD>
2566 <P><DT><A NAME="M392"><B>-buttonborderwidth </B><I>pixel</I></A><DD>
2567 Size of buttons border
2568 <P><DT><A NAME="M393"><B>-buttonrelief </B><I>relief</I></A><DD>
2570 <P><DT><A NAME="M394"><B>-choicecmd </B><I>cmd</I></A><DD>
2571 Command called to get the list of choices for editing,
2572 after the following substitutions: <B>%X %Y %C %# %W %%</B>.
2573 Used by the library proc <I>blt::tv::EditCell</I> which
2574 implements builtin editing.
2575 <P><DT><A NAME="M395"><B>-choices </B><I>lst</I></A><DD>
2576 A list of choices for editing.
2577 <P><DT><A NAME="M396">The following additional configuration options are available for checkbox:</A><DD>
2578 <P><DT><A NAME="M397"><B>-boxcolor </B><I>color</I></A><DD>
2580 <P><DT><A NAME="M398"><B>-boxsize </B><I>num</I></A><DD>
2582 <P><DT><A NAME="M399"><B>-checkcolor </B><I>color</I></A><DD>
2584 <P><DT><A NAME="M400"><B>-fillcolor </B><I>color</I></A><DD>
2586 <P><DT><A NAME="M401"><B>-linewidth </B><I>num</I></A><DD>
2588 <P><DT><A NAME="M402"><B>-offvalue </B><I>val</I></A><DD>
2589 Value representing off.
2590 <P><DT><A NAME="M403"><B>-onvalue </B><I>val</I></A><DD>
2591 Value representing on.
2592 <P><DT><A NAME="M404"><B>-showvalue </B><I>bool</I></A><DD>
2593 Show value as well..
2594 <P><DT><A NAME="M405">The following additional configuration options are available for barbox:</A><DD>
2595 <P><DT><A NAME="M406"><B>-barbg </B><I>color</I></A><DD>
2596 Color for the background of the bar.
2597 Default is the empty string.
2598 <P><DT><A NAME="M407"><B>-boxcolor </B><I>color</I></A><DD>
2599 Color of box around bar.
2600 <P><DT><A NAME="M408"><B>-barfg </B><I>color</I></A><DD>
2601 Color for the foreground of the bar.
2603 <P><DT><A NAME="M409"><B>-barheight </B><I>num</I></A><DD>
2604 Height of bar. Default 10.
2605 <P><DT><A NAME="M410"><B>-barwidth </B><I>num</I></A><DD>
2606 Width of bar. Default 80.
2607 <P><DT><A NAME="M411"><B>-filltile </B><I>tile</I></A><DD>
2608 Image to tile-fill bar with.
2609 <P><DT><A NAME="M412"><B>-formatcmd </B><I>scriptcmd</I></A><DD>
2610 Command called to format the displayed value.
2611 Percent substitutions are performed on <I>scriptcmd</I> as per <I>find -exec</I>.
2612 The called command returns the value to be displayed.
2613 <P><DT><A NAME="M413"><B>-linewidth </B><I>num</I></A><DD>
2614 Width of border around the bar. Default is 1.
2615 <P><DT><A NAME="M414"><B>-maxvalue </B><I>val</I></A><DD>
2616 The maxiumum value. Default is 100.0.
2617 <P><DT><A NAME="M415"><B>-minvalue </B><I>val</I></A><DD>
2618 The miniumum value. Default is 0.0.
2619 <P><DT><A NAME="M416"><B>-showvalue </B><I>bool</I></A><DD>
2620 Show the numeric value.
2621 <P><DT><A NAME="M417">Only the following configuration options are available with windowbox:</A><DD>
2622 <P><DT><A NAME="M418"><B>-minheight </B><I>num</I></A><DD>
2623 Minimum height of window.
2624 Window height will be taller if the
2625 the entry height is greater than num.
2627 <P><DT><A NAME="M419"><B>-minwidth </B><I>num</I></A><DD>
2628 Minimum width of window. Window width will be wider if the
2629 the column width is greater than num.
2631 <P><DT><A NAME="M420"><B>-windowcmd </B><I>string</I></A><DD>
2632 Command invoked to return window path. The default is an empty string,
2633 which means data in the cell contains the pathname of a widget to use.
2634 Percent substitutions are performed on <I>string</I> before
2635 it is executed. The following substitutions are valid:
2637 <DL class="style options">
2638 <DT><A NAME="M421"><B>%W</B></A><DD>
2639 The pathname of the widget.
2640 <P><DT><A NAME="M422"><B>%p</B></A><DD>
2641 The name of the node.
2642 <P><DT><A NAME="M423"><B>%P</B></A><DD>
2643 The full pathname of the node.
2644 <P><DT><A NAME="M424"><B>%#</B></A><DD>
2646 <P><DT><A NAME="M425"><B>%C</B></A><DD>
2647 The column identifier.
2648 <P><DT><A NAME="M426"><B>%%</B></A><DD>
2649 Translates to a single percent.
2652 <H3><A NAME="M427">COLUMN OPTIONS</A></H3>
2653 Column configuration options may also be set by the <B><A HREF="../TkCmd/option.htm">option</A></B> command.
2654 The resource subclass is <B>Column</B>. The resource name is the
2656 <PRE>option add *TreeView.Column.Foreground white
2657 option add *TreeView.treeView.Background blue</PRE>
2658 The following configuration options are available for columns.
2660 <DL class="column options">
2661 <DT><A NAME="M428"><B>-activetitlebackground </B><I>color</I></A><DD>
2662 Active title background color.
2663 <P><DT><A NAME="M429"><B>-activetitleforeground </B><I>color</I></A><DD>
2664 Active title foreground color.
2665 <P><DT><A NAME="M430"><B>-autowidth </B><I>value</I></A><DD>
2666 If the maximum width of a column exceeds the given
2667 value, then the column width uses this value instead <B>-width</B>.
2668 When value is zero or <B>-width</B> is non-zero, has no effect.
2669 Allows setting a default column width limit, while still
2670 permitting the user to manually resize larger (unlike <B>-max</B>).
2671 The default value is 0.
2672 <P><DT><A NAME="M431"><B>-background </B><I>color</I></A><DD>
2673 Sets the background color of the column. This overrides
2674 the widget's <B>-background</B> option. The default is <B>white</B>.
2675 <P><DT><A NAME="M432"><B>-bindtags </B><I>string</I></A><DD>
2676 Set binding tags for column.
2677 <P><DT><A NAME="M433"><B>-borderwidth </B><I>pixels</I></A><DD>
2678 Sets the width of the 3-D border of the column.
2679 The <B>-relief</B> option determines if a border is to be drawn. The
2680 default is <B>0</B>.
2681 <P><DT><A NAME="M434"><B>-colorpattern </B><I>patcolors</I></A><DD>
2682 Alter foreground color based on a string match against the cell data value.
2683 Pattern/color pairs are specified in <I>patcolors</I>.
2684 If the pattern matches, then color becomes the foreground
2686 This provides a low-overhead way to display different colors
2687 depending only on the form of data.
2688 <P><DT><A NAME="M435"><B>-colorregexp </B><I>patcolors</I></A><DD>
2689 Does the same thing as <B>-colorpattern</B>, except uses
2690 regexp instead, and has a lower priority.
2691 <P><DT><A NAME="M436"><B>-command </B><I>string</I></A><DD>
2692 Set command for use by <B>invoke</B>. This is called everytime the column
2693 is selected. For example, sortable columns can
2694 be enabled by a setting this to <I>{blt::tv::SortColumn %W %C}</I>,
2695 or sort tree children of with <I>{blt::tv::SortTree %W %C}</I>.
2696 Note that SortColumn can temporarily change the treeview mode to -flat.
2697 The following substitutions are valid:
2699 <DL class="column options">
2700 <DT><A NAME="M437"><B>%W</B></A><DD>
2701 The pathname of the widget.
2702 <P><DT><A NAME="M438"><B>%C</B></A><DD>
2703 The column identifier.
2704 <P><DT><A NAME="M439"><B>%%</B></A><DD>
2705 Translates to a single percent.
2707 <P><DT><A NAME="M440"><B>-edit </B><I>num</I></A><DD>
2708 Indicates if the column's data fields can be edited
2709 via the builtin editing facility. If <I>num</I> is
2710 True the data fields in the column can be edited.
2711 The default is <B>False</B>.
2712 <P><DT><A NAME="M441"><B>-editopts </B><I>values</I></A><DD>
2713 Sub-option pair settings for the builtin text edit facilty implemented by
2714 <I>::blt::tv::EditCol</I>.
2715 By default editing uses a Tk <I>entry</I> widget.
2716 However, one using either -auto or -widget herein can modify this
2718 Following is partial documentation: see <I>::blt::tv::EditCol</I> in
2719 <I>$blt_library/treeview.tcl</I> for full details.
2721 <DL class="column options">
2722 <DT><A NAME="M442"><I>-auto bool</I></A><DD>
2723 Automatically use either an entry, spinbox or text as appropriate.
2724 The default is to use an entry widget.
2725 Text containing newlines will use a text widget.
2726 A column with combobox style where -choices or -choicecmd is set will use
2728 <P><DT><A NAME="M443"><I>-editcmd cmd</I></A><DD>
2729 Command called to get options. Called with 3 args: widget ind col.
2730 Returns name/value pairs which are
2731 additional options as accepted by <I>-editopts</I>.
2732 To indicate that a cell is non-editable, return <B>{-readonly True}</B>.
2733 <P><DT><A NAME="M444"><I>-embed bool</I></A><DD>
2734 When True the edit window is managed internally via an embedded
2735 windowbox style. When false <B><A HREF="../TkCmd/place.htm">place</A></B> is used to manage the window.
2736 The default is <I>False</I>.
2737 An embedded window has
2738 advantages but will result in a re-layout at the begin and end of editing.
2739 Note: place is always used for the tree column.
2740 <P><DT><A NAME="M445"><I>-endcmd cmd</I></A><DD>
2741 Command to call at end of edit, after the new value is set.
2742 Appends the same 5 args as <B>-validatecmd</B>, ie:
2743 <I>widget data olddata ind col</I>.
2744 <P><DT><A NAME="M446"><I>-leafs bool</I></A><DD>
2745 Limit editing to leafs only. Default is <I>false</I>.
2746 <P><DT><A NAME="M447"><I>-nottnull bool</I></A><DD>
2747 Do not edit empty fields that have not had data assigned to them.
2748 Default is <I>false</I>.
2749 <P><DT><A NAME="M448"><I>-opts values</I></A><DD>
2750 Options to pass directly to the widget..
2751 <P><DT><A NAME="M449"><I>-readonly bool</I></A><DD>
2752 Cell is readonly. Do not edit.
2753 <P><DT><A NAME="M450"><I>-sel bool</I></A><DD>
2754 Value is initially selected in edit window.
2755 Default is <I>true</I>.
2756 <P><DT><A NAME="M451"><I>-startcmd cmd</I></A><DD>
2757 Command to call at start of edit.
2758 Called with 3 args: widget ind col.
2759 <P><DT><A NAME="M452"><I>-titles bool</I></A><DD>
2760 Enable editing of the title label. Default is <I>false</I>.
2761 <P><DT><A NAME="M453"><I>-widget wid</I></A><DD>
2762 The widget to use. Builtin support types are: <I>spinbox, text, entry</I>.
2763 The default is <I>entry</I>.
2764 <P><DT><A NAME="M454"><I>-withtag tag</I></A><DD>
2765 Edit only if has tag.
2766 <P><DT><A NAME="M455"><I>-withouttag tag</I></A><DD>
2767 Edit only if does not have tag.
2768 <P><DT><A NAME="M456"><I>-wrap value</I></A><DD>
2769 Setting for wrap mode when edit window is a text widget. Default is <I>none</I>.
2771 For general editing control, bind to the <<TreeViewEditStart/End>> virtual
2773 <P><DT><A NAME="M457"><B>-fillcmd </B><I>scriptcmd</I></A><DD>
2774 Support for demand loading of data on display.
2775 Command called (after appending entry id) to set the value
2776 of a data column cell or the entry label in the case of the tree column.
2777 This call occurs only the first time a cells entry is displayed,
2778 and is called only for cells that do not have
2779 a value/label already set.
2780 If an error is raised by the called command, the value will not be set.
2781 <P><DT><A NAME="M458"><B>-hide </B><I>boolean</I></A><DD>
2782 If <I>boolean</I> is true, the column is not displayed.
2783 The default is <B>no</B>.
2784 <P><DT><A NAME="M459"><B>-justify </B><I>justify</I></A><DD>
2785 Specifies how the column data fields text should be justified within
2786 the column. This matters only when the column is wider than the
2787 data field to be display.
2788 <I>Justify</I> must be <B>left</B>, <B>right</B>, or <B>center</B>.
2789 The default is <B>center</B>.
2790 <P><DT><A NAME="M460"><B>-max </B><I>size</I></A><DD>
2791 Maximum size for column.
2792 <P><DT><A NAME="M461"><B>-min </B><I>size</I></A><DD>
2793 Minimum size for column.
2794 <P><DT><A NAME="M462"><B>-pad </B><I>pad</I></A><DD>
2795 Specifies how much padding for the left and right sides of the column.
2796 <I>Pad</I> is a list of one or two screen distances. If <I>pad</I>
2797 has two elements, the left side of the column is padded by the first
2798 distance and the right side by the second. If <I>pad</I> has just one
2799 distance, both the left and right sides are padded evenly. The
2800 default is <B>2</B>.
2801 <P><DT><A NAME="M463"><B>-relief </B><I>relief</I></A><DD>
2802 Specifies the 3-D effect of the column. <I>Relief</I>
2803 specifies how the column should appear relative to the widget;
2804 for example, <B>raised</B> means the column should
2805 appear to protrude. The default is <B>flat</B>.
2806 <P><DT><A NAME="M464"><B>-ruledashes </B><I>value</I></A><DD>
2807 Set resize rule is dashed.
2808 <P><DT><A NAME="M465"><B>-scrolltile </B><I>bool</I></A><DD>
2810 <P><DT><A NAME="M466"><B>-sortcommand </B><I>script</I></A><DD>
2811 Command to actually compare entries during sort.
2812 <P><DT><A NAME="M467"><B>-sortmode </B><I>mode</I></A><DD>
2813 Used by scripts to set -mode for sort command (eg. blt::tv::SortColumn).
2814 <P><DT><A NAME="M468"><B>-state </B><I>state</I></A><DD>
2815 Sets the state of the column. If <I>state</I> is <B>disable</B> then
2816 the column title can not be activated nor invoked.
2817 The default is <B>normal</B>.
2818 <P><DT><A NAME="M469"><B>-style </B><I>stylename</I></A><DD>
2819 Set the style to use for column.
2820 <P><DT><A NAME="M470"><B>-tile </B><I>image</I></A><DD>
2821 Image to tile column with.
2822 <P><DT><A NAME="M471"><B>-title </B><I>string</I></A><DD>
2823 Sets the title for the column.
2824 The default is <B>""</B>.
2825 <P><DT><A NAME="M472"><B>-titlearrow </B><I>value</I></A><DD>
2826 Forces an arrow to be drawn in the title.
2827 The <I>value</I> is one of: <B>left right up down none</B>
2828 and defaults to <B>none</B>.
2829 This is used when implementing custom sorts as the indicator.
2830 <P><DT><A NAME="M473"><B>-titlebackground </B><I>color</I></A><DD>
2831 Background for title.
2832 <P><DT><A NAME="M474"><B>-titleborderwidth </B><I>size</I></A><DD>
2834 <P><DT><A NAME="M475"><B>-titlefont </B><I>font</I></A><DD>
2835 Font for column title.
2836 <P><DT><A NAME="M476"><B>-titlejustify </B><I>just</I></A><DD>
2837 Side to place title.
2838 <P><DT><A NAME="M477"><B>-titleforeground </B><I>color</I></A><DD>
2839 Sets the foreground color of the column title.
2840 The default is <B>black</B>.
2841 <P><DT><A NAME="M478"><B>-titlerelief </B><I>relief</I></A><DD>
2843 <P><DT><A NAME="M479"><B>-titleshadow </B><I>color</I></A><DD>
2844 Sets the color of the drop shadow of the column title.
2845 The default is <B>""</B>.
2846 <P><DT><A NAME="M480"><B>-titlestyle </B><I>style</I></A><DD>
2847 A style to use for titles.
2848 <P><DT><A NAME="M481"><B>-width </B><I>num</I></A><DD>
2849 The user requested width for the column.
2850 <P><DT><A NAME="M482"><B>-underline </B><I>num</I></A><DD>
2851 Character to underline in column title text. Default is -1.
2852 <P><DT><A NAME="M483"><B>-validatecmd </B><I>command</I></A><DD>
2853 This option provides a command for validating or post processing edits
2854 from the builtin column edit feature
2855 (enabled with <I>col conf -edit 1</I>).
2856 When edit is completing, the
2857 this command string is called after appending 5 arguments:
2858 <I>window newvalue oldvalue node column</I>.
2859 The called command should return <I>newvalue</I>, possibly with modifications.
2860 To revert to the original value, just return <I>$oldvalue</I>
2861 To continue editing, use <B>return -code return</B>
2864 <DL class="column options">
2865 <DT><A NAME="M484"><B>-weight </B><I>float</I></A><DD>
2866 Weighting to apply extra space.
2867 <P><DT><A NAME="M485"><B>-width </B><I>pixels</I></A><DD>
2868 Sets the requested width of the column. This overrides
2869 the computed with of the column. If <I>pixels</I> is 0,
2870 the width is computed as from the contents of the column. The
2871 default is <B>0</B>.
2873 <H3><A NAME="M486">EMBEDDED WINDOWS</A></H3>
2874 Embedded windows is supported for data columns via the special
2875 style type <B>windowbox</B>.
2876 A windowbox style can be applied to either columns or cells.
2877 Setting a windowbox type style for an entry is silently ignored.
2878 When the cell containing a window style is displayed, the subwindow is
2879 taken over and managed as a slave (see <I>style slaves</I>).
2880 If a given windowbox style does not define <I>-windowcmd</I>, then the cell data
2881 is assumed to contain the widget name to use.
2882 If that data does not describe a valid window it is silently ignored and
2884 If multiple cells try to display the same widget at the same time,
2885 only the first one will appear.
2886 The normal rules Tk slave window rules about being a child of the parent apply.
2888 <H3><A NAME="M487">OLD TEXT EDITING OPTIONS</A></H3>
2889 <B>SECTION OBSOLETE</B>.
2891 This section is obsolete and has been replaced with builtin editing using
2892 a Tk entry widget. See <B>TREEVIEW EDITING</B> above.
2894 Text edit window configuration options may also be set by the Tk
2895 <B><A HREF="../TkCmd/option.htm">option</A></B> command. The resource class is <B>TreeViewEditor</B>.
2896 The resource name is always <B>edit</B>.
2897 <PRE>option add *TreeViewEditor.Foreground white
2898 option add *edit.Background blue</PRE>
2899 The following are the configuration options available for the
2900 text editing window.
2902 <DL class="old text editing options">
2903 <DT><A NAME="M488"><B>-background </B><I>color</I></A><DD>
2904 Sets the background of the text edit window. The default is <B>white</B>.
2905 <P><DT><A NAME="M489"><B>-borderwidth </B><I>pixels</I></A><DD>
2906 Sets the width of the 3-D border around the edit window.
2907 The <B>-relief</B> option determines if a border is to be drawn. The
2908 default is <B>1</B>.
2909 <P><DT><A NAME="M490"><B>-exportselection </B><I>boolean</I></A><DD>
2910 Indicates if the text selection is exported. If the edit window is
2911 exporting its selection then it will observe the standard X11 protocols
2912 for handling the selection. Selections are available as type <B><A HREF="../TclCmd/string.htm">STRING</A></B>.
2913 The default is <B>no</B>.
2914 <P><DT><A NAME="M491"><B>-relief </B><I>relief</I></A><DD>
2915 Specifies the 3-D effect of the edit window. <I>Relief</I>
2916 indicates how the background should appear relative to the edit
2917 window; for example, <B>raised</B> means the background should
2918 appear to protrude. The default is <B>solid</B>.
2919 <P><DT><A NAME="M492"><B>-selectbackground </B><I>color</I></A><DD>
2920 Sets the background of the selected text in the edit window.
2921 The default is <B>white</B>.
2922 <P><DT><A NAME="M493"><B>-selectborderwidth </B><I>pixels</I></A><DD>
2923 Sets the width of the 3-D border around the selected text in the
2924 edit window. The <B>-selectrelief</B> option determines if a border
2925 is to be drawn. The default is <B>1</B>.
2926 <P><DT><A NAME="M494"><B>-selectforeground </B><I>color</I></A><DD>
2927 Sets the foreground of the selected text in the edit window.
2928 The default is <B>white</B>.
2929 <P><DT><A NAME="M495"><B>-selectrelief </B><I>relief</I></A><DD>
2930 Specifies the 3-D effect of the selected text in the edit window.
2931 <I>Relief</I> indicates how the text should appear relative to the edit
2932 window; for example, <B>raised</B> means the text should
2933 appear to protrude. The default is <B>flat</B>.
2935 <H3><A NAME="M496">DEFAULT BINDINGS</A></H3>
2936 Tk automatically creates class bindings for treeviews that give them
2937 Motif-like behavior. Much of the behavior of a <B>treeview</B> widget is determined
2938 by its <B>-selectmode</B> option, which selects one of two ways
2939 of dealing with the selection.
2941 If the selection mode is <B>single</B>, only one node can be
2943 Clicking button 1 on an node selects
2944 it and deselects any other selected item.
2946 If the selection mode is <B>multiple</B>,
2947 any number of entries may be selected at once, including discontiguous
2948 ranges. Clicking Control-Button-1 on a node entry
2949 toggles its selection state without affecting any other entries.
2950 Pressing Shift-Button-1 on a node entry selects
2951 it, extends the selection.
2953 <DL class="default bindings">
2955 The virtual event <<TreeViewFocusEvent>> is generated for each
2956 keyboard and mouse initiated change in focus. It is up to
2957 the user to determine if the focus actually changed.
2959 In <B>extended</B> mode, the selected range can be adjusted by pressing
2960 button 1 with the Shift key down: this modifies the selection to
2961 consist of the entries between the anchor and the entry under
2962 the mouse, inclusive.
2963 The un-anchored end of this new selection can also be dragged with
2966 In <B>extended</B> mode, pressing button 1 with the Control key down
2967 starts a toggle operation: the anchor is set to the entry under
2968 the mouse, and its selection state is reversed. The selection state
2969 of other entries isn't changed.
2970 If the mouse is dragged with button 1 down, then the selection state
2971 of all entries between the anchor and the entry under the mouse
2972 is set to match that of the anchor entry; the selection state of
2973 all other entries remains what it was before the toggle operation
2976 If the mouse leaves the treeview window with button 1 down, the window
2977 scrolls away from the mouse, making information visible that used
2978 to be off-screen on the side of the mouse.
2979 The scrolling continues until the mouse re-enters the window, the
2980 button is released, or the end of the hierarchy is reached.
2982 Mouse button 2 may be used for scanning.
2983 If it is pressed and dragged over the <B>treeview</B> widget, the contents of
2984 the hierarchy drag at high speed in the direction the mouse moves.
2986 If the Up or Down key is pressed, the location cursor (active
2987 entry) moves up or down one entry, as does Control-p and Control-n.
2988 If the selection mode is <B>browse</B> or <B>extended</B> then the
2989 new active entry is also selected and all other entries are
2991 In <B>extended</B> mode the new active entry becomes the
2994 In <B>extended</B> mode, Shift-Up and Shift-Down move the location
2995 cursor (active entry) up or down one entry and also extend
2996 the selection to that entry in a fashion similar to dragging
2997 with mouse button 1.
2999 The Left and Right keys scroll the <B>treeview</B> widget view left and right
3000 by the width of the character <B>0</B>.
3001 Control-Left and Control-Right scroll the <B>treeview</B> widget view left and
3002 right by the width of the window.
3004 The Prior and Next keys scroll the <B>treeview</B> widget view up and down
3005 by one page (the height of the window), as does Control-u and Control-d.
3007 The Home and End keys scroll the <B>treeview</B> widget horizontally to
3008 the left and right edges, respectively.
3010 Control-Home sets the location cursor to the first entry,
3011 selects that entry, and deselects everything else
3014 Control-End sets the location cursor to the last entry,
3015 selects that entry, and deselects everything else
3018 In <B>extended</B> mode, Control-Shift-Home extends the selection
3019 to the first entry and Control-Shift-End extends
3020 the selection to the last entry.
3022 In <B>multiple</B> mode, Control-Shift-Home moves the location cursor
3023 to the first entry and Control-Shift-End moves
3024 the location cursor to the last entry.
3026 The space and Select keys make a selection at the location cursor
3027 (active entry) just as if mouse button 1 had been pressed over
3030 In <B>extended</B> mode, Control-Shift-space and Shift-Select
3031 extend the selection to the active entry just as if button 1
3032 had been pressed with the Shift key down.
3034 In <B>extended</B> mode, the Escape key cancels the most recent
3035 selection and restores all the entries in the selected range
3036 to their previous selection state.
3038 Control-slash selects everything in the widget, except in
3039 <B>single</B> and <B>browse</B> modes, in which case it selects
3040 the active entry and deselects everything else.
3042 Control-backslash deselects everything in the widget, except in
3043 <B>browse</B> mode where it has no effect.
3045 The F16 key (labelled Copy on many Sun workstations) or Meta-w
3046 copies the selection in the widget to the clipboard, if there is
3050 The behavior of <B>treeview</B> widgets can be changed by defining new bindings
3051 for individual widgets or by redefining the class bindings.
3052 <H4><A NAME="M497">WIDGET BINDINGS</A></H4>
3053 In addition to the above behavior, the following additional behavior
3054 is defined by the default widget class (TreeView) bindings.
3056 <DL class="widget bindings">
3057 <DT><A NAME="M498"><B><ButtonPress-2></B></A><DD>
3059 <P><DT><A NAME="M499"><B><B2-Motion></B></A><DD>
3061 <P><DT><A NAME="M500"><B><ButtonRelease-2></B></A><DD>
3063 <P><DT><A NAME="M501"><B><B1-Leave></B></A><DD>
3064 Starts auto-scrolling.
3065 <P><DT><A NAME="M502"><B><B1-Enter></B></A><DD>
3066 Starts auto-scrolling
3067 <P><DT><A NAME="M503"><B><KeyPress-Up></B></A><DD>
3068 Moves the focus to the previous entry.
3069 <P><DT><A NAME="M504"><B><KeyPress-Down></B></A><DD>
3070 Moves the focus to the next entry.
3071 <P><DT><A NAME="M505"><B><Shift-KeyPress-Up></B></A><DD>
3072 Moves the focus to the previous sibling.
3073 <P><DT><A NAME="M506"><B><Shift-KeyPress-Down></B></A><DD>
3074 Moves the focus to the next sibling.
3075 <P><DT><A NAME="M507"><B><KeyPress-Prior></B></A><DD>
3076 Moves the focus to first entry. Closed or hidden entries
3078 <P><DT><A NAME="M508"><B><KeyPress-Next></B></A><DD>
3079 Move the focus to the last entry. Closed or hidden entries
3081 <P><DT><A NAME="M509"><B><KeyPress-Left></B></A><DD>
3082 Closes the entry. It is not an error if the entry has no children.
3083 <P><DT><A NAME="M510"><B><KeyPress-Right></B></A><DD>
3084 Opens the entry, displaying its children. It is not an
3085 error if the entry has no children.
3086 <P><DT><A NAME="M511"><B><KeyPress-space></B></A><DD>
3087 In "single" select mode this selects the entry. In "multiple" mode,
3088 it toggles the entry (if it was previous selected, it is not
3090 <P><DT><A NAME="M512"><B><KeyRelease-space></B></A><DD>
3091 Turns off select mode.
3092 <P><DT><A NAME="M513"><B><KeyPress-Return></B></A><DD>
3093 Sets the focus to the current entry.
3094 <P><DT><A NAME="M514"><B><KeyRelease-Return></B></A><DD>
3095 Turns off select mode.
3096 <P><DT><A NAME="M515"><B><KeyPress></B></A><DD>
3097 Moves to the next entry whose label starts with the letter typed.
3098 <P><DT><A NAME="M516"><B><KeyPress-Home></B></A><DD>
3099 Moves the focus to first entry. Closed or hidden entries
3101 <P><DT><A NAME="M517"><B><KeyPress-End></B></A><DD>
3102 Move the focus to the last entry. Closed or hidden entries
3104 <P><DT><A NAME="M518"><B><Control-a></B></A><DD>
3105 Move to parent of current entry.
3106 <P><DT><A NAME="M519"><B><Control-o></B></A><DD>
3108 <P><DT><A NAME="M520"><B><Control-Shift-O></B></A><DD>
3109 Open current entry recursively.
3110 <P><DT><A NAME="M521"><B><Double-ButtonRelease-1></B></A><DD>
3112 <P><DT><A NAME="M522"><B><Alt-Double-ButtonRelease-1></B></A><DD>
3114 <P><DT><A NAME="M523"><B><Control-KeyPress-minus></B></A><DD>
3115 Close parent of current entry.
3116 <P><DT><A NAME="M524"><B><KeyPress-F1></B></A><DD>
3117 Opens all tree nodes.
3118 <P><DT><A NAME="M525"><B><KeyPress-F2></B></A><DD>
3119 Closes all tree nodes (except root).
3120 <P><DT><A NAME="M526"><B><KeyPress-F3></B></A><DD>
3122 <P><DT><A NAME="M527"><B><KeyPress-F4></B></A><DD>
3123 Reset all column widths back to 0 allowing autosizing.
3124 <P><DT><A NAME="M528"><B><Control-Shift-O></B></A><DD>
3125 Open focus tree node recursively.
3126 <P><DT><A NAME="M529"><B><Control-Shift-C></B></A><DD>
3127 Close focus tree node recursively.
3129 <H4><A NAME="M530">BUTTON BINDINGS</A></H4>
3130 Buttons have bindings. There are associated with the "all" bindtag
3131 (see the entry's -bindtag option). You can use the <B><A HREF="../TkCmd/bind.htm">bind</A></B>
3132 operation to change them.
3134 <DL class="button bindings">
3135 <DT><A NAME="M531"><B><Enter></B></A><DD>
3136 Highlights the button of the current entry.
3137 <P><DT><A NAME="M532"><B><Leave></B></A><DD>
3138 Returns the button back to its normal state.
3139 <P><DT><A NAME="M533"><B><ButtonRelease-1></B></A><DD>
3140 Adjust the view so that the current entry is visible.
3142 <H4><A NAME="M534">ENTRY BINDINGS</A></H4>
3143 Entries have default bindings. There are associated with the "all"
3144 bindtag (see the entry's -bindtag option). You can use the <B><A HREF="../TkCmd/bind.htm">bind</A></B>
3145 operation to modify them.
3147 <DL class="entry bindings">
3148 <DT><A NAME="M535"><B><Enter></B></A><DD>
3149 Highlights the current entry.
3150 <P><DT><A NAME="M536"><B><Leave></B></A><DD>
3151 Returns the entry back to its normal state.
3152 <P><DT><A NAME="M537"><B><ButtonPress-1></B></A><DD>
3153 Sets the selection anchor the current entry.
3154 <P><DT><A NAME="M538"><B><Double-ButtonPress-1></B></A><DD>
3155 Toggles the selection of the current entry.
3156 <P><DT><A NAME="M539"><B><B1-Motion></B></A><DD>
3157 For "multiple" mode only. Saves the current location of the
3158 pointer for auto-scrolling. Resets the selection mark.
3159 <P><DT><A NAME="M540"><B><ButtonRelease-1></B></A><DD>
3160 For "multiple" mode only. Sets the selection anchor to the
3162 <P><DT><A NAME="M541"><B><Shift-ButtonPress-1></B></A><DD>
3163 For "multiple" mode only. Extends the selection.
3164 <P><DT><A NAME="M542"><B><Shift-Double-ButtonPress-1></B></A><DD>
3165 Place holder. Does nothing.
3166 <P><DT><A NAME="M543"><B><Shift-B1-Motion></B></A><DD>
3167 Place holder. Does nothing.
3168 <P><DT><A NAME="M544"><B><Shift-ButtonRelease-1></B></A><DD>
3169 Stop auto-scrolling.
3170 <P><DT><A NAME="M545"><B><Control-ButtonPress-1></B></A><DD>
3171 For "multiple" mode only. Toggles and extends the selection.
3172 <P><DT><A NAME="M546"><B><Control-Double-ButtonPress-1></B></A><DD>
3173 Place holder. Does nothing.
3174 <P><DT><A NAME="M547"><B><Control-B1-Motion></B></A><DD>
3175 Place holder. Does nothing.
3176 <P><DT><A NAME="M548"><B><Control-ButtonRelease-1></B></A><DD>
3177 Stops auto-scrolling.
3178 <P><DT><A NAME="M549"><B><Control-Shift-ButtonPress-1></B></A><DD>
3180 <P><DT><A NAME="M550"><B><Control-Shift-Double-ButtonPress-1></B></A><DD>
3181 Place holder. Does nothing.
3182 <P><DT><A NAME="M551"><B><Control-Shift-B1-Motion></B></A><DD>
3183 Place holder. Does nothing.
3185 <H4><A NAME="M552">COLUMN BINDINGS</A></H4>
3186 Columns have bindings too. They are associated with the column's
3187 "all" bindtag (see the column -bindtag option). You can use the
3188 <B>column bind</B> operation to change them.
3190 <DL class="column bindings">
3191 <DT><A NAME="M553"><B><Enter></B></A><DD>
3192 Highlights the current column title.
3193 <P><DT><A NAME="M554"><B><Leave></B></A><DD>
3194 Returns the column back to its normal state.
3195 <P><DT><A NAME="M555"><B><ButtonRelease-1></B></A><DD>
3196 Invokes the command (see the column's -command option) if one
3199 <H4><A NAME="M556">COLUMN RULE BINDINGS</A></H4>
3200 <DL class="column rule bindings">
3201 <DT><A NAME="M557"><B><Enter></B></A><DD>
3202 Highlights the current and activates the ruler.
3203 <P><DT><A NAME="M558"><B><Leave></B></A><DD>
3204 Returns the column back to its normal state. Deactivates the
3206 <P><DT><A NAME="M559"><B><ButtonPress-1></B></A><DD>
3207 Sets the resize anchor for the column.
3208 <P><DT><A NAME="M560"><B><B1-Motion></B></A><DD>
3209 Sets the resize mark for the column.
3210 <P><DT><A NAME="M561"><B><ButtonRelease-1></B></A><DD>
3211 Adjust the size of the column, based upon the resize anchor and mark
3214 <H3><A NAME="M562">QUICKSTART</A></H3>
3215 TreeFill is a utility function to simplify tree data loading
3216 from a human-readable string. The string
3217 uses line indentation to indicate tree depth.
3218 The indentation is in multiples of 4 spaces, relative to the first line. eg.
3219 <PRE>pack [treeview .t]
3220 .t column insert end X Y Z
3221 blt::tv::TreeFill .t {
3226 a 1 2 "Level a"
3227 b 1 2 "Level b"
3231 .t entry conf 0->B->y->a -state disabled</PRE>
3232 Any column names not defined are generated.
3233 To load a table instead of a tree, simply set the -flat option first. eg.
3234 <PRE>pack [treeview .t -flat 1]
3235 .t column conf Col0 -hide 1
3236 .t column insert end Name Age Sex
3237 blt::tv::TreeFill .t {
3238 "Tom Brown" 9 M
3239 "Mike Small" 8 M
3240 "Tina Baker" 7 F
3242 <H3><A NAME="M563">EXAMPLE</A></H3>
3243 The <B>treeview</B> command creates a new widget.
3244 <PRE>treeview .h -bg white</PRE>
3245 A new Tcl command <B>.h</B> is also created. This command can be used
3246 to query and modify the <B>treeview</B> widget. For example, to change the
3248 color of the table to "green", you use the new command and the widget's
3249 <B>configure</B> operation.
3250 <PRE># Change the background color.
3251 .h configure -background "green"</PRE>
3252 By default, the <B>treeview</B> widget will automatically create a new tree object
3253 to contain the data. The name of the new tree is the pathname of the
3254 widget. Above, the new tree object name is ".h". But you can use the
3255 <B>-tree</B> option to specify the name of another tree.
3256 <PRE># View the tree "myTree".
3257 .h configure -tree "myTree"</PRE>
3258 When a new tree is created, it contains only a root node. The node
3259 is automatically opened. The id of the root node is always
3260 <B>0</B> (you can use also use the special id <B>root</B>). The
3261 <B>insert</B> operation lets you insert one or more new entries into
3262 the tree. The last argument is the node's <I>pathname</I>.
3263 <PRE># Create a new entry named "myEntry"
3264 set id [ .h insert end "myEntry"]</PRE>
3265 This appends a new node named "myEntry". It will positioned as the
3266 last child of the root of the tree (using the position "end"). You
3267 can supply another position to order the node within its siblings.
3268 <PRE># Prepend "fred".
3269 set id [ .h insert 0 "fred"]</PRE>
3270 Entry names do not need to be unique. By default, the node's label
3271 is its name. To supply a different text label, add the <B>-label</B>
3273 <PRE># Create a new node named "fred"
3274 set id [ .h insert end "fred" -label "Fred Flintstone"]</PRE>
3275 The <B>insert</B> operation returns the id of the new node. You can
3276 also use the <B>index</B> operation to get this information.
3277 <PRE># Get the id of "fred"
3278 .h index "fred"</PRE>
3279 To insert a node somewhere other than root, use the <B>-at</B> switch.
3280 It takes the id of the node where the new child will be added.
3281 <PRE># Create a new node "barney" in "fred".
3282 .h insert -at $id end "barney"</PRE>
3283 A pathname describes the path to an entry in the hierarchy. It's a
3284 list of entry names that compose the path in the tree. Therefore, you
3285 can also add "barney" to "fred" as follows.
3286 <PRE># Create a new sub-entry of "fred"
3287 .h insert end "fred barney"</PRE>
3288 Every name in the list is ancestor of the next. All ancestors must
3289 already exist. That means that an entry "fred" is an ancestor of
3290 "barney" and must already exist. But you can use the
3291 <B>-autocreate</B> configuration option to force the creation of
3293 <PRE># Force the creation of ancestors.
3294 .h configure -autocreate yes
3295 .h insert end "fred barney wilma betty"</PRE>
3296 Sometimes the pathname is already separated by a character sequence
3297 rather than formed as a list. A file name is a good example of this.
3298 You can use the <B>-separator</B> option to specify a separator string
3299 to split the path into its components. Each pathname inserted is
3300 automatically split using the separator string as a separator.
3301 Multiple separators are treated as one.
3302 <PRE>.h configure -separator /
3303 .h insert end "/usr/local/tcl/bin"</PRE>
3304 If the path is prefixed by extraneous characters, you can
3305 automatically trim it off using the <B>-trim</B> option. It removed
3306 the string from the path before it is parsed.
3307 <PRE>.h configure -trim C:/windows -separator /
3308 .h insert end "C:/window/system"</PRE>
3309 You can insert more than one entry at a time with the <B>insert</B>
3310 operation. This can be much faster than looping over a list of names.
3312 foreach f [glob $dir/*] {
3316 eval .h insert end [glob $dir/*]</PRE>
3317 In this case, the <B>insert</B> operation will return a list of ids
3320 You can delete entries with the <B>delete</B> operation. It takes one or
3321 more tags of ids as its argument. It deletes the entry and all its
3323 <PRE>.h delete $id</PRE>
3324 Entries have several configuration options. They control the appearance
3325 of the entry's icon and label. We have already seen the <B>-label</B>
3326 option that sets the entry's text label. The <B>entry configure</B>
3327 operation lets you set or modify an entry's configuration options.
3328 <PRE>.h entry configure $id -color red -font fixed</PRE>
3329 You can hide an entry and its children using the <B>-hide</B> option.
3330 <PRE>.h entry configure $id -hide yes</PRE>
3331 More that one entry can be configured at once. All entries specified
3332 are configured with the same options.
3333 <PRE>.h entry configure $i1 $i2 $i3 $i4 -color brown</PRE>
3334 An icon is displayed for each entry. It's a Tk image drawn to the
3335 left of the label. You can set the icon with the entry's
3336 <B>-icons</B> option. It takes a list of two image names: one to
3337 represent the open entry, another when it is closed.
3338 <PRE>set im1 [image create photo -file openfolder.gif]
3339 set im2 [image create photo -file closefolder.gif]
3340 .h entry configure $id -icons "$im1 $im2"</PRE>
3341 If <B>-icons</B> is set to the empty string, no icons are display.
3343 If an entry has children, a button is displayed to the left of the
3344 icon. Clicking the mouse on this button opens or closes the
3345 sub-hierarchy. The button is normally a <B>+</B> or <B>-</B>
3346 symbol, but can be configured in a variety of ways using the <B>button
3347 configure</B> operation. For example, the <B>+</B> and <B>-</B>
3348 symbols can be replaced with Tk images.
3349 <PRE>set im1 [image create photo -file closefolder.gif]
3350 set im2 [image create photo -file downarrow.gif]
3351 .h button configure $id -images "$im1 $im2" \
3352 -openrelief raised -closerelief raised</PRE>
3353 Entries can contain an arbitrary number of <I>data fields</I>. Data
3354 fields are name-value pairs. Both the value and name are strings.
3355 The entry's <B>-data</B> option lets you set data fields.
3356 <PRE>.h entry configure $id -data {mode 0666 group users}</PRE>
3357 The <B>-data</B> takes a list of name-value pairs.
3359 You can display these data fields as <I>columns</I> in the
3360 <B>treeview</B> widget. You can create and configure columns with
3361 the <B>column</B> operation. For example, to add a new column to the
3362 widget, use the <B>column insert</B> operation. The last argument is
3363 the name of the data field that you want to display.
3364 <PRE>.h column insert end "mode"</PRE>
3365 The column title is displayed at the top of the column. By default,
3366 it's is the field name. You can override this using the column's
3367 <B>-title</B> option.
3368 <PRE>.h column insert end "mode" -title "File Permissions"</PRE>
3369 Columns have several configuration options. The <B>column
3370 configure</B> operation lets you query or modify column options.
3371 <PRE>.h column configure "mode" -justify left</PRE>
3372 The <B>-justify</B> option says how the data is justified within in
3373 the column. The <B>-hide</B> option indicates whether the column is
3375 <PRE>.h column configure "mode" -hide yes</PRE>
3376 Entries can be selected by clicking on the mouse. Selected entries
3377 are drawn using the colors specified by the <B>-selectforeground</B>
3378 and <B>-selectbackground</B> configuration options.
3379 The selection itself is managed by the <B><A HREF="../TkCmd/selection.htm">selection</A></B> operation.
3380 <PRE># Clear all selections
3381 .h selection clear 0 end
3382 # Select the root node
3383 .h selection set 0</PRE>
3384 The <B>curselection</B> operation returns a list of ids of
3385 all the selected entries.
3386 <PRE>set ids [ .h curselection]</PRE>
3387 You can use the <B>get</B> operation to convert the ids to
3389 <PRE>set names [eval .h get -full $ids]</PRE>
3390 If a treeview is exporting its selection (using the
3391 <B>-exportselection</B> option), then it will observe the standard X11
3392 protocols for handling the selection. Treeview selections are
3393 available as type <B><A HREF="../TclCmd/string.htm">STRING</A></B>; the value of the selection will be the
3394 pathnames of the selected entries, separated by newlines.
3396 The <B>treeview</B> supports two modes of selection: <B>single</B>
3397 and <B>multiple</B>. In single select mode, only one entry can be
3398 selected at a time, while multiple select mode allows several entries
3399 to be selected. The mode is set by the widget's <B>-selectmode</B>
3401 <PRE>.h configure -selectmode "multiple"</PRE>
3402 You can be notified when the list of selected entries changes. The widget's
3403 <B>-selectcommand</B> specifies a Tcl procedure that is called whenever
3404 the selection changes.
3405 <PRE>proc SelectNotify { widget } {
3406 set ids [ $widget curselection]
3408 .h configure -selectcommand "SelectNotify .h"</PRE>
3409 The widget supports the standard Tk scrolling and scanning operations.
3410 The <B>treeview</B> can be both horizontally and vertically. You can
3411 attach scrollbars to the <B>treeview</B> the same way as the listbox
3413 <PRE>scrollbar .xbar -orient horizontal -command ".h xview"
3414 scrollbar .ybar -orient vertical -command ".h yview"
3415 .h configure -xscrollcommand ".xbar set" \
3416 -yscrollcommand ".ybar set"</PRE>
3417 Entries can be programmatically opened or closed using the <B><A HREF="../TclCmd/open.htm">open</A></B>
3418 and <B><A HREF="../TclCmd/close.htm">close</A></B> operations respectively.
3421 When an entry is opened, a Tcl procedure can be automatically invoked.
3422 The <B>-opencommand</B> option specifies this procedure. This
3423 procedure can lazily insert entries as needed.
3424 <PRE>proc AddEntries { dir } {
3425 eval .h insert end [glob -nocomplain $dir/*]
3427 .h configure -opencommand "AddEntries %P"</PRE>
3428 Now when an entry is opened, the procedure <B>AddEntries</B> is
3429 called and adds children to the entry. Before the command is invoked,
3430 special "%" substitutions (like <B><A HREF="../TkCmd/bind.htm">bind</A></B>) are performed. Above,
3431 <B>%P</B> is translated to the pathname of the entry.
3433 The same feature exists when an entry is closed. The
3434 <B>-closecommand</B> option specifies the procedure.
3435 <PRE>proc DeleteEntries { id } {
3436 .h entry delete $id 0 end
3438 .h configure -closecommand "DeleteEntries %#"</PRE>
3439 When an entry is closed, the procedure <B>DeleteEntries</B> is called
3440 and deletes the entry's children using the <B>entry delete</B> operation
3441 (<B>%#</B> is the id of entry).
3442 <H3><A NAME="M564">OLD TREEVIEW EDITS</A></H3>
3443 <B>NOTE: This section is OBSOLETE. Native Tk widgets are now used for editing.</B>.
3445 <DL class="old treeview edits">
3446 <DT><A NAME="M565">When editing the subwidget .edit is available.</A><DD>
3447 <P><DT><A NAME="M566"><I>pathName.</I><B>edit </B><I>operation</I> ?<I>args</I>?</A><DD>
3448 This operation is used to provide text editing for cells (data
3449 fields in a column) or entry labels.
3450 It has several forms, depending on <I>operation</I>:
3452 <DL class="old treeview edits">
3453 <DT><A NAME="M567"><I>pathName.</I><B>edit apply</B></A><DD>
3454 Applies the edited buffer, replacing the entry label
3455 or data field. The edit window is hidden.
3456 <P><DT><A NAME="M568"><I>pathName.</I><B>edit cancel</B></A><DD>
3457 Cancels the editing operation, reverting the entry label
3458 or data value back to the previous value. The edit window is hidden.
3459 <P><DT><A NAME="M569"><I>pathName.</I><B>edit cget</B><I> value</I></A><DD>
3460 Returns the current value of the configuration option given
3462 <I>Option</I> may have any of the values accepted by the <B>configure</B>
3463 operation described below.
3464 <P><DT><A NAME="M570"><I>pathName.</I><B>edit configure</B> ?<I>option value</I>?</A><DD>
3465 Query or modify the configuration options of the edit window.
3466 If no <I>option</I> is specified, returns a list describing all of
3467 the available options (see <B><A HREF="../TkLib/ConfigWidg.htm">Tk_ConfigureInfo</A></B> for
3468 information on the format of this list). If <I>option</I> is specified
3469 with no <I>value</I>, then the command returns a list describing the
3470 one named option (this list will be identical to the corresponding
3471 sublist of the value returned if no <I>option</I> is specified). If
3472 one or more <I>option-value</I> pairs are specified, then the command
3473 modifies the given widget option(s) to have the given value(s); in
3474 this case the command returns an empty string.
3475 <I>Option</I> and <I>value</I> are described in the section
3478 <P><DT><A NAME="M571"><I>pathName.</I><B>edit delete</B><I> first last</I></A><DD>
3479 Deletes the characters in the edit buffer between the two given
3480 character positions.
3481 <P><DT><A NAME="M572"><I>pathName.</I><B>edit get</B> ?<I>-root</I>? <I>x y</I></A><DD>
3482 <P><DT><A NAME="M573"><I>pathName.</I><B>edit icursor</B><I> index</I></A><DD>
3483 <P><DT><A NAME="M574"><I>pathName.</I><B>edit index</B><I> index</I></A><DD>
3484 Returns the text index of given <I>index</I>.
3485 <P><DT><A NAME="M575"><I>pathName.</I><B>edit insert</B><I> index string</I></A><DD>
3486 Insert the text string <I>string</I> into the edit buffer at the index
3487 <I>index</I>. For example, the index 0 will prepend the buffer.
3488 <P><DT><A NAME="M576"><I>pathName.</I><B>edit selection</B><I> args</I></A><DD>
3489 This operation controls the selection of the editing window. Note
3490 that this differs from the selection of entries.
3491 It has the following forms:
3493 <DL class="old treeview edits">
3494 <DT><A NAME="M577"><I>pathName.</I><B>edit selection adjust</B><I> index</I></A><DD>
3495 Adjusts either the first or last index of the selection.
3496 <P><DT><A NAME="M578"><I>pathName.</I><B>edit selection clear</B></A><DD>
3497 Clears the selection.
3498 <P><DT><A NAME="M579"><I>pathName.</I><B>edit selection from</B><I> index</I></A><DD>
3499 Sets the anchor of the selection.
3500 <P><DT><A NAME="M580"><I>pathName.</I><B>edit selection present</B></A><DD>
3501 Indicates if a selection is present.
3502 <P><DT><A NAME="M581"><I>pathName.</I><B>edit selection range</B><I> start end</I></A><DD>
3503 Sets both the anchor and mark of the selection.
3504 <P><DT><A NAME="M582"><I>pathName.</I><B>edit selection to</B><I> index</I></A><DD>
3505 Sets the unanchored end (mark) of the selection.
3508 <H3><A NAME="M583">NOTES</A></H3>
3509 Text cells in display height can be at most 64K pixels high per row.
3510 <H3><A NAME="M584">KEYWORDS</A></H3>
3511 <A href="../Keywords/T.htm#treeview">treeview</A>, <A href="../Keywords/W.htm#widget">widget</A>
3512 <div class="copy">Copyright © 1995-1997 Roger E. Critchlow Jr.
OSDN Git Service
