Tribblix: manual page: XmToggleButtonGadget.3

XmToggleButtonGadget(library call) XmToggleButtonGadget(library call)

NAME

XmToggleButtonGadget -- The ToggleButtonGadget widget class

SYNOPSIS

#include <Xm/ToggleBG.h>

DESCRIPTION

ToggleButtonGadget sets nontransitory state data within an
application. Usually this gadget consists of an indicator (square,
diamond, or round) 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, N-of-many, or N-of-many-
round selection state. When a toggle indicator is displayed, a
square indicator shows an N-of-many selection state, a diamond-shaped
indicator shows a 1-of-many selection state, and a circle-shaped
indicator shows a 1-of-many-round selection state.

ToggleButtonGadget implies a set or unset state. In the case of a
label and an indicator, an empty indicator (square, diamond, or
round) indicates that ToggleButtonGadget is unset, and a filled
indicator shows that it is set. The indicator may be filled with a
check mark or the select color. In the case of a pixmap toggle,
different pixmaps are used to display the set/unset states.
ToggleButtonGadget can also indicate an indeterminate state. In the
case of a label and an indicator, an indeterminate state is indicated
by a stippled flat box. In the case of a pixmap toggle, a different
pixmap is used to display the indeterminate state.

The default behavior associated with a ToggleButtonGadget in a menu
depends on the type of menu system in which it resides. By default,
<Btn1> controls the behavior of the ToggleButtonGadget. In addition,
<Btn3> controls the behavior of the ToggleButtonGadget if it resides
in a PopupMenu system. The actual mouse button used is determined by
its RowColumn parent.

Label's resource XmNmarginLeft may be increased to accommodate the
toggle indicator when it is created.

ToggleButtonGadget uses the XmQTmenuSystem and XmQTspecifyRenderTable
traits.

Classes

ToggleButtonGadget inherits behavior, resources, and traits from
Object, RectObj, XmGadget and XmLabelGadget.

The class pointer is xmToggleButtonGadgetClass.

The class name is XmToggleButtonGadget.

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 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).

+---------------------------------------------------------------------------------------------------------+
| XmToggleButtonGadget Resource Set |
|Name | Class | Type | Default | Access |
+---------------------------+----------------------------+----------------+----------------------+--------+
|XmNarmCallback | XmCArmCallback | XtCallbackList | NULL | C |
+---------------------------+----------------------------+----------------+----------------------+--------+
|XmNdetailShadowThickness | XmCDetailShadowThickness | Dimension | 2 | CSG |
+---------------------------+----------------------------+----------------+----------------------+--------+
|XmNdisarmCallback | XmCDisarmCallback | XtCallbackList | NULL | C |
+---------------------------+----------------------------+----------------+----------------------+--------+
|XmNfillOnSelect | XmCFillOnSelect | Boolean | dynamic | CSG |
+---------------------------+----------------------------+----------------+----------------------+--------+
|XmNindeterminatePixmap | XmCIndeterminatePixmap | Pixmap | XmUNSPECIFIED_PIXMAP | CSG |
+---------------------------+----------------------------+----------------+----------------------+--------+
|XmNindicatorOn | XmCIndicatorOn | unsigned char | XmINDICATOR_FILL | 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 | unsigned char | XmUNSET | CSG |
+---------------------------+----------------------------+----------------+----------------------+--------+
|XmNspacing | XmCSpacing | Dimension | 4 | CSG |
+---------------------------+----------------------------+----------------+----------------------+--------+
|XmNtoggleMode | XmCToggleMode | unsigned char | XmTOGGLE_BOOLEAN | CSG |
+---------------------------+----------------------------+----------------+----------------------+--------+
|XmNunselectColor | XmCUnselectColor | Pixel | dynamic | CSG |
+---------------------------+----------------------------+----------------+----------------------+--------+
|XmNvalueChangedCallback | XmCValueChangedCallback | XtCallbackList | NULL | C |
+---------------------------+----------------------------+----------------+----------------------+--------+
|XmNvisibleWhenOff | XmCVisibleWhenOff | Boolean | dynamic | CSG |
+---------------------------+----------------------------+----------------+----------------------+--------+
+---------------------------+----------------------------+----------------+----------------------+--------+
XmNarmCallback
Specifies a list of callbacks that is called when the
ToggleButtonGadget is armed. To arm this gadget, press the
active mouse button while the pointer is inside the
ToggleButtonGadget. For this callback, the reason is
XmCR_ARM.

