1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
|
<sect1 id="Tree_Widget">
<title>Tree Widget</title>
<literallayout class="monospaced">
Application Header file <X11/Xaw/Tree.h>
Class Header file <X11/Xaw/TreeP.h>
Class treeWidgetClass
Class Name Tree
Superclass Constraint
</literallayout>
<para>
The Tree widget provides geometry management of arbitrary widgets arranged
in a directed, acyclic graph (i.e., a tree). The hierarchy is constructed
by attaching a constraint resource called <function>treeParent</function> to each widget
indicating which other node in the tree should be treated as the widget's
superior. The structure of the tree is shown by laying out the nodes
in the standard format for tree diagrams with lines drawn connecting each
node with its children.
</para>
<para>
The Tree sizes itself according to the needs of its children and is not
intended to be resized by its parent. Instead, it should be placed inside
another composite widget (such as the <function>Porthole</function> or <function>Viewport</function>)
that can be used to scroll around in the tree.
</para>
<sect2 id='Tree::Resources'>
<title>Resources</title>
<para>
When creating a Tree widget instance, the following resources are
retrieved from the argument list or from the resource database:
</para>
<informaltable>
<tgroup cols='5' align='center'>
<colspec colname='c1'/>
<colspec colname='c2'/>
<colspec colname='c3'/>
<colspec colname='c4'/>
<colspec colname='c5'/>
<thead>
<row>
<entry>Name</entry>
<entry>Class</entry>
<entry>Type</entry>
<entry>Notes</entry>
<entry>Default Value</entry>
</row>
</thead>
<tbody>
<row>
<entry>accelerators</entry>
<entry>Accelerators</entry>
<entry>AcceleratorTable</entry>
<entry></entry>
<entry>NULL</entry>
</row>
<row>
<entry>ancestorSensitive</entry>
<entry>AncestorSensitive</entry>
<entry>Boolean</entry>
<entry>D</entry>
<entry>True</entry>
</row>
<row>
<entry>autoReconfigure</entry>
<entry>AutoReconfigure</entry>
<entry>Boolean</entry>
<entry></entry>
<entry>False</entry>
</row>
<row>
<entry>background</entry>
<entry>Background</entry>
<entry>Pixel</entry>
<entry></entry>
<entry>XtDefaultBackground</entry>
</row>
<row>
<entry>backgroundPixmap</entry>
<entry>Pixmap</entry>
<entry>Pixmap</entry>
<entry></entry>
<entry>XtUnspecifiedPixmap</entry>
</row>
<row>
<entry>borderColor</entry>
<entry>BorderColor</entry>
<entry>Pixel</entry>
<entry></entry>
<entry>XtDefaultForeground</entry>
</row>
<row>
<entry>borderPixmap</entry>
<entry>Pixmap</entry>
<entry>Pixmap</entry>
<entry></entry>
<entry>XtUnspecifiedPixmap</entry>
</row>
<row>
<entry>borderWidth</entry>
<entry>BorderWidth</entry>
<entry>Dimension</entry>
<entry></entry>
<entry>1</entry>
</row>
<row>
<entry>children</entry>
<entry>ReadOnly</entry>
<entry>WidgetList</entry>
<entry>R</entry>
<entry>NULL</entry>
</row>
<row>
<entry>colormap</entry>
<entry>Colormap</entry>
<entry>Colormap</entry>
<entry></entry>
<entry>Parent's Colormap</entry>
</row>
<row>
<entry>depth</entry>
<entry>Depth</entry>
<entry>int</entry>
<entry>C</entry>
<entry>Parent's Depth</entry>
</row>
<row>
<entry>destroyCallback</entry>
<entry>Callback</entry>
<entry>XtCallbackList</entry>
<entry></entry>
<entry>NULL</entry>
</row>
<row>
<entry>foreground</entry>
<entry>Foreground</entry>
<entry>Pixel</entry>
<entry></entry>
<entry>XtDefaultForeground</entry>
</row>
<row>
<entry>gravity</entry>
<entry>Gravity</entry>
<entry>XtGravity</entry>
<entry></entry>
<entry>WestGravity</entry>
</row>
<row>
<entry>height</entry>
<entry>Height</entry>
<entry>Dimension</entry>
<entry>A</entry>
<entry>see <xref linkend='Tree::Layout_Semantics'/></entry>
</row>
<row>
<entry>hSpace</entry>
<entry>HSpace</entry>
<entry>Dimension</entry>
<entry></entry>
<entry>4</entry>
</row>
<row>
<entry>lineWidth</entry>
<entry>LineWidth</entry>
<entry>Dimension</entry>
<entry></entry>
<entry>0</entry>
</row>
<row>
<entry>mappedWhenManaged</entry>
<entry>MappedWhenManaged</entry>
<entry>Boolean</entry>
<entry></entry>
<entry>True</entry>
</row>
<row>
<entry>numChildren</entry>
<entry>ReadOnly</entry>
<entry>Cardinal</entry>
<entry>R</entry>
<entry>0</entry>
</row>
<row>
<entry>screen</entry>
<entry>Screen</entry>
<entry>Screen</entry>
<entry>R</entry>
<entry>Parent's Screen</entry>
</row>
<row>
<entry>sensitive</entry>
<entry>Sensitive</entry>
<entry>Boolean</entry>
<entry></entry>
<entry>True</entry>
</row>
<row>
<entry>vSpace</entry>
<entry>VSpace</entry>
<entry>Dimension</entry>
<entry></entry>
<entry>4</entry>
</row>
<row>
<entry>translations</entry>
<entry>Translations</entry>
<entry>TranslationTable</entry>
<entry></entry>
<entry>NULL</entry>
</row>
<row>
<entry>width</entry>
<entry>Width</entry>
<entry>Dimension</entry>
<entry>A</entry>
<entry>see <xref linkend='Tree::Layout_Semantics'/></entry>
</row>
<row>
<entry>x</entry>
<entry>Position</entry>
<entry>Position</entry>
<entry></entry>
<entry>0</entry>
</row>
<row>
<entry>y</entry>
<entry>Position</entry>
<entry>Position</entry>
<entry></entry>
<entry>0</entry>
</row>
</tbody>
</tgroup>
</informaltable>
<variablelist>
<varlistentry>
<term><function>autoReconfigure</function></term>
<listitem>
<para>
Whether or not to layout the tree every time a node is added or removed.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><function>gravity</function></term>
<listitem>
<para>
Specifies the side of the widget from which the tree should grow. Valid
values include <function>WestGravity</function>, <function>NorthGravity</function>, <function>EastGravity</function>, and
<function>SouthGravity</function>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><function>hSpace</function></term>
<listitem>
<para>
<!-- .br -->
<!-- .ns -->
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><function>vSpace</function></term>
<listitem>
<para>
The amount of space, in pixels, to leave between the children. This
resource specifies the amount of space left between the outermost
children and the edge of the box.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><function>lineWidth</function></term>
<listitem>
<para>
The width of the lines from nodes that do not have a <function>treeGC</function>
constraint resource to their children.
</para>
</listitem>
</varlistentry>
</variablelist>
</sect2>
<sect2 id='Tree::Constraint_Resources'>
<title>Constraint Resources</title>
<para>
Each child of the Tree widget must specify its superior node in the tree. In
addition, it may specify a GC to use when drawing a line between it and its
inferior nodes.
</para>
<informaltable>
<tgroup cols='5' align='center'>
<colspec colname='c1'/>
<colspec colname='c2'/>
<colspec colname='c3'/>
<colspec colname='c4'/>
<colspec colname='c5'/>
<thead>
<row>
<entry>Name</entry>
<entry>Class</entry>
<entry>Type</entry>
<entry>Notes</entry>
<entry>Default Value</entry>
</row>
</thead>
<tbody>
<row>
<entry>treeGC</entry>
<entry>TreeGC</entry>
<entry>GC</entry>
<entry></entry>
<entry>NULL</entry>
</row>
<row>
<entry>treeParent</entry>
<entry>TreeParent</entry>
<entry>Widget</entry>
<entry></entry>
<entry>NULL</entry>
</row>
</tbody>
</tgroup>
</informaltable>
<variablelist>
<varlistentry>
<term><function>treeGC</function></term>
<listitem>
<para>
This specifies the GC to use when drawing lines between this widget and its
inferiors in the tree. If this resource is not specified, the Tree's
<function>foreground</function> and <function>lineWidth</function> will be used.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><function>treeParent</function></term>
<listitem>
<para>
This specifies the superior node in the tree for this widget. The default is
for the node to have no superior (and to therefore be at the top of the tree).
</para>
</listitem>
</varlistentry>
</variablelist>
</sect2>
<sect2 id='Tree::Layout_Semantics'>
<title>Layout Semantics</title>
<para>
Each time a child is managed or unmanaged, the Tree widget will attempt
to reposition the remaining children to fix the shape of the tree if the
<!-- .B autoReconfigure -->
resource is set. Children at the top (most superior) of the tree are
drawn at the side specified by the resource.
</para>
<para>
After positioning all children, the Tree widget attempts to shrink its
own size to the minimum dimensions required for the layout.
</para>
</sect2>
<sect2 id='Tree::Convenience_Routines'>
<title>Convenience Routines</title>
<para>
The most efficient way to layout a tree is to set
<function>autoReconfigure</function>
to False and then use the
<xref linkend='XawTreeForceLayout' xrefstyle='select: title'/>
routine to arrange the children.
</para>
<funcsynopsis id='XawTreeForceLayout'>
<funcprototype>
<funcdef>void<function> XawTreeForceLayout</function></funcdef>
<paramdef>Widget<parameter> w</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<variablelist>
<varlistentry>
<term>w</term>
<listitem>
<para>
Specifies the Tree widget.
</para>
</listitem>
</varlistentry>
</variablelist>
</sect2>
</sect1>
|
