XmToggleButton(3X) UNIX System V XmToggleButton(3X)
NAME
XmToggleButton - the ToggleButton widget class.
SYNOPSIS
#include <Xm/ToggleB.h>
DESCRIPTION
ToggleButton sets nontransitory state data within an application.
Usually this widget consists of an indicator (square or diamond) with
either text or a pixmap on one side of it. However, it can also consist
of just text or a pixmap without the indicator.
The toggle graphics display a 1-of-many or N-of-many selection state.
When a toggle indicator is displayed, a square indicator shows an N-of-
many selection state and a diamond indicator shows a 1-of-many selection
state.
ToggleButton implies a selected or unselected state. In the case of a
label and an indicator, an empty indicator (square or diamond shaped)
indicates that ToggleButton is unselected, and a filled indicator shows
that it is selected. In the case of a pixmap toggle, different pixmaps
are used to display the selected/unselected states.
The default behavior associated with a ToggleButton in a menu depends on
the type of menu system in which it resides. By default, BSelect
controls the behavior of the ToggleButton. In addition, BMenu controls
the behavior of the ToggleButton if it resides in a PopupMenu system.
The actual mouse button used is determined by its RowColumn parent.
To accommodate the toggle indicator when created, Label's resource
XmNmarginLeft may be increased.
Classes
ToggleButton inherits behavior and resources from Core, XmPrimitive, and
XmLabel Classes.
The class pointer is xmToggleButtonWidgetClass.
The class name is XmToggleButton.
New Resources
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 .Xdefaults file, remove the
XmN or XmC prefix and use the remaining letters. To specify one of the
defined values for a resource in a .Xdefaults file, remove the Xm prefix
and use the remaining letters (in either lowercase or uppercase, but
10/89 Page 1
XmToggleButton(3X) UNIX System V XmToggleButton(3X)
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 XtSetValues (S), retrieved by using XtGetValues (G), or is not
applicable (N/A).
__________________________________________________________________________________________________________
| XmToggleButton Resource Set |
|__________________________|____________________________|________________|______________________|________|
|Name | Class | Type | Default | Access|
|__________________________|____________________________|________________|______________________|________|
|__________________________|____________________________|________________|______________________|________|
|XmNarmCallback | XmCArmCallback | XtCallbackList| NULL | C |
|__________________________|____________________________|________________|______________________|________|
|XmNdisarmCallback | XmCDisarmCallback | XtCallbackList| NULL | C |
|__________________________|____________________________|________________|______________________|________|
|XmNfillOnSelect | XmCFillOnSelect | Boolean | True | CSG |
|__________________________|____________________________|________________|______________________|________|
|XmNindicatorOn | XmCIndicatorOn | Boolean | True | CSG |
|__________________________|____________________________|________________|______________________|________|
|XmNindicatorSize | XmCIndicatorSize | Dimension | dynamic | CSG |
|__________________________|____________________________|________________|______________________|________|
|XmNindicatorType | XmCIndicatorType | unsigned char | dynamic | CSG |
|__________________________|____________________________|________________|______________________|________|
|XmNselectColor | XmCSelectColor | Pixel | dynamic | CSG |
|__________________________|____________________________|________________|______________________|________|
|XmNselectInsensitivePixmap| XmCSelectInsensitivePixmap| Pixmap | XmUNSPECIFIED_PIXMAP| CSG |
|__________________________|____________________________|________________|______________________|________|
|XmNselectPixmap | XmCSelectPixmap | Pixmap | XmUNSPECIFIED_PIXMAP| CSG |
|__________________________|____________________________|________________|______________________|________|
|XmNset | XmCSet | Boolean | False | CSG |
|__________________________|____________________________|________________|______________________|________|
|XmNspacing | XmCSpacing | Dimension | 4 | CSG |
|__________________________|____________________________|________________|______________________|________|
|XmNvalueChangedCallback | XmCValueChangedCallback | XtCallbackList| NULL | C |
|__________________________|____________________________|________________|______________________|________|
|XmNvisibleWhenOff | XmCVisibleWhenOff | Boolean | dynamic | CSG |
|__________________________|____________________________|________________|______________________|________|
XmNarmCallback
Specifies the list of callbacks called when the ToggleButton is
armed. To arm this widget, press the active mouse button while the
pointer is inside the ToggleButton. For this callback, the reason
is XmCR_ARM.
XmNdisarmCallback
Specifies the list of callbacks called when ToggleButton is
disarmed. To disarm this widget, press and release the active mouse
button while the pointer is inside the ToggleButton. This widget
is also disarmed when the user moves out of the widget and releases
the mouse button when the pointer is outside the widget. For this
callback, the reason is XmCR_DISARM.
Page 2 10/89
XmToggleButton(3X) UNIX System V XmToggleButton(3X)
XmNfillOnSelect
Fills the indicator with the color specified in XmNselectColor and
switches the top and bottom shadow colors when set to True.
Otherwise, it switches only the top and bottom shadow colors.
XmNindicatorOn
Specifies that a toggle indicator is drawn to one side of the
toggle text or pixmap when set to True. When set to False, no
space is allocated for the indicator, and it is not displayed. If
XmNindicatorOn is True, the indicator shadows are switched when the
button is selected or unselected, but, any shadows around the
entire widget are not switched. However, if XmNindicatorOn is
False, any shadows around the entire widget are switched when the
toggle is selected or unselected.
XmNindicatorSize
Sets the size of the indicator. If no value is specified, the size
of the indicator is based on the size of the label string or
pixmap. If the label string or pixmap changes, the size of the
indicator is recomputed based on the size of the label string or
pixmap. Once a value has been specified for XmNindicatorSize, the
indicator has that size, regardless of the size of the label string
or pixmap, until a new value is specified.
XmNindicatorType
Specifies if the indicator is a 1-of or N-of indicator. For the
1-of indicator, the value is XmONE_OF_MANY. For the N-of
indicator, the value is XmN_OF_MANY. The N-of-many indicator is
square. The 1-of-many indicator is diamond shaped. This resource
specifies only the visuals and does not enforce the behavior. When
the ToggleButton is in a RadioBox, the default is XmONE_OF_MANY;
otherwise, the default is XmN_OF_MANY.
XmNselectColor
Allows the application to specify what color fills the center of
the square or diamond-shaped indicator when it is set. If this
color is the same as either the top or the bottom shadow color of
the indicator, a one-pixel-wide margin is left between the shadows
and the fill; otherwise, it is filled completely. This resource's
default for a color display is a color between the background and
the bottom shadow color. For a monochrome display, the default is
set to the foreground color. The meaning of this resource is
undefined when XmNindicatorOn is False.
XmNselectInsensitivePixmap
Specifies a pixmap used as the button face when the ToggleButton is
selected and the button is insensitive if the Label resource
XmNlabelType is set to XmPIXMAP. If the ToggleButton is unselected
and the button is insensitive, the pixmap in
XmNlabelInsensitivePixmap is used as the button face. If no value
is specified for XmNlabelInsensitivePixmap, that resource is set to
the value specified for XmNselectInsensitivePixmap.
10/89 Page 3
XmToggleButton(3X) UNIX System V XmToggleButton(3X)
XmNselectPixmap
Specifies the pixmap to be used as the button face if XmNlabelType
is XmPIXMAP and the ToggleButton is selected. When the ToggleButton
is unselected, the pixmap specified in Label's XmNlabelPixmap is
used. If no value is specified for XmNlabelPixmap, that resource
is set to the value specified for XmNselectPixmap.
XmNset
Displays the button in its selected state if set to True. This
shows some conditions as active when a set of buttons first
appears.
XmNspacing
Specifies the amount of spacing between the toggle indicator and
the toggle label (text or pixmap).
XmNvalueChangedCallback
Specifies the list of callbacks called when the ToggleButton value
is changed. To change the value, press and release the active
mouse button while the pointer is inside the ToggleButton. This
action also causes this widget to be disarmed. For this callback,
the reason is XmCR_VALUE_CHANGED.
XmNvisibleWhenOff
Indicates that the toggle indicator is visible in the unselected
state when the Boolean value is True. When the ToggleButton is in a
menu, the default value is False. When the ToggleButton is in a
RadioBox, the default value is True.
Inherited Resources
ToggleButton inherits behavior and resources from the following
superclasses. For a complete description of each resource, refer to the
man page for that superclass.
Page 4 10/89
XmToggleButton(3X) UNIX System V XmToggleButton(3X)
___________________________________________________________________________________________________________
| XmLabel Resource Set |
|_________________________|___________________________|___________________|______________________|________|
|Name | Class | Type | Default | Access|
|_________________________|___________________________|___________________|______________________|________|
|_________________________|___________________________|___________________|______________________|________|
|XmNaccelerator | XmCAccelerator | String | NULL | CSG |
|_________________________|___________________________|___________________|______________________|________|
|XmNacceleratorText | XmCAcceleratorText | XmString | NULL | CSG |
|_________________________|___________________________|___________________|______________________|________|
|XmNalignment | XmCAlignment | unsigned char | dynamic | CSG |
|_________________________|___________________________|___________________|______________________|________|
|XmNfontList | XmCFontList | XmFontList | dynamic | CSG |
|_________________________|___________________________|___________________|______________________|________|
|XmNlabelInsensitivePixmap| XmCLabelInsensitivePixmap| Pixmap | XmUNSPECIFIED_PIXMAP| CSG |
|_________________________|___________________________|___________________|______________________|________|
|XmNlabelPixmap | XmCLabelPixmap | Pixmap | XmUNSPECIFIED_PIXMAP| CSG |
|_________________________|___________________________|___________________|______________________|________|
|XmNlabelString | XmCXmString | XmString | dynamic | CSG |
|_________________________|___________________________|___________________|______________________|________|
|XmNlabelType | XmCLabelType | unsigned char | XmSTRING | CSG |
|_________________________|___________________________|___________________|______________________|________|
|XmNmarginBottom | XmCMarginBottom | Dimension | dynamic | CSG |
|_________________________|___________________________|___________________|______________________|________|
|XmNmarginHeight | XmCMarginHeight | Dimension | 2 | CSG |
|_________________________|___________________________|___________________|______________________|________|
|XmNmarginLeft | XmCMarginLeft | Dimension | dynamic | CSG |
|_________________________|___________________________|___________________|______________________|________|
|XmNmarginRight | XmCMarginRight | Dimension | 0 | CSG |
|_________________________|___________________________|___________________|______________________|________|
|XmNmarginTop | XmCMarginTop | Dimension | dynamic | CSG |
|_________________________|___________________________|___________________|______________________|________|
|XmNmarginWidth | XmCMarginWidth | Dimension | 2 | CSG |
|_________________________|___________________________|___________________|______________________|________|
|XmNmnemonic | XmCMnemonic | KeySym | NULL | CSG |
|_________________________|___________________________|___________________|______________________|________|
|XmNmnemonicCharSet | XmCMnemonicCharSet | String | dynamic | CSG |
|_________________________|___________________________|___________________|______________________|________|
|XmNrecomputeSize | XmCRecomputeSize | Boolean | True | CSG |
|_________________________|___________________________|___________________|______________________|________|
|XmNstringDirection | XmCStringDirection | XmStringDirection| dynamic | CSG |
|_________________________|___________________________|___________________|______________________|________|
10/89 Page 5
XmToggleButton(3X) UNIX System V XmToggleButton(3X)
__________________________________________________________________________________________________
| XmPrimitive Resource Set |
|_____________________|_______________________|__________________|______________________|________|
|Name | Class | Type | Default | Access|
|_____________________|_______________________|__________________|______________________|________|
|_____________________|_______________________|__________________|______________________|________|
|XmNbottomShadowColor | XmCBottomShadowColor | Pixel | dynamic | CSG |
|_____________________|_______________________|__________________|______________________|________|
|XmNbottomShadowPixmap| XmCBottomShadowPixmap| Pixmap | XmUNSPECIFIED_PIXMAP| CSG |
|_____________________|_______________________|__________________|______________________|________|
|XmNforeground | XmCForeground | Pixel | dynamic | CSG |
|_____________________|_______________________|__________________|______________________|________|
|XmNhelpCallback | XmCCallback | XtCallbackList | NULL | C |
|_____________________|_______________________|__________________|______________________|________|
|XmNhighlightColor | XmCHighlightColor | Pixel | dynamic | CSG |
|_____________________|_______________________|__________________|______________________|________|
|XmNhighlightOnEnter | XmCHighlightOnEnter | Boolean | False | CSG |
|_____________________|_______________________|__________________|______________________|________|
|XmNhighlightPixmap | XmCHighlightPixmap | Pixmap | dynamic | CSG |
|_____________________|_______________________|__________________|______________________|________|
|XmNhighlightThickness| XmCHighlightThickness| Dimension | 2 | CSG |
|_____________________|_______________________|__________________|______________________|________|
|XmNnavigationType | XmCNavigationType | XmNavigationType| XmNONE | G |
|_____________________|_______________________|__________________|______________________|________|
|XmNshadowThickness | XmCShadowThickness | Dimension | dynamic | CSG |
|_____________________|_______________________|__________________|______________________|________|
|XmNtopShadowColor | XmCTopShadowColor | Pixel | dynamic | CSG |
|_____________________|_______________________|__________________|______________________|________|
|XmNtopShadowPixmap | XmCTopShadowPixmap | Pixmap | dynamic | CSG |
|_____________________|_______________________|__________________|______________________|________|
|XmNtraversalOn | XmCTraversalOn | Boolean | True | CSG |
|_____________________|_______________________|__________________|______________________|________|
|XmNunitType | XmCUnitType | unsigned char | dynamic | CSG |
|_____________________|_______________________|__________________|______________________|________|
|XmNuserData | XmCUserData | Pointer | NULL | CSG |
|_____________________|_______________________|__________________|______________________|________|
Page 6 10/89
XmToggleButton(3X) UNIX System V XmToggleButton(3X)
________________________________________________________________________________________________________________
| Core Resource Set |
|_____________________________|_______________________________|________________|______________________|________|
|Name | Class | Type | Default | Access|
|_____________________________|_______________________________|________________|______________________|________|
|_____________________________|_______________________________|________________|______________________|________|
|XmNaccelerators | XmCAccelerators | XtAccelerators| dynamic | CSG |
|_____________________________|_______________________________|________________|______________________|________|
|XmNancestorSensitive | XmCSensitive | Boolean | dynamic | G |
|_____________________________|_______________________________|________________|______________________|________|
|XmNbackground | XmCBackground | Pixel | dynamic | CSG |
|_____________________________|_______________________________|________________|______________________|________|
|XmNbackgroundPixmap | XmCPixmap | Pixmap | XmUNSPECIFIED_PIXMAP| CSG |
|_____________________________|_______________________________|________________|______________________|________|
|XmNborderColor | XmCBorderColor | Pixel | XtDefaultForeground | CSG |
|_____________________________|_______________________________|________________|______________________|________|
|XmNborderPixmap | XmCPixmap | Pixmap | XmUNSPECIFIED_PIXMAP| CSG |
|_____________________________|_______________________________|________________|______________________|________|
|XmNborderWidth | XmCBorderWidth | Dimension | 0 | CSG |
|_____________________________|_______________________________|________________|______________________|________|
|XmNcolormap | XmCColormap | Colormap | dynamic | CG |
|_____________________________|_______________________________|________________|______________________|________|
|XmNdepth | XmCDepth | int | dynamic | CG |
|_____________________________|_______________________________|________________|______________________|________|
|XmNdestroyCallback | XmCCallback | XtCallbackList| NULL | C |
|_____________________________|_______________________________|________________|______________________|________|
|XmNheight | XmCHeight | Dimension | dynamic | CSG |
|_____________________________|_______________________________|________________|______________________|________|
|XmNinitialResourcesPersistent| XmCInitialResourcesPersistent| Boolean | True | C |
|_____________________________|_______________________________|________________|______________________|________|
|XmNmappedWhenManaged | XmCMappedWhenManaged | Boolean | True | CSG |
|_____________________________|_______________________________|________________|______________________|________|
|XmNscreen | XmCScreen | Screen * | dynamic | CG |
|_____________________________|_______________________________|________________|______________________|________|
|XmNsensitive | XmCSensitive | Boolean | True | CSG |
|_____________________________|_______________________________|________________|______________________|________|
|XmNtranslations | XmCTranslations | XtTranslations| dynamic | CSG |
|_____________________________|_______________________________|________________|______________________|________|
|XmNwidth | XmCWidth | Dimension | dynamic | CSG |
|_____________________________|_______________________________|________________|______________________|________|
|XmNx | XmCPosition | Position | 0 | CSG |
|_____________________________|_______________________________|________________|______________________|________|
|XmNy | XmCPosition | Position | 0 | CSG |
|_____________________________|_______________________________|________________|______________________|________|
Callback Information
A pointer to the following structure is passed to each callback:
typedef struct
{
int reason;
10/89 Page 7
XmToggleButton(3X) UNIX System V XmToggleButton(3X)
XEvent * event;
int set;
} XmToggleButtonCallbackStruct;
reason Indicates why the callback was invoked
event Points to the XEvent that triggered the callback
set Reflects the ToggleButton's current state when the callback
occurred, either True (selected) or False (unselected)
Translations
XmToggleButton includes translations from Primitive. The XmToggleButton
translations for buttons not in a menu system are listed below. These
translations may not directly correspond to a translation table.
Note that altering translations in #override or #augment mode is
undefined.
BSelect Press: Arm()
BSelect Release:Select()
Disarm()
KHelp: Help()
KActivate: ArmAndActivate()
KSelect: ArmAndActivate()
XmToggleButton inherits menu traversal translations from XmLabel.
Additional XmToggleButton translations for ToggleButtons in a menu system
are listed below. In a Popup menu system, BMenu also performs the
BSelect actions. These translations may not directly correspond to a
translation table.
BSelect Press: BtnDown()
BSelect Release:BtnUp()
KHelp: Help()
KActivate: ArmAndActivate()
KSelect: ArmAndActivate()
MAny KCancel: MenuShellPopdownOne()
Action Routines
The XmToggleButton action routines are described below:
Arm():
If the button was previously unset, this action does the following:
If XmNindicatorOn is True, it draws the indicator shadow so that
the indicator looks pressed; if XmNfillOnSelect is True, it fills
the indicator with the color specified by XmNselectColor. If
Page 8 10/89
XmToggleButton(3X) UNIX System V XmToggleButton(3X)
XmNindicatorOn is False, it draws the button shadow so that the
button looks pressed. If XmNlabelType is XmPIXMAP, the
XmNselectPixmap is used as the button face. Calls the
XmNarmCallback callbacks.
If the button was previously set, this action does the following:
If both XmNindicatorOn and XmNvisibleWhenOff are True, it draws the
indicator shadow so that the indicator looks raised; if
XmNfillOnSelect is True, it fills the indicator with the background
color. If XmNindicatorOn is False, it draws the button shadow so
that the button looks raised. If XmNlabelType is XmPIXMAP, the
XmNlabelPixmap is used as the button face. Calls the
XmNarmCallback callbacks.
ArmAndActivate():
If the ToggleButton was previously set, unsets it; if the
ToggleButton was previously unset, sets it.
In a menu, does the following: Unposts all menus in the menu
hierarchy. Unless the button is already armed, calls the
XmNarmCallback callbacks. Calls the XmNvalueChangedCallback and
XmNdisarmCallback callbacks.
Outside a menu, if the button was previously unset, this action
does the following: If XmNindicatorOn is True, it draws the
indicator shadow so that the indicator looks pressed; if
XmNfillOnSelect is True, it fills the indicator with the color
specified by XmNselectColor. If XmNindicatorOn is False, it draws
the button shadow so that the button looks pressed. If
XmNlabelType is XmPIXMAP, the XmNselectPixmap is used as the button
face. Calls the XmNarmCallback, XmNvalueChangedCallback, and
XmNdisarmCallback callbacks.
Outside a menu, if the button was previously set, this action does
the following: If both XmNindicatorOn and XmNvisibleWhenOff are
True, it draws the indicator shadow so that the indicator looks
raised; if XmNfillOnSelect is True, it fills the indicator with the
background color. If XmNindicatorOn is False, it draws the button
shadow so that the button looks raised. If XmNlabelType is
XmPIXMAP, the XmNlabelPixmap is used as the button face. Calls the
XmNarmCallback, XmNvalueChangedCallback, and XmNdisarmCallback
callbacks.
BtnDown():
This action unposts any menus posted by the ToggleButton's parent
menu, disables keyboard traversal for the menu, and enables mouse
traversal for the menu. It draws the shadow in the armed state
and, unless the button is already armed, calls the XmNarmCallback
callbacks.
10/89 Page 9
XmToggleButton(3X) UNIX System V XmToggleButton(3X)
BtnUp():
This action unposts all menus in the menu hierarchy. If the
ToggleButton was previously set, unsets it; if the ToggleButton was
previously unset, sets it. It calls the XmNvalueChangedCallback
callbacks and then the XmNdisarmCallback callbacks.
Disarm():
Calls the callbacks for XmNdisarmCallback.
Help():
In a Pulldown or Popup MenuPane, unposts all menus in the menu
hierarchy and restores keyboard focus to the tab group that had the
focus before the menu system was entered. Calls the callbacks for
XmNhelpCallback if any exist. If there are no help callbacks for
this widget, this action calls the help callbacks for the nearest
ancestor that has them.
MenuShellPopdownOne():
In a toplevel Pulldown MenuPane from a MenuBar, unposts the menu,
disarms the MenuBar CascadeButton and the MenuBar, and restores
keyboard focus to the tab group that had the focus before the
MenuBar was entered. In other Pulldown MenuPanes, unposts the
menu.
In a Popup MenuPane, unposts the menu and restores keyboard focus
to the widget from which the menu was posted.
Select():
If the pointer is within the button, takes the following actions:
If the button was previously unset, sets it; if the button was
previously set, unsets it. Calls the XmNvalueChangedCallback
callbacks.
Additional Behavior
This widget has the additional behavior described below:
<EnterWindow>:
In a menu, if keyboard traversal is enabled, this action does
nothing. Otherwise, it draws the shadow in the armed state and
calls the XmNarmCallback callbacks.
If the ToggleButton is not in a menu and the cursor leaves and then
reenters the ToggleButton's window while the button is pressed,
this action restores the button's armed appearance.
<LeaveWindow>:
In a menu, if keyboard traversal is enabled, this action does
nothing. Otherwise, it draws the shadow in the unarmed state and
calls the XmNdisarmCallback callbacks.
Page 10 10/89
XmToggleButton(3X) UNIX System V XmToggleButton(3X)
If the ToggleButton is not in a menu and the cursor leaves the
ToggleButton's window while the button is pressed, this action
restores the button's unarmed appearance.
Virtual Bindings
The bindings for virtual keys are vendor specific. For information about
bindings for virtual buttons and keys, see VirtualBindings(3X).
RELATED INFORMATION
Core(3X), XmCreateRadioBox(3X), XmCreateToggleButton(3X), XmLabel(3X),
XmPrimitive(3X), XmRowColumn(3X), XmToggleButtonGetState(3X), and
XmToggleButtonSetState(3X).
10/89 Page 11