XmNdetailShadowThickness
Specifies the thickness of the indicator shadow. The
default thickness is 2 pixels.

XmNdisarmCallback
Specifies a list of callbacks called when
ToggleButtonGadget is disarmed. To disarm this gadget,
press and release the active mouse button while the pointer
is inside the ToggleButtonGadget. The gadget is also
disarmed when the user moves out of the gadget and releases
the mouse button when the pointer is outside the gadget.
For this callback, the reason is XmCR_DISARM.

XmNfillOnSelect
Fills the indicator with the color specified in
XmNselectColor and switches the top and bottom shadow
colors when set to True. If unset, fills the indicator with
the unselect color. If indeterminate, fills the indicator
with half select color and half unselect color. Otherwise,
it switches only the top and bottom shadow colors. The
default is set True only if a box type of indicator (such
as a check box) is specified, or if the XmNindicatorType is
a 1-of type and a toggle indicator is drawn. If
XmNfillOnSelect is True, XmNset is XmSET, and
XmNindicatorOn is XmINDICATOR_NONE the ToggleButtonGadget's
background is set to XmNselectColor. For the other
XmNindicatorOn values, only the indicator is filled with
XmNselectColor.

XmNindeterminateInsensitivePixmap
Specifies the pixmap to be displayed as the button face
when the Label XmNlableType resource is XmPIXMAP or
XmPIXMAP_AND_STRING, the ToggleButtonGadget XmNset resource
is XmINDETERMINATE, and the Core XmNsensitive resource is
False.

XmNindeterminatePixmap
Specifies the pixmap to be displayed as the button face
when the Label XmNlableType resource is XmPIXMAP or
XmPIXMAP_AND_STRING, the ToggleButtonGadget XmNset resource
is XmINDETERMINATE, and the Core XmNsensitive resource is
True.

XmNindicatorOn
Specifies that if a toggle indicator is to be drawn, it
will be drawn to one side of the toggle text or pixmap,
depending on the XmNlayoutDirection resource of the widget.
The default value is XmINDICATOR_FILL. Toggles accept the
following values:

XmINDICATOR_NONE
No space is allocated for the indicator, and it
is not displayed. Any shadows around the entire
widget are switched when the toggle is selected
or unselected.

XmINDICATOR_BOX
The toggle indicator is in the shape of a
shadowed box.

XmINDICATOR_FILL
If the value of the XmDisplay
XmNenableToggleVisual resource is True , the
visuals are those of XmINDICATOR_CHECK_BOX ; if
False , the indicator visuals are those of
XmINDICATOR_BOX.

XmINDICATOR_CHECK
The toggle indicator is in the shape of a
checkmark in the foreground color.

XmINDICATOR_CHECK_BOX
The toggle indicator is in the shape of a
checkmark enclosed in a box. This is the default
if the XmDisplay XmNenableToggleVisual resource
is set.

XmINDICATOR_CROSS_BOX
The toggle indicator is in the shape of a cross
enclosed in a box.

XmINDICATOR_CROSS
The toggle indicator is in the shape of a cross.

All ToggleButton checks and crosses should be drawn in the
foreground color.

If this resource is not XmINDICATOR_NONE, it will control
the appearance of the toggle visual. If XmNset is
XmINDETERMINATE and XmNindicatorOn is not XmINDICATOR_NONE,
this resource shows a stippled flat box. If XmNset is
XmINDETERMINATE, XmNindicatorOn is XmINDICATOR_NONE, and
XmNtoggleMode is XmTOGGLE_INDETERMINATE, the label and the
ToggleButton are stippled with a combination of the
XmNselectColor and the XmNunselectColor color, and the
border is flat.

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. The size of indicators
inside menus may differ from those outside of menus. Note
that a change in this resource may also cause a change in
the values of the inherited resources XmNmarginTop,
XmNmarginBottom, and XmNmarginLeft.

XmNindicatorType
Specifies if the indicator is a 1-of or N-of indicator. For
the 1-of indicator, the value can be XmONE_OF_MANY,
XmONE_OF_MANY_ROUND, or XmONE_OF_MANY_DIAMOND. For the N-
of indicator, the value is XmN_OF_MANY. This value
specifies only the visuals and does not enforce the
behavior. When the ToggleButton is in a radio box, the
default is XmONE_OF_MANY; otherwise, the default is
XmN_OF_MANY. Legal values are:

