File: disjointlistbox.n.html

package info (click to toggle)
itcl3.0 3.0.1-6
  • links: PTS
  • area: main
  • in suites: sarge
  • size: 10,128 kB
  • ctags: 3,519
  • sloc: tcl: 32,416; ansic: 12,683; sh: 3,917; makefile: 692; awk: 273; perl: 265
file content (375 lines) | stat: -rw-r--r-- 10,500 bytes parent folder | download | duplicates (8)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
<!-- manual page source format generated by RosettaMan v2.5a6, -->
<!-- available via anonymous ftp from ftp.cs.berkeley.edu:/ucb/people/phelps/tcltk/rman.tar.Z -->
<HTML>
<HEAD>
<TITLE>man page(1) manual page</TITLE>
</HEAD>
<BODY>
<A HREF="#toc">Table of Contents</A><P>
_________________________________________________________________
<P>

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

disjointlistbox - Create and manipulate a disjointlistbox
widget
<P>

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

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

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

itk::Widget &lt;- Disjointlistbox
<P>

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

<B>activeBackground</B> <B>selectBorderWidth</B> <B>selectForeground</B>
<B>activeForeground</B> <B>activeRelief</B>       <B>background</B>
<DL>
<DT><B>borderWidth</B> <DD>       <B>buttonPlacement</B>    <B>clientData</B>
</DD>
</DL>
<DL>
<DT><B>cursor</B> <DD>            <B>foreground</B>         <B>highlightColor</B>
<B>highlightThickness</B> <B>disabledForeground</B> <B>elementBorderWidth</B>
<P>
</DD>
</DL>
See the &quot;options&quot; manual entry for details on the standard
options.
<P>

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

<B>lhsButtonLabel</B> <B>rhsButtonLabel</B>
<P>
See the &quot;button&quot; widget manual entry for details on the
above associated options.
<P>
<B>labelFont</B> <B>lhsLabelText</B> <B>rhsLabelText</B>
<P>
See the &quot;label&quot; widget manual entry for details on the above
associated options.
<P>
<B>jump</B> <B>troughColor</B>
<P>
See the &quot;scrollbar&quot; widget class manual entry for details on
the above associated options.
<P>
<B>textBackground</B> <B>textFont</B><BR>

<B>lhsItems</B> <B>rhsItems</B>
<P>
See the &quot;scrolledlistbox&quot; widget manual entry for details on
the above associated options.
<P>

<H2><A NAME="sect6" HREF="#toc6"><B>WIDGET-SPECIFIC</B> <B>OPTIONS</B></A></H2>

<DL>
<DT>Name: <DD>          <B>buttonPlacement</B>
</DD>
</DL>
<DL>
<DT>Class: <DD>         <B>ButtonPlacement</B>
</DD>
</DL>
<DL>
<DT>Command-Line Switch: <DD>          <B>-buttonplacement</B>
<P>
</DD>
</DL>
Specifies the placement of the insertion and removal
buttons relative to the scrolledlistbox widgets<B>n</B>, <B>bottom</B>,
or <B>center</B>. The default is bottom.
<P>
<DL>
<DT>Name: <DD>          <B>lhsLabelText</B>
</DD>
</DL>
<DL>
<DT>Class: <DD>         <B>LabelText</B>
</DD>
</DL>
<DL>
<DT>Command-Line Switch: <DD>          <B>-lhslabeltext</B>
<P>
</DD>
</DL>
Specifies the text for the label of the lhs scrolledlistbox.
The default is &quot;Available".
<P>
<DL>
<DT>Name: <DD>          <B>rhsLabelText</B>
</DD>
</DL>
<DL>
<DT>Class: <DD>         <B>LabelText</B>
</DD>
</DL>
<DL>
<DT>Command-Line Switch: <DD>          <B>-rhslabeltext</B>
<P>
</DD>
</DL>
Specifies the text for the label of the rhs scrolledlistbox.
The default is &quot;Available".
<P>
<DL>
<DT>Name: <DD>          <B>lhsButtonLabel</B>
</DD>
</DL>
<DL>
<DT>Class: <DD>         <B>LabelText</B>
</DD>
</DL>
<DL>
<DT>Command-Line Switch: <DD>          <B>-lhsbuttonlabel</B>
<P>
</DD>
</DL>
Specifies the text for the button of the lhs scrolledlistbox.
The default is &quot;Insert &gt;&gt;".
<P>
<DL>
<DT>Name: <DD>          <B>rhsButtonLabel</B>
</DD>
</DL>
<DL>
<DT>Class: <DD>         <B>LabelText</B>
</DD>
</DL>
<DL>
<DT>Command-Line Switch: <DD>          <B>-rhsbuttonlabel</B>
<P>
</DD>
</DL>
Specifies the text for the button of the rhs scrolledlistbox.
The default is &quot;&lt;&lt; Remove".
<P>
_________________________________________________________________
<P>

<H2><A NAME="sect7" HREF="#toc7"><B>DESCRIPTION</B></A></H2>

