File: XmSelectionBox.3

package info (click to toggle)
motif 2.3.8-4
  • links: PTS, VCS
  • area: main
  • in suites: trixie
  • size: 36,432 kB
  • sloc: ansic: 452,643; sh: 4,611; makefile: 2,030; yacc: 1,604; lex: 352; cpp: 348
file content (708 lines) | stat: -rw-r--r-- 24,813 bytes parent folder | download | duplicates (9)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
'\" t
...\" SelectA.sgm /main/12 1996/09/26 14:54:17 cdedoc $
.de P!
.fl
\!!1 setgray
.fl
\\&.\"
.fl
\!!0 setgray
.fl			\" force out current output buffer
\!!save /psv exch def currentpoint translate 0 0 moveto
\!!/showpage{}def
.fl			\" prolog
.sy sed -e 's/^/!/' \\$1\" bring in postscript file
\!!psv restore
.
.de pF
.ie     \\*(f1 .ds f1 \\n(.f
.el .ie \\*(f2 .ds f2 \\n(.f
.el .ie \\*(f3 .ds f3 \\n(.f
.el .ie \\*(f4 .ds f4 \\n(.f
.el .tm ? font overflow
.ft \\$1
..
.de fP
.ie     !\\*(f4 \{\
.	ft \\*(f4
.	ds f4\"
'	br \}
.el .ie !\\*(f3 \{\
.	ft \\*(f3
.	ds f3\"
'	br \}
.el .ie !\\*(f2 \{\
.	ft \\*(f2
.	ds f2\"
'	br \}
.el .ie !\\*(f1 \{\
.	ft \\*(f1
.	ds f1\"
'	br \}
.el .tm ? font underflow
..
.ds f1\"
.ds f2\"
.ds f3\"
.ds f4\"
.ta 8n 16n 24n 32n 40n 48n 56n 64n 72n 
.TH "XmSelectionBox" "library call"
.SH "NAME"
\fBXmSelectionBox\fP \(em The SelectionBox widget class
.iX "XmSelectionBox"
.iX "widget class" "SelectionBox"
.SH "SYNOPSIS"
.PP
.nf
#include <Xm/SelectioB\&.h>
.fi
.SH "DESCRIPTION"
.PP
SelectionBox is a general dialog widget that allows the user to
select one item from a list\&.
By default, a SelectionBox includes the following:
.IP "   \(bu" 6
A scrolling list of alternatives
.IP "   \(bu" 6
An editable text field for the selected alternative
.IP "   \(bu" 6
Labels for the list and text field
.IP "   \(bu" 6
Three or four buttons
.PP
The default button labels are \fBOK\fP, \fBCancel\fP, and \fBHelp\fP\&.
By default an \fBApply\fP button is also created; if the parent of the
SelectionBox is a DialogShell, it is managed; otherwise it is unmanaged\&.
Additional children may be added to the SelectionBox after
creation\&.
The first child is used as a work area\&. The value of
\fBXmNchildPlacement\fP determines if the work area is placed above
or below the Text area, or above or below the List area\&. Additional
children are laid out in the following manner:
.IP "Menubar" 10
The first menu bar child is placed at the top of the window\&.
The \fBXmQTmenuSystem\fP trait is used to check that it is the first
MenuBar child\&.
.IP "Buttons" 10
All \fBXmPushButton\fP
widgets or gadgets, and their subclasses are
placed after the \fBOK\fP button in the order of their
creation (this order is checked using the \fBXmQTactivatable\fP trait)\&.
The layout direction of the buttons depends on the
\fBXmNlayoutDirection\fP resource\&.
.PP
The layout of additional children that are not in the above categories
is undefined\&.
.PP
The user can select an item in two ways:
by scrolling through the list and selecting the desired
item or by entering the item name directly into the text edit area\&.
Selecting an item from
the list causes that item name to appear in the selection text edit
area\&.
.PP
The user may select a new item
as many times as desired\&. The item is not actually selected until
the user presses the \fBOK\fP PushButton\&.
.PP
The default value for the \fBXmBulletinBoard\fP resource
\fBXmNcancelButton\fP is the Cancel button, unless \fBXmNdialogType\fP is
\fBXmDIALOG_COMMAND\fP, when the default is NULL\&.
The default value for the \fBXmBulletinBoard\fP
\fBXmNdefaultButton\fP resource is the OK button, unless \fBXmNdialogType\fP is
\fBXmDIALOG_COMMAND\fP, when the default is NULL\&.
.PP
For SelectionBox and its subclasses, the default value for
\fBXmNinitialFocus\fP is the text edit area\&.
.PP
The user can specify resources in a resource file for the automatically
created widgets and gadgets of SelectionBox\&. The following list
identifies the names of these widgets (or gadgets) and the associated
SelectionBox areas:
.IP "List Items Label" 10
\fBItems\fP
.IP "List Items" 10
\fBItemsList\fP
.IP "Selection Label" 10
\fBSelection\fP
.IP "Selection Text" 10
\fBText\fP or \fBTextField\fP
.IP "Selection Separator" 10
\fBSeparator\fP
.PP
SelectionBox uses the \fBXmQTaccessTextual\fP, \fBXmQTactivatable\fP,
and \fBXmQTmenuSystem\fP traits\&.
.SS "Descendants"
.PP
SelectionBox automatically creates the descendants shown in the
following table\&.
An application can use \fBXtNameToWidget\fP to gain access
to the named descendant\&. In addition, a user or an application
can use the named descendant when specifying resource values\&.
.TS
tab() box;
l| l| l.
\fBNamed Descendant\fP\fBClass\fP\fBIdentity\fP
___
=
___
\fBApply\fP\fBXmPushButtonGadget\fPApply button
___
\fBCancel\fP\fBXmPushButtonGadget\fPCancel button
___
\fBHelp\fP\fBXmPushButtonGadget\fPHelp button
___
\fBItems\fP\fBXmLabelGadget\fPtitle above the list of items
___
\fBItemsList\fP\fBXmList\fPT{
list of items from which the user will select
T}
___
\fBItemsListSW\fP\fBXmScrolledWindow\fPScrolledWindow parent of \fBItemsList\fP
___
\fBOK\fP\fBXmPushButtonGadget\fPOK button
___
\fBSelection\fP\fBXmLabelGadget\fPtitle above the selection box
___
\fBSeparator\fP\fBXmSeparatorGadget\fPT{
dividing line between selection box and buttons
T}
___
\fBText\fP\fBXmTextField\fPT{
selection box containing text of selected item
T}
___
.TE
.SS "Classes"
.PP
SelectionBox inherits behavior, resources, and traits from \fBCore\fP,
\fBComposite\fP, \fBConstraint\fP, \fBXmManager\fP,
and \fBXmBulletinBoard\fP\&.
.PP
The class pointer is \fBxmSelectionBoxWidgetClass\fP\&.
.PP
The class name is \fBXmSelectionBox\fP\&.
.SS "New Resources"
.PP
The following table defines a set of widget resources used by the programmer
to specify data\&. The programmer can also set the resource values for the
inherited classes to set attributes for this widget\&. To reference a
resource by name or by class in a \fB\&.Xdefaults\fP file, remove the \fBXmN\fP or
\fBXmC\fP prefix and use the remaining letters\&. To specify one of the defined
values for a resource in a \fB\&.Xdefaults\fP file, remove the \fBXm\fP prefix and use
the remaining letters (in either lowercase or uppercase, but include any
underscores between words)\&.
The codes in the access column indicate if the given resource can be
set at creation time (C),
set by using \fBXtSetValues\fP (S),
retrieved by using \fBXtGetValues\fP (G), or is not applicable (N/A)\&.
.PP
.TS
tab() box;
c s s s s
l| l| l| l| l.
\fBXmSelectionBox Resource Set\fP
\fBName\fP\fBClass\fP\fBType\fP\fBDefault\fP\fBAccess\fP
_____
XmNapplyCallbackXmCCallbackXtCallbackListNULLC
_____
XmNapplyLabelStringXmCApplyLabelStringXmStringdynamicCSG
_____
XmNcancelCallbackXmCCallbackXtCallbackListNULLC
_____
XmNcancelLabelStringXmCCancelLabelStringXmStringdynamicCSG
_____
XmNchildPlacementXmCChildPlacementunsigned charXmPLACE_ABOVE_SELECTIONCSG
_____
XmNdialogTypeXmCDialogTypeunsigned chardynamicCG
_____
XmNhelpLabelStringXmCHelpLabelStringXmStringdynamicCSG
_____
XmNlistItemCountXmCItemCountint0CSG
_____
XmNlistItemsXmCItemsXmStringTableNULLCSG
_____
XmNlistLabelStringXmCListLabelStringXmStringdynamicCSG
_____
XmNlistVisibleItemCountXmCVisibleItemCountintdynamicCSG
_____
XmNminimizeButtonsXmCMinimizeButtonsBooleanFalseCSG
_____
XmNmustMatchXmCMustMatchBooleanFalseCSG
_____
XmNnoMatchCallbackXmCCallbackXtCallbackListNULLC
_____
XmNokCallbackXmCCallbackXtCallbackListNULLC
_____
XmNokLabelStringXmCOkLabelStringXmStringdynamicCSG
_____
XmNselectionLabelStringXmCSelectionLabelStringXmStringdynamicCSG
_____
XmNtextAcceleratorsXmCTextAcceleratorsXtAcceleratorsdefaultC
_____
XmNtextColumnsXmCColumnsshortdynamicCSG
_____
XmNtextStringXmCTextStringXmString""CSG
_____
.TE
.IP "\fBXmNapplyCallback\fP" 10
Specifies the list of callbacks called
when the user activates the \fBApply\fP
button\&. The callback reason is \fBXmCR_APPLY\fP\&.
.IP "\fBXmNapplyLabelString\fP" 10
Specifies the string label for the \fBApply\fP button\&.
The default for this resource depends on the locale\&.
In the C locale the default is \fBApply\fP\&.
.IP "" 10
Now that some default localized label strings are provided through
message catalogs for the children of composite widgets, the
\fBlabelString\fP resources
cannot be set on the child through default resource files\&.
Instead, the resource provided at the parent level must be used\&.
.IP "\fBXmNcancelCallback\fP" 10
Specifies the list of callbacks called
when the user activates
the \fBCancel\fP button\&. The callback reason is \fBXmCR_CANCEL\fP\&.
.IP "\fBXmNcancelLabelString\fP" 10
Specifies the string label for the \fBCancel\fP button\&.
The default for this resource depends on the locale\&.
In the C locale the default is \fBCancel\fP\&.
.IP "" 10
Now that some default localized label strings are provided through
message catalogs for the children of composite widgets, the
\fBlabelString\fP resources
cannot be set on the child through default resource files\&.
Instead, the resource provided at the parent level must be used\&.
.IP "\fBXmNchildPlacement\fP" 10
Specifies the placement of the work area child\&. The
possible values are
.RS
.IP "\fBXmPLACE_ABOVE_SELECTION\fP" 10
Places the work area child above the Text area
.IP "\fBXmPLACE_BELOW_SELECTION\fP" 10
Places the work area child below the Text area
.IP "\fBXmPLACE_TOP\fP" 10
Places the work area child above the List area,
and below a MenuBar, if one is present
.RE
.IP "\fBXmNdialogType\fP" 10
Determines the set of SelectionBox children widgets that are created
and managed at initialization\&. The possible values are
.RS
.IP "\fBXmDIALOG_PROMPT\fP" 10
All standard children except the list and
list label are created, and all except the \fBApply\fP button are
managed
.IP "\fBXmDIALOG_COMMAND\fP" 10
Only the list, the selection label, and the
text field are created and managed
.IP "\fBXmDIALOG_SELECTION\fP" 10
All standard children are created and
managed
.IP "\fBXmDIALOG_FILE_SELECTION\fP" 10
All standard children are created and
managed
.IP "\fBXmDIALOG_WORK_AREA\fP" 10
All standard children are created, and all
except the \fBApply\fP button are managed
.RE
.IP "" 10
If the parent of the SelectionBox is a DialogShell, the default is
\fBXmDIALOG_SELECTION\fP; otherwise, the default is \fBXmDIALOG_WORK_AREA\fP\&.
\fBXmCreatePromptDialog\fP and \fBXmCreateSelectionDialog\fP set and append
this resource to the creation \fIarglist\fP supplied by the application\&.
This resource cannot be modified after creation\&.
.IP "\fBXmNhelpLabelString\fP" 10
Specifies the string label for the \fBHelp\fP button\&.
The default for this resource depends on the locale\&.
In the C locale the default is \fBHelp\fP\&.
.IP "" 10
Now that some default localized label strings are provided through
message catalogs for the children of composite widgets, the
\fBlabelString\fP resources
cannot be set on the child through default resource files\&.
Instead, the resource provided at the parent level must be used\&.
.IP "\fBXmNlistItems\fP" 10
Specifies the items in the SelectionBox list\&.
\fBXtGetValues\fP for this resource returns the list items themselves,
not a copy of the list items\&.
The application must not free the returned items\&.
.IP "\fBXmNlistItemCount\fP" 10
Specifies the number of items in the SelectionBox
list\&.
The value must not be negative\&.
.IP "\fBXmNlistLabelString\fP" 10
Specifies the string label to appear above the SelectionBox list
containing the selection items\&.
The default for this resource depends on the locale\&.
In the C locale the default is \fBItems\fP
unless \fBXmNdialogType\fP is
\fBXmDIALOG_PROMPT\fP; in this case the default is NULL\&.
.IP "" 10
Now that some default localized label strings are provided through
message catalogs for the children of composite widgets, the
\fBlabelString\fP resources
cannot be set on the child through default resource files\&.
Instead, the resource provided at the parent level must be used\&.
.IP "\fBXmNlistVisibleItemCount\fP" 10
Specifies the number of items displayed in the SelectionBox
list\&.
The value must be greater than 0 (zero) unless \fBXmNdialogType\fP is
\fBXmDIALOG_PROMPT\fP; in this case, the value is always 0\&.
The default is dynamic based on the height of the list\&.
.IP "\fBXmNminimizeButtons\fP" 10
Sets the buttons to the width of the widest button and height of the
tallest button if False\&. If True, button width and height are not
modified\&.
.IP "\fBXmNmustMatch\fP" 10
Specifies whether the selection widget should check if the
user\&'s selection in the text edit field has an exact match in
the SelectionBox list when the \fBOK\fP button is activated\&.
If the selection does not have an exact match, and
\fBXmNmustMatch\fP is True, the \fBXmNnoMatchCallback\fP callbacks are
called\&.
If the selection does have an exact match or if \fBXmNmustMatch\fP is
False, \fBXmNokCallback\fP callbacks are called\&.
.IP "\fBXmNnoMatchCallback\fP" 10
Specifies the list of callbacks called
when the user makes a selection
from the text edit field that does not have an exact match with
any of the items in the list box\&.
The callback reason is \fBXmCR_NO_MATCH\fP\&.
Callbacks in this list are called only if \fBXmNmustMatch\fP
is true\&.
.IP "\fBXmNokCallback\fP" 10
Specifies the list of callbacks called
when the user activates the \fBOK\fP button\&.
The callback reason is \fBXmCR_OK\fP\&.
If the selection text does not match a list item, and
\fBXmNmustMatch\fP is True, the \fBXmNnoMatchCallback\fP callbacks are
called instead\&.
.IP "\fBXmNokLabelString\fP" 10
Specifies the string label for the \fBOK\fP button\&.
The default for this resource depends on the locale\&.
In the C locale the default is \fBOK\fP\&.
.IP "" 10
Now that some default localized label strings are provided through
message catalogs for the children of composite widgets, the
\fBlabelString\fP resources
cannot be set on the child through default resource files\&.
Instead, the resource provided at the parent level must be used\&.
.IP "\fBXmNselectionLabelString\fP" 10
Specifies the string label for the selection text edit field\&.
The default for this resource depends on the locale\&.
In the C locale the default is \fBSelection\fP\&.
.IP "" 10
Now that some default localized label strings are provided through
message catalogs for the children of composite widgets, the
\fBlabelString\fP resources
cannot be set on the child through default resource files\&.
Instead, the resource provided at the parent level must be used\&.
.IP "\fBXmNtextAccelerators\fP" 10
Specifies translations added to the Text widget child of the
SelectionBox\&.
The default includes bindings for the up and down keys
for auto selection of list items\&.
This resource is ignored if \fBXmNaccelerators\fP is initialized to a
nondefault value\&.
.IP "\fBXmNtextColumns\fP" 10
Specifies the number of columns in the Text widget\&.
The value must be greater than 0 (zero)\&.
.IP "\fBXmNtextString\fP" 10
Specifies the text in the text edit selection field\&.
.SS "Inherited Resources"
.PP
SelectionBox inherits behavior and resources from the
superclasses in the following tables\&.
For a complete description of each resource, refer to the
reference page for that superclass\&.
.PP
.TS
tab() box;
c s s s s
l| l| l| l| l.
\fBXmBulletinBoard Resource Set\fP
\fBName\fP\fBClass\fP\fBType\fP\fBDefault\fP\fBAccess\fP
_____
XmNallowOverlapXmCAllowOverlapBooleanTrueCSG
_____
XmNautoUnmanageXmCAutoUnmanageBooleanTrueCG
_____
XmNbuttonFontListXmCButtonFontListXmFontListdynamicCSG
_____
XmNbuttonRenderTableXmCButtonRenderTableXmRenderTabledynamicCSG
_____
XmNcancelButtonXmCWidgetWidgetdynamicSG
_____
XmNdefaultButtonXmCWidgetWidgetdynamicSG
_____
XmNdefaultPositionXmCDefaultPositionBooleanTrueCSG
_____
XmNdialogStyleXmCDialogStyleunsigned chardynamicCSG
_____
XmNdialogTitleXmCDialogTitleXmStringNULLCSG
_____
XmNfocusCallbackXmCCallbackXtCallbackListNULLC
_____
XmNlabelFontListXmCLabelFontListXmFontListdynamicCSG
_____
XmNlabelRenderTableXmCLabelRenderTableXmRenderTabledynamicCSG
_____
XmNmapCallbackXmCCallbackXtCallbackListNULLC
_____
XmNmarginHeightXmCMarginHeightDimension10CSG
_____
XmNmarginWidthXmCMarginWidthDimension10CSG
_____
XmNnoResizeXmCNoResizeBooleanFalseCSG
_____
XmNresizePolicyXmCResizePolicyunsigned charXmRESIZE_ANYCSG
_____
XmNshadowTypeXmCShadowTypeunsigned charXmSHADOW_OUTCSG
_____
XmNtextFontListXmCTextFontListXmFontListdynamicCSG
_____
XmNtextRenderTableXmCTextRenderTableXmRenderTabledynamicCSG
_____
XmNtextTranslationsXmCTranslationsXtTranslationsNULLC
_____
XmNunmapCallbackXmCCallbackXtCallbackListNULLC
_____
.TE
.PP
.TS
tab() box;
c s s s s
l| l| l| l| l.
\fBXmManager Resource Set\fP
\fBName\fP\fBClass\fP\fBType\fP\fBDefault\fP\fBAccess\fP
_____
XmNbottomShadowColorXmCBottomShadowColorPixeldynamicCSG
_____
XmNbottomShadowPixmapXmCBottomShadowPixmapPixmapXmUNSPECIFIED_PIXMAPCSG
_____
XmNforegroundXmCForegroundPixeldynamicCSG
_____
XmNhelpCallbackXmCCallbackXtCallbackListNULLC
_____
XmNhighlightColorXmCHighlightColorPixeldynamicCSG
_____
XmNhighlightPixmapXmCHighlightPixmapPixmapdynamicCSG
_____
XmNinitialFocusXmCInitialFocusWidgetdynamicCSG
_____
XmNlayoutDirectionXmCLayoutDirectionXmDirectiondynamicCG
_____
XmNnavigationTypeXmCNavigationTypeXmNavigationTypeXmTAB_GROUPCSG
_____
XmNpopupHandlerCallbackXmCCallbackXtCallbackListNULLC
_____
XmNshadowThicknessXmCShadowThicknessDimensiondynamicCSG
_____
XmNstringDirectionXmCStringDirectionXmStringDirectiondynamicCG
_____
XmNtopShadowColorXmCTopShadowColorPixeldynamicCSG
_____
XmNtopShadowPixmapXmCTopShadowPixmapPixmapdynamicCSG
_____
XmNtraversalOnXmCTraversalOnBooleanTrueCSG
_____
XmNunitTypeXmCUnitTypeunsigned chardynamicCSG
_____
XmNuserDataXmCUserDataXtPointerNULLCSG
_____
.TE
.PP
.TS
tab() box;
c s s s s
l| l| l| l| l.
\fBComposite Resource Set\fP
\fBName\fP\fBClass\fP\fBType\fP\fBDefault\fP\fBAccess\fP
_____
XmNchildrenXmCReadOnlyWidgetListNULLG
_____
XmNinsertPositionXmCInsertPositionXtOrderProcNULLCSG
_____
XmNnumChildrenXmCReadOnlyCardinal0G
_____
.TE
.PP
.TS
tab() box;
c s s s s
l| l| l| l| l.
\fBCore Resource Set\fP
\fBName\fP\fBClass\fP\fBType\fP\fBDefault\fP\fBAccess\fP
_____
XmNacceleratorsXmCAcceleratorsXtAcceleratorsdynamicN/A
_____
XmNancestorSensitiveXmCSensitiveBooleandynamicG
_____
XmNbackgroundXmCBackgroundPixeldynamicCSG
_____
XmNbackgroundPixmapXmCPixmapPixmapXmUNSPECIFIED_PIXMAPCSG
_____
XmNborderColorXmCBorderColorPixelXtDefaultForegroundCSG
_____
XmNborderPixmapXmCPixmapPixmapXmUNSPECIFIED_PIXMAPCSG
_____
XmNborderWidthXmCBorderWidthDimension0CSG
_____
XmNcolormapXmCColormapColormapdynamicCG
_____
XmNdepthXmCDepthintdynamicCG
_____
XmNdestroyCallbackXmCCallbackXtCallbackListNULLC
_____
XmNheightXmCHeightDimensiondynamicCSG
_____
XmNinitialResourcesPersistentXmCInitialResourcesPersistentBooleanTrueC
_____
XmNmappedWhenManagedXmCMappedWhenManagedBooleanTrueCSG
_____
XmNscreenXmCScreenScreen *dynamicCG
_____
XmNsensitiveXmCSensitiveBooleanTrueCSG
_____
XmNtranslationsXmCTranslationsXtTranslationsdynamicCSG
_____
XmNwidthXmCWidthDimensiondynamicCSG
_____
XmNxXmCPositionPosition0CSG
_____
XmNyXmCPositionPosition0CSG
_____
.TE
.SS "Callback Information"
.PP
A pointer to the following structure is passed to each callback:
.PP
.nf
typedef struct
{
        int \fIreason\fP;
        XEvent \fI* event\fP;
        XmString \fIvalue\fP;
        int \fIlength\fP;
} XmSelectionBoxCallbackStruct;
.fi
.IP "\fIreason\fP" 10
Indicates why the callback was invoked
.IP "\fIevent\fP" 10
Points to the \fBXEvent\fP that triggered the callback
.IP "\fIvalue\fP" 10
Indicates the \fBXmString\fR value selected by the user from the
SelectionBox list or entered into the SelectionBox text field
.IP "\fIlength\fP" 10
Indicates the size in bytes of the \fBXmString\fR value
This member is obsolete and exists for compatibility with
earlier releases\&.
.SS "Translations"
.PP
\fBXmSelectionBox\fP inherits translations from \fBXmBulletinBoard\fP\&.
.SS "Accelerators"
.PP
The \fBXmNtextAccelerators\fP are added to the Text descendant of
\fBXmSelectionBox\fP\&.
The default accelerators are described in the following list\&.
.PP
The following key names are listed in the
X standard key event translation table syntax\&.
This format is the one used by Motif to
specify the widget actions corresponding to a given key\&.
A brief overview of the format is provided under
\fBVirtualBindings\fP(3)\&.
For a complete description of the format, please refer to the
X Toolkit Instrinsics Documentation\&.
.IP "\fB:\fP\fB<Key>\fP\fB<osfUp>\fP:" 10
SelectionBoxUpOrDown(\fBPrevious\fP)
.IP "\fB:\fP\fB<Key>\fP\fB<osfDown>\fP:" 10
SelectionBoxUpOrDown(\fBNext\fP)
.IP "\fB:\fP\fB<Key>\fP\fB<osfBeginLine>\fP:" 10
SelectionBoxUpOrDown(\fBFirst\fP)
.IP "\fB:\fP\fB<Key>\fP\fB<osfEndLine>\fP:" 10
SelectionBoxUpOrDown(\fBLast\fP)
.IP "\fB:\fP\fB<Key>\fP\fB<osfRestore>\fP:" 10
SelectionBoxRestore()
.IP "\fBs c \(apm \(apa\fP \fB<Key>\fP\fBspace\fP:" 10
SelectionBoxRestore()
.SS "Action Routines"
.PP
The XmSelectionBox action routines are
.IP "SelectionBoxUpOrDown(\fBPrevious|Next|First|Last\fP):" 10
When called with an argument of \fBPrevious\fP, or 0 (zero) for
compatibility, selects the previous
item in the
list and replaces the text with that item\&.
.IP "" 10
When called with an argument of \fBNext\fP, or 1 for
compatibility, selects the next item in the
list and replaces the text with that item\&.
.IP "" 10
When called with an argument of \fBFirst\fP, or 2 for
compatibility, selects the first item in the
list and replaces the text with that item\&.
.IP "" 10
When called with an argument of \fBLast\fP, or 3 for
compatibility, selects the last item in the
list and replaces the text with that item\&.
.IP "SelectionBoxRestore():" 10
Replaces the text value with the list selection\&.
If no item in the list is selected, clears the text\&.
.SS "Additional Behavior"
.PP
The SelectionBox widget has the following additional behavior:
.IP "\fB<Key>\fP\fB<osfCancel>\fP:" 10
Calls the activate callbacks for the cancel button if it is sensitive\&.
If no cancel button exists and the parent of the SelectionBox is a manager,
passes the event to the parent\&.
.IP "\fB<Key>\fP\fB<osfActivate>\fP:" 10
Calls the activate callbacks for the button with the keyboard focus\&.
If no button has the keyboard focus, calls the activate callbacks
for the default button if it is sensitive\&.
In a List widget or single-line Text widget,
the List or Text action associated with \fB<Key>\fP\fB<osfActivate>\fP
is called before the SelectionBox actions associated with
\fB<Key>\fP\fB<osfActivate>\fP\&.
In a multiline Text widget, any \fB<Key>\fP\fB<osfActivate>\fP
event except \fB<Key>\fP\fB<osfEnter>\fP calls
the Text action associated with \fB<Key>\fP\fB<osfActivate>\fP,
then the SelectionBox actions associated with \fB<Key>\fP\fB<osfActivate>\fP\&.
If no button has the focus, no default button exists, and the parent
of the SelectionBox is a manager, passes the event to the parent\&.
.IP "\fB<OK\ Button\ Activated>\fP:" 10
If \fBXmNmustMatch\fP is True and the text does not match an item in the
file list, calls the \fBXmNnoMatchCallback\fP callbacks with reason
\fBXmCR_NO_MATCH\fP\&.
Otherwise, calls the \fBXmNokCallback\fP callbacks with reason
\fBXmCR_OK\fP\&.
.IP "\fB<Apply\ Button\ Activated>\fP:" 10
Calls the \fBXmNapplyCallback\fP callbacks with reason \fBXmCR_APPLY\fP\&.
.IP "\fB<Cancel\ Button\ Activated>\fP:" 10
Calls the \fBXmNcancelCallback\fP callbacks with reason
\fBXmCR_CANCEL\fP\&.
.IP "\fB<Help\ Button\ Activated>\fP:" 10
Calls the \fBXmNhelpCallback\fP callbacks with reason \fBXmCR_HELP\fP\&.
.IP "\fB<MapWindow>\fP:" 10
Calls the callbacks for \fBXmNmapCallback\fP if the SelectionBox
is a child of a Dialog shell\&.
.IP "\fB<UnmapWindow>\fP:" 10
Calls the callbacks for \fBXmNunmapCallback\fP if the SelectionBox is
the child of a DialogShell\&.
.SS "Virtual Bindings"
.PP
The bindings for virtual keys are vendor specific\&.
For information about bindings for virtual buttons and keys, see \fBVirtualBindings\fP(3)\&.
.SH "RELATED"
.PP
\fBComposite\fP(3),
\fBConstraint\fP(3),
\fBCore\fP(3),
\fBXmBulletinBoard\fP(3),
\fBXmCreateSelectionBox\fP(3),
\fBXmCreateSelectionDialog\fP(3),
\fBXmCreatePromptDialog\fP(3),
\fBXmManager\fP(3), and
\fBXmSelectionBoxGetChild\fP(3)\&.
...\" created by instant / docbook-to-man, Sun 22 Dec 1996, 20:29