XmONE_OF_MANY
When the Display XmNenableToggleVisual resource
is set, indicators are drawn with the same
appearance as XmONE_OF_MANY_ROUND; otherwise,
they appear the same as XmONE_OF_MANY_DIAMOND.

XmN_OF_MANY
The indicators are drawn as specified by the
XmNindicatorOn resource.

XmONE_OF_MANY_ROUND
A shadowed circle.

XmONE_OF_MANY_DIAMOND
A shadowed diamond.

XmNselectColor
Allows the application to specify what color fills the
center of the square, diamond-shaped, or round 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. The results of this
resource depend on the value of the Display resource
XmNenableToggleColor. A value of True causes the fill color
to use the XmHIGHLIGHT_COLOR color by default. A value of
False causes the fill color to use the background color.
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. To set the background of the button to
XmNselectColor when XmNindicatorOn is XmINDICATOR_NONE, the
value of XmNfillOnSelect must be explicitly set to True.

This resource can take the following values:

XmDEFAULT_SELECT_COLOR
Is the same as the current dynamic default, which
is a color between the background and the bottom
shadow color.

XmREVERSED_GROUND_COLORS
Forces the select color to the foreground color
and causes the default color of any text rendered
over the select color to be in the background
color.

XmHIGHLIGHT_COLOR
Forces the fill color to use the highlight color.

XmNselectInsensitivePixmap
Specifies a pixmap used as the button face when the
ToggleButtonGadget is selected, the button is insensitive,
and the LabelGadget resource XmNlabelType is XmPIXMAP or
XmPIXMAP_AND_STRING. If the ToggleButtonGadget 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.

XmNselectPixmap
Specifies the pixmap to be used as the button face if
XmNlabelType is XmPIXMAP or XmPIXMAP_AND_STRING, and the
ToggleButtonGadget is selected. When the
ToggleButtonGadget is unselected, the pixmap specified in
LabelGadget's XmNlabelPixmap is used. If no value is
specified for XmNlabelPixmap, that resource is set to the
value specified for XmNselectPixmap.

XmNset Represents the state of the ToggleButton. A value of
XmUNSET indicates that the ToggleButton is not set. A value
of XmSET indicates that the ToggleButton is set. A value of
XmINDETERMINATE indicates that the ToggleButton is in an
indeterminate state (neither set nor unset). The
ToggleButton states cycle through in the order of XmSET,
XmINDETERMINATE (if XmNtoggleMode is set to
XmTOGGLE_INDETERMINATE), and XmUNSET, and then back around
to XmSET. If XmNtoggleMode is set to XmTOGGLE_BOOLEAN, then
the ToggleButton states cycle through in the order of
XmSET, then XmUNSET, and then back around to XmSET.
Setting this resource sets the state of the ToggleButton.

XmNspacing
Specifies the amount of spacing between the toggle
indicator and the toggle label (text or pixmap).

XmNtoggleMode
Specifies the mode of the ToggleButtonGadget as either
XmTOGGLE_BOOLEAN or XmTOGGLE_INDETERMINATE. The
XmTOGGLE_INDETERMINATE value allows the XmNset resource to
be able to accept the values XmINDETERMINATE, XmSET, and
XmUNSET. The XmNtoggleMode resource is forced to
XmTOGGLE_BOOLEAN if the toggle is in an XmRowColumn widget
whose radio behavior is XmONE_OF_MANY. In XmTOGGLE_BOOLEAN
mode, the XmNset resource can only accept XmSET and
XmUNSET.

XmNunselectColor
Allows the application to specify what color fills the
center of the square, diamond-shaped, or round indicator
when it is not 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 XmNbackground. For a
monochrome display, the default is set to the background
color. To set the background of the button to
XmNunselectColor when XmNindicatorOn is XmINDICATOR_NONE,
the value of XmNfillOnSelect must be explicitly set to
True. This resource acts like the XmNselectColor resource,
but for the case when XmNset is XmUNSET.

XmNvalueChangedCallback
Specifies a list of callbacks called when the
ToggleButtonGadget value is changed. To change the value,
press and release the active mouse button while the pointer
is inside the ToggleButtonGadget. This action also causes
the gadget 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
ToggleButtonGadget is in a menu, the default value is
False. When the ToggleButtonGadget is in a RadioBox, the
default value is True.

Inherited Resources

Callback Information

A pointer to the following structure is passed to each callback:

typedef struct
{
int reason;
XEvent * event;
int set;
} XmToggleButtonCallbackStruct;