The <B>disjointlistbox</B> command creates a disjoint pair of listboxs
similar to the OSF/Motif &quot;Book&quot; printing dialog of the
&quot;FrameMaker&quot; program. It is implementation constists of a
two Scrolledlistboxs, 2 buttons, and 2 labels.
<P>
The disjoint behavior of this widget exists between the
interaction of the two Scrolledlistboxes with one another.
That is, a given instance of a Disjointlistbox will never
exist, without the aid of a hack magician, which has Scrolledlistbox
widgets with items in common. That means the
relationship between the two is maintained similar to that
of disjoint sets.
<P>
Users may transfer items between the two Listbox widgets
using the the two buttons.
<P>
Options exists which include the ability to configure the
&quot;items&quot; displayed by the 2 Scrolledlistboxes and to control
the placement of the insertion and removal buttons.
<P>

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

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

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

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

Returns the current value of the configuration option
given by <I>option</I>. <I>Option</I> may have any of the values
accepted by the <B>disjointlistbox</B> command.
<P>
<I>pathName</I> <B>configure</B> ?<I>option</I>? ?<I>value</I> <I>option</I> <I>value</I> ...?
Query or modify the configuration options of the
widget. If no <I>option</I> is specified, returns a list
describing all of the available options for <I>pathName</I>
(see <B>Tk_ConfigureInfo</B> for information on the format of
this list). If <I>option</I> is specified with no <I>value</I>, then
the command returns a list describing the one named
option (this list will be identical to the corresponding
sublist of the value returned if no <I>option</I> is
specified). If one or more <I>option</I> - <I>value</I> pairs are
specified, then the command modifies the given widget
option(s) to have the given value(s); in this case the
command returns an empty string. <I>Option</I> may have any
of the values accepted by the <B>disjointlistbox</B> command.
<P>
<I>pathName</I> <B>setlhs</B><BR>

Set the current contents of the left-most Scrolledlistbox
with the input list of items. Removes all (if any)
items from the right-most Scrolledlistbox which exist
in the input list option to maintain the disjoint property
between the two
<P>
<I>pathName</I> <B>setrhs</B><BR>

Set the current contents of the right-most Scrolledlistbox
with the input list of items. Removes all
(if any) items from the left-most Scrolledlistbox which
exist in the input list option to maintain the disjoint
property between the two
<P>
<I>pathName</I> <B>getlhs</B><BR>

Returns the current contents of the left-most Scrolledlistbox
<P>
<I>pathName</I> <B>getrhs</B><BR>

Returns the current contents of the right-most Scrolledlistbox
<P>
<I>pathName</I> <B>insertlhs</B><BR>

Add the input list of items to the current contents of
the left-most Scrolledlistbox. Removes all (if any)
items from the right-most Scrolledlistbox which exist
in the input list option to maintain the disjoint property
between the two
<P>
<I>pathName</I> <B>insertrhs</B><BR>

Add the input list of items to the current contents of
the right-most Scrolledlistbox. Removes all (if any)
items from the left-most Scrolledlistbox which exist in
the input list option to maintain the disjoint property
between the two.
<P>
<DL>
<DT>Name: <DD>          <B>lhs</B>
</DD>
</DL>
<DL>
<DT>Class: <DD>         <B>Scrolledlistbox</B>
<P>
</DD>
</DL>
The lhs component is the scrolledlistbox for the rhs
button. See the &quot;scrolledlistbox&quot; widget manual entry
for details on the lhs component item.
<P>
<DL>
<DT>Name: <DD>          <B>rhs</B>
</DD>
</DL>
<DL>
<DT>Class: <DD>         <B>Scrolledlistbox</B>
<P>
</DD>
</DL>
The rhs component is the scrolledlistbox for the rhs
button. See the &quot;scrolledlistbox&quot; widget manual entry
for details on the rhs component item.
<P>
<DL>
<DT>Name: <DD>          <B>lhsbutton</B>
</DD>
</DL>
<DL>
<DT>Class: <DD>         <B>utton</B>
<P>
</DD>
</DL>
The lhsbutton component is the button for users to
remove selected items from the lhs Scrolledlistbox.
See the &quot;button&quot; widget manual entry for details on
the lhs button component.
<P>
<DL>
<DT>Name: <DD>          <B>rhsbutton</B>
</DD>
</DL>
<DL>
<DT>Class: <DD>         <B>Button</B>
<P>
</DD>
</DL>
The rhsbutton component is the button for users to
remove selected items from the rhs Scrolledlistbox.
See the &quot;button&quot; widget manual entry for details on
the rhs button component.
<P>
<DL>
<DT>Name: <DD>          <B>lhsCount</B>
</DD>
</DL>
<DL>
<DT>Class: <DD>         <B>Label</B>
<P>
</DD>
</DL>
The lhsCount component is the label for displaying a
count of the current items in the Scrolledlistbox. See
the &quot;Label&quot; widget manual entry for details on the
lhsCount label component.
<P>
<DL>
<DT>Name: <DD>          <B>rhsCount</B>
</DD>
</DL>
<DL>
<DT>Class: <DD>         <B>Label</B>
<P>
</DD>
</DL>
The rhsCount component is the label for displaying a
count of the current items in the Scrolledlistbox. See
the &quot;Label&quot; widget manual entry for details on the
rhsCount label component.
<P>

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

disjointlistbox .dlb<BR>

pack .dlb -padx 10 -pady 10 -fill both -expand yes
<P>

<H2><A NAME="sect11" HREF="#toc11"><B>AUTHOR(S)</B></A></H2>

John A. Tucker
<P>
Anthony Parent
<P>

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

disjointlistbox, widget
<P>

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