aboutsummaryrefslogtreecommitdiff
path: root/libXaw/specs/Toggle.xml
blob: d5c23989880907290c14bb8192ca8500952939a5 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
<sect1 id="Toggle_Widget">
<title>Toggle Widget</title>
<literallayout class="monospaced">
Application Header file     &lt;Xaw/Toggle.h&gt;
Class Header file     &lt;Xaw/ToggleP.h&gt;
Class          toggleWidgetClass
Class Name     Toggle
Superclass      Command
</literallayout>

<para>
The Toggle widget is an area, often rectangular,
that displays a graphic.  The graphic may be a text
string containing multiple lines of characters in an 8
bit or 16 bit character set (to be displayed with a
<emphasis remap='I'>font</emphasis>), or in a multi-byte encoding (for use with
a <emphasis remap='I'>fontset</emphasis>).  The graphic may also be a bitmap or
pixmap.
</para>

<para>
This widget maintains a Boolean state (e.g.
True/False or On/Off) and changes state whenever it is selected.  When
the pointer is on the Toggle widget, the Toggle widget may become highlighted by
drawing a rectangle around its perimeter.  This highlighting indicates
that the Toggle widget is ready for selection.  When pointer button 1 is
pressed and released, the Toggle widget indicates that it has changed
state by reversing its foreground and background colors, and its
<function>notify</function> action is invoked, calling all functions on its callback
list.  If the pointer is moved off of the widget before the pointer button is
released, the Toggle widget reverts to its previous foreground and background
colors, and releasing the pointer button has no effect.  This behavior allows
the user to cancel the operation.
</para>

<para>
Toggle widgets may also be part of a ``radio group.''  A radio group is a
list of at least two Toggle widgets in which no more than one Toggle may
be set at
any time.  A radio group is identified by the widget ID of any one of
its members.  The convenience routine <function>XawToggleGetCurrent</function> will
return information about the Toggle widget in the radio group.
</para>

<para>
Toggle widget state is preserved across changes in sensitivity.
</para>

<sect2 id="toggle_resources">
<title>Resources</title>
<para>
When creating a Toggle 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>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>bitmap</entry>
      <entry>Bitmap</entry>
      <entry>Pixmap</entry>
      <entry></entry>
      <entry>None</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>callback</entry>
      <entry>Callback</entry>
      <entry>XtCallbackList</entry>
      <entry></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>cornerRoundPercent</entry>
      <entry>CornerRoundPercent</entry>
      <entry>Dimension</entry>
      <entry></entry>
      <entry>25</entry>
    </row>
    <row>
      <entry>cursor</entry>
      <entry>Cursor</entry>
      <entry>Cursor</entry>
      <entry></entry>
      <entry>None</entry>
    </row>
    <row>
      <entry>cursorName</entry>
      <entry>Cursor</entry>
      <entry>String</entry>
      <entry></entry>
      <entry>NULL</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>encoding</entry>
      <entry>Encoding</entry>
      <entry>UnsignedChar</entry>
      <entry></entry>
      <entry>XawTextEncoding8bit</entry>
    </row>
    <row>
      <entry>font</entry>
      <entry>Font</entry>
      <entry>XFontStruct</entry>
      <entry></entry>
      <entry>XtDefaultFont</entry>
    </row>
    <row>
      <entry>fontSet</entry>
      <entry>FontSet</entry>
      <entry>XFontSet</entry>
      <entry></entry>
      <entry>XtDefaultFontSet</entry>
    </row>
    <row>
      <entry>foreground</entry>
      <entry>Foreground</entry>
      <entry>Pixel</entry>
      <entry></entry>
      <entry>XtDefaultForeground</entry>
    </row>
    <row>
      <entry>height</entry>
      <entry>Height</entry>
      <entry>Dimension</entry>
      <entry>A</entry>
      <entry>graphic height + 2 * <function>internalHeight</function></entry>
    </row>
    <row>
      <entry>highlightThickness</entry>
      <entry>Thickness</entry>
      <entry>Dimension</entry>
      <entry>A</entry>
      <entry>2 (0 if Shaped)</entry>
    </row>
    <row>
      <entry>insensitiveBorder</entry>
      <entry>Insensitive</entry>
      <entry>Pixmap</entry>
      <entry></entry>
      <entry>GreyPixmap</entry>
    </row>
    <row>
      <entry>internalHeight</entry>
      <entry>Height</entry>
      <entry>Dimension</entry>
      <entry></entry>
      <entry>2</entry>
    </row>
    <row>
      <entry>internalWidth</entry>
      <entry>Width</entry>
      <entry>Dimension</entry>
      <entry></entry>
      <entry>4</entry>
    </row>
    <row>
      <entry>international</entry>
      <entry>International</entry>
      <entry>Boolean</entry>
      <entry>C</entry>
      <entry>False</entry>
    </row>
    <row>
      <entry>justify</entry>
      <entry>Justify</entry>
      <entry>Justify</entry>
      <entry></entry>
      <entry>XtJustifyCenter (center)</entry>
    </row>
    <row>
      <entry>label</entry>
      <entry>Label</entry>
      <entry>String</entry>
      <entry></entry>
      <entry>name of widget</entry>
    </row>
    <row>
      <entry>leftBitmap</entry>
      <entry>LeftBitmap</entry>
      <entry>Bitmap</entry>
      <entry></entry>
      <entry>None</entry>
    </row>
    <row>
      <entry>mappedWhenManaged</entry>
      <entry>MappedWhenManaged</entry>
      <entry>Boolean</entry>
      <entry></entry>
      <entry>True</entry>
    </row>
    <row>
      <entry>pointerColor</entry>
      <entry>Foreground</entry>
      <entry>Pixel</entry>
      <entry></entry>
      <entry>XtDefaultForeground</entry>
    </row>
    <row>
      <entry>pointerColorBackground</entry>
      <entry>Background</entry>
      <entry>Pixel</entry>
      <entry></entry>
      <entry>XtDefaultBackground</entry>
    </row>
    <row>
      <entry>radioData</entry>
      <entry>RadioData</entry>
      <entry>Pointer</entry>
      <entry></entry>
      <entry>Name of widget</entry>
    </row>
    <row>
      <entry>radioGroup</entry>
      <entry>Widget</entry>
      <entry>Widget</entry>
      <entry></entry>
      <entry>No radio group</entry>
    </row>
    <row>
      <entry>resize</entry>
      <entry>Resize</entry>
      <entry>Boolean</entry>
      <entry></entry>
      <entry>True</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>shapeStype</entry>
      <entry>ShapeStyle</entry>
      <entry>ShapeStyle</entry>
      <entry></entry>
      <entry>Rectangle</entry>
    </row>
    <row>
      <entry>state</entry>
      <entry>State</entry>
      <entry>Boolean</entry>
      <entry></entry>
      <entry>Off</entry>
    </row>
    <row>
      <entry>translations</entry>
      <entry>Translations</entry>
      <entry>TranslationTable</entry>
      <entry></entry>
      <entry>See below</entry>
    </row>
    <row>
      <entry>width</entry>
      <entry>Width</entry>
      <entry>Dimension</entry>
      <entry>A</entry>
      <entry>graphic width + 2 * <function>internalWidth</function></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>radioData</function>
    </term>
    <listitem>
      <para>