reason Indicates why the callback was invoked

event Points to the XEvent that triggered the callback

set Reflects the ToggleButtonGadget's state, either XmSET
(selected), XmUNSET (unselected), or XmINDETERMINATE
(neither). Note that the reported state is the state that
the ToggleButtonGadget is in after the event has been
processed. For example, suppose that a user clicks on a
ToggleButtonGadget to change it from the unselected state
to the selected state. In this case, ToggleButtonGadget
changes the value of set from XmUNSET to XmSET prior to
calling the callback.

Behavior

XmToggleButtonGadget includes behavior from XmGadget.
XmToggleButtonGadget includes menu traversal behavior from
XmLabelGadget. Additional XmToggleButtonGadget behavior is described
in the following list:

<Btn2Down>:
Drags the contents of a ToggleButtonGadget label,
identified when <Btn2> is pressed. This action is
undefined for ToggleButtonGadgets used in a menu system.

<Btn1Down>:
In a menu, this action unposts any menus posted by the
ToggleButtonGadget'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.

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 or
XmPIXMAP_AND_STRING, the XmNselectPixmap is used as the
button face. This resource calls the XmNarmCallback
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 or
XmPIXMAP_AND_STRING, the XmNlabelPixmap is used as the
button face. This resource calls the XmNarmCallback
callbacks.

<Btn1Up>: In a menu, this action unposts all menus in the menu
hierarchy. If the ToggleButtonGadget was previously set,
this action unsets it; if the ToggleButtonGadget was
previously unset, this action sets it. It calls the
XmNvalueChangedCallback callbacks and then the
XmNdisarmCallback callbacks.

If the button is outside a menu and the pointer is within
the button, this action does the following: if the button
was previously unset, sets it; if the button was previously
set, unsets it. This action calls the
XmNvalueChangedCallback callbacks.

If the button is outside a menu, this action calls the
XmNdisarmCallback callbacks.

<Key><osfHelp>:
In a Pulldown or Popup MenuPane, unposts all menus in the
menu hierarchy and, when the shell's keyboard focus policy
is XmEXPLICIT, restores keyboard focus to the widget 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.

<Key><osfActivate>:
In a menu, this action unposts all menus in the menu
hierarchy. Unless the button is already armed, this action
calls the XmNarmCallback callbacks; and calls the
XmNvalueChangedCallback and XmNdisarmCallback callbacks.
Outside a menu, if the parent is a manager, this action
passes the event to the parent.

<Key><osfSelect>:
If the ToggleButtonGadget was previously set, this action
unsets it; if the ToggleButtonGadget was previously unset,
this action sets it.

In a menu, this action unposts all menus in the menu
hierarchy. Unless the button is already armed, this action
calls the XmNarmCallback, 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 or
XmPIXMAP_AND_STRING, the XmNselectPixmap is used as the
button face. This action calls the XmNarmCallback,
XmNvalueChangedCallback, 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 or
XmPIXMAP_AND_STRING, the XmNlabelPixmap is used as the
button face. Calls the XmNarmCallback,
XmNvalueChangedCallback, and XmNdisarmCallback callbacks.

<Key><osfCancel>:
In a toplevel Pulldown MenuPane from a MenuBar, unposts the
menu, disarms the MenuBar CascadeButton and the MenuBar,
and, when the shell's keyboard focus policy is XmEXPLICIT,
restores keyboard focus to the widget that had the focus
before the MenuBar was entered. In other Pulldown
MenuPanes, this action unposts the menu. Outside a menu,
if the parent is a manager, this action passes the event to
the parent.

In a Popup MenuPane, this action unposts the menu and
restores keyboard focus to the widget from which the menu
was posted.

<Enter>: 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 ToggleButtonGadget is not in a menu and the cursor
leaves and then reenters the ToggleButtonGadget while the
button is pressed, this action restores the button's armed
appearance.

<Leave>: 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.

If the ToggleButtonGadget is not in a menu and the cursor
leaves the ToggleButtonGadget 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(3).

Object(3), RectObj(3), XmCreateRadioBox(3),
XmCreateToggleButtonGadget(3), XmGadget(3), XmLabelGadget(3),
XmRowColumn(3), XmToggleButtonGadgetGetState(3),
XmToggleButtonGadgetSetState(3), XmVaCreateToggleButtonGadget(3), and
XmVaCreateManagedToggleButtonGadget(3).

XmToggleButtonGadget(library call)