NAME

       XmToggleButtonGadget  — The ToggleButtonGadget widget class "XmToggleButtonGadget" "widget
       class" "ToggleButtonGadget"

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

       ┌─────────────────────────────────────────────────────────────────────────────────────────────────────────┐
--

RELATED

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

                                                                          XmToggleButtonGadget(3)