Specifies the data that will be returned by <function>XawToggleGetCurrent</function>
when this is the currently <emphasis remap='I'>set</emphasis> widget in the radio group.  This
value is also used to identify the Toggle that will be set by a call to
<function>XawToggleSetCurrent</function>.  The value NULL will be returned by
<function>XawToggleGetCurrent</function> if no widget in a radio group is currently
set.  Programmers must not specify NULL (or Zero) as <function>radioData</function>.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term>
      <function>radioGroup</function>
    </term>
    <listitem>
      <para>
Specifies another Toggle widget that is in the radio group to which this
Toggle widget should be added.  A radio group is a group of at least two Toggle
widgets, only one of which may be <emphasis remap='I'>set</emphasis> at a time.  If this value is
NULL (the default) then the Toggle will not be part of any radio group
and can change state without affecting any other Toggle widgets.  If the
widget specified in this resource is not already in a radio group then a
new radio group will be created containing these two Toggle widgets.  No
Toggle widget can be in multiple radio groups.  The behavior of a radio
group of one toggle is undefined.  A converter is registered which will
convert widget names to widgets without caching.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term>
      <function>state</function>
    </term>
    <listitem>
      <para>
Specifies whether the Toggle widget is set (<function>True</function>) or unset
(<function>False</function>).
    </para>
  </listitem>
  </varlistentry>
</variablelist>
</sect2>

<sect2 id="Toggle_Actions">
<title>Toggle Actions</title>
<para>
The Toggle widget supports the following actions:
</para>

<itemizedlist>
  <listitem>
    <para>
Switching the Toggle widget between the foreground and background
colors with <function>set</function> and <function>unset</function> and <function>toggle</function>
    </para>
  </listitem>
  <listitem>
    <para>
Processing application callbacks with <function>notify</function>
    </para>
  </listitem>
  <listitem>
    <para>
Switching the internal border between highlighted
and unhighlighted states with <function>highlight</function> and <function>unhighlight</function>
    </para>
  </listitem>
</itemizedlist>

<para>
The following are the default translation bindings used by the
Toggle widget:
</para>

<literallayout class="monospaced">
     &lt;EnterWindow&gt;:     highlight(Always)
     &lt;LeaveWindow&gt;:     unhighlight()
     &lt;Btn1Down&gt;,&lt;Btn1Up&gt;:     toggle() notify()
</literallayout>
</sect2>

<sect2 id="Toggle_Actions_b">
<title>Toggle Actions_b</title>
<para>
The full list of actions supported by Toggle is:
</para>
<variablelist>
  <varlistentry>
    <term>
      <function>highlight</function>(<emphasis remap='I'>condition</emphasis>)
    </term>
    <listitem>
      <para>
Displays the internal highlight border in the color (<function>foreground</function>
or <function>background</function> ) that contrasts with the interior color of the
Toggle widget.  The conditions <function>WhenUnset</function> and <function>Always</function> are
understood by this action procedure.  If no argument is passed then
<function>WhenUnset</function> is assumed.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term>
      <function>unhighlight</function>()
    </term>
    <listitem>
      <para>
Displays the internal highlight border in the color (<function>foreground</function>
or <function>background</function> ) that matches the interior color of the
Toggle widget.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term>
      <function>set</function>()
    </term>
    <listitem>
      <para>
Enters the <emphasis remap='I'>set</emphasis> state, in which <function>notify</function> is possible.  This
action causes the Toggle widget to display its interior in the
<function>foreground</function> color.  The label or bitmap is displayed in the
<function>background</function> color.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term>
      <function>unset</function>()
    </term>
    <listitem>
      <para>
Cancels the <emphasis remap='I'>set</emphasis> state and displays the interior of the Toggle widget in the
<function>background</function> color.  The label or bitmap is displayed in the
<function>foreground</function> color.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term>
      <function>toggle</function>()
    </term>
    <listitem>
      <para>
Changes the current state of the Toggle widget, causing to be set
if it was previously unset, and unset if it was previously set.
If the widget is to be set, and is in a radio group then this procedure may
unset another Toggle widget causing all routines on its callback list
to be invoked.  The callback routines for the Toggle that
is to be unset will be called before the one that is to be set.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term>
      <function>reset</function>()
    </term>
    <listitem>
      <para>
Cancels any <function>set</function> or <function>highlight</function> and displays the interior of the
Toggle widget in the <function>background</function> color, with the label displayed in the
<function>foreground</function> color.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term>
      <function>notify</function>()
    </term>
    <listitem>
      <para>
When the Toggle widget is in the <function>set</function> state this action calls all functions in
the callback list named by the <function>callback</function> resource.  The value of
the call_data argument in these callback functions is undefined.
    </para>
  </listitem>
  </varlistentry>
</variablelist>

<para>
When a bitmap of depth greater that one (1) is specified the
<emphasis remap='I'>set</emphasis>(), <emphasis remap='I'>unset</emphasis>(), and <emphasis remap='I'>reset</emphasis>() actions have no effect,
since there are no foreground and background colors used in a
multi-plane pixmap.
</para>
</sect2>

<sect2 id="Radio_Groups">
<title>Radio Groups</title>
<para>
There are typically two types of radio groups desired by applications.
The default translations for the Toggle widget implement a "zero or one
<!-- .IN "Radio groups" "zero or one of many" -->
of many" radio group.  This means that there may be no more than one
Toggle widget active, but there need not be any Toggle widgets active.
</para>

<para>
The other type of radio group is "one of many" and has the more strict
policy that there will always be exactly one radio button active.
Toggle widgets can be used to provide this interface with a slight
modification to the translation table of each Toggle in the group.
</para>

<literallayout class="monospaced">
     &lt;EnterWindow&gt;:     highlight(Always)
     &lt;LeaveWindow&gt;:     unhighlight()
     &lt;Btn1Down&gt;,&lt;Btn1Up&gt;:     set() notify()
</literallayout>

<para>
This translation table will not allow any Toggle to be <emphasis remap='I'>unset</emphasis>
except as a result of another Toggle becoming <emphasis remap='I'>set</emphasis>.  It is
the application programmer's responsibility to choose an initial
state for the radio group by setting the <function>state</function> resource of one of
its member widgets to <function>True</function>.
</para>
</sect2>

<sect2 id="toggle_convenience_routines">
<title>Convenience Routines</title>
<para>
The following functions allow easy access to the Toggle widget's radio
group functionality.
</para>

<sect3 id="Changing_the_Toggle_s_Radio_Group_">
<title>Changing the Toggle's Radio Group.</title>
<para>
To enable an application to change the Toggle's radio group, add
the Toggle to a radio group, or remove the Toggle from a radio group, use
<function>XawToggleChangeRadioGroup</function>.
</para>

<funcsynopsis>
<funcprototype>
  <funcdef>void<function> XawToggleChangeRadioGroup</function></funcdef>
  <paramdef>Widgetw,<parameter> radio_group</parameter></paramdef>
</funcprototype>
</funcsynopsis>

<para>
<variablelist>
  <varlistentry>
    <term>
      <emphasis remap='I'>w</emphasis>
    </term>
    <listitem>
      <para>
Specifies the Toggle widget.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term>
      <emphasis remap='I'>radio_group</emphasis>
    </term>
    <listitem>
      <para>
Specifies any Toggle in the new radio group.  If NULL then the Toggle
will be removed from any radio group of which it is a member.
    </para>
  </listitem>
  </varlistentry>
</variablelist>
</para>

<para>
If a Toggle is already <emphasis remap='I'>set</emphasis> in the new radio group,
and the Toggle to be added is also <emphasis remap='I'>set</emphasis> then the previously
<emphasis remap='I'>set</emphasis> Toggle in the radio group is <emphasis remap='I'>unset</emphasis> and its callback
procedures are invoked.
Finding the Currently selected Toggle in a radio group of Toggles
</para>

<para>
To find the currently selected Toggle in a radio group of Toggle widgets
use <function>XawToggleGetCurrent</function>.
</para>

<funcsynopsis>
<funcprototype>
  <funcdef>XtPointer<function> XawToggleGetCurrent</function></funcdef>
  <paramdef>XtPointer<parameter> XawToggleGetCurrent(radio_group)</parameter></paramdef>
  <paramdef>Widget<parameter> radio_group</parameter></paramdef>
</funcprototype>
</funcsynopsis>

<variablelist>
  <varlistentry>
    <term>
      <emphasis remap='I'>radio_group</emphasis>
    </term>
    <listitem>
      <para>
Specifies any Toggle widget in the radio group.
    </para>
  </listitem>
  </varlistentry>
</variablelist>

<para>
The value returned by this function is the
<function>radioData</function>
of the Toggle in this radio group that is currently set.  The default
value for <function>radioData</function>
is the name of that Toggle widget.  If no Toggle is set in the radio
group specified then NULL is returned.
Changing the Toggle that is set in a radio group.
</para>

<para>
To change the Toggle that is currently set in a radio group use
<function>XawToggleSetCurrent</function>.
</para>

<funcsynopsis>
<funcprototype>
  <funcdef>void<function> XawToggleSetCurrent</function></funcdef>
  <paramdef>voidXawToggleSetCurrent(radio_group,<parameter> radio_data)</parameter></paramdef>
  <paramdef>Widget<parameter> radio_group</parameter></paramdef>
  <paramdef>XtPointer<parameter> radio_data</parameter></paramdef>
</funcprototype>
</funcsynopsis>

<variablelist>
  <varlistentry>
    <term>
      <emphasis remap='I'>radio_group</emphasis>
    </term>
    <listitem>
      <para>
Specifies any Toggle widget in the radio group.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term>
      <emphasis remap='I'>radio_data</emphasis>
    </term>
    <listitem>
      <para>
Specifies the
<function>radioData</function>
identifying the Toggle that should be set in the radio group specified
by the <emphasis remap='I'>radio_group</emphasis> argument.
    </para>
  </listitem>
  </varlistentry>
</variablelist>


<para>
<function>XawToggleSetCurrent</function> locates the Toggle widget to be set by
matching <emphasis remap='I'>radio_data</emphasis> against the <function>radioData</function> for each Toggle in
the radio group.  If none match, <function>XawToggleSetCurrent</function> returns
without making any changes.  If more than one Toggle matches,
<function>XawToggleSetCurrent</function> will choose a Toggle to set arbitrarily.  If
this causes any Toggle widgets to change state, all routines in their
callback lists will be invoked.  The callback routines for a Toggle that
is to be unset will be called before the one that is to be set.
Unsetting all Toggles in a radio group.
</para>

<para>
To unset all Toggle widgets in a radio group use
<function>XawToggleUnsetCurrent</function>.
</para>

<funcsynopsis>
<funcprototype>
  <funcdef>void<function> XawToggleUnsetCurrent</function></funcdef>
  <paramdef>void<parameter> XawToggleUnsetCurrent(radio_group)</parameter></paramdef>
  <paramdef>Widget<parameter> radio_group</parameter></paramdef>
</funcprototype>
</funcsynopsis>

<variablelist>
  <varlistentry>
    <term>
      <emphasis remap='I'>radio_group</emphasis>
    </term>
    <listitem>
      <para>
Specifies any Toggle widget in the radio group.
    </para>
  </listitem>
  </varlistentry>
</variablelist>

<para>
If this causes a Toggle widget to change state, all routines on its
callback list will be invoked.
</para>
</sect3>
</sect2>
</sect1>