XmPushButtonGadget(3X) UNIX System V XmPushButtonGadget(3X)
NAME
XmPushButtonGadget - the PushButtonGadget widget class.
SYNOPSIS
#include <Xm/PushBG.h>
DESCRIPTION
PushButtonGadget issues commands within an application. It consists of a
text label or pixmap surrounded by a border shadow. When PushButtonGadget
is selected, the shadow changes to give the appearance that the
PushButtonGadget has been pressed in. When PushButtonGadget is
unselected, the shadow changes to give the appearance that the
PushButtonGadget is out.
The default behavior associated with a PushButtonGadget in a menu depends
on the type of menu system in which it resides. By default, BSelect
controls the behavior of the PushButtonGadget. In addition, BMenu
controls the behavior of the PushButtonGadget if it resides in a
PopupMenu system. The actual mouse button used is determined by its
RowColumn parent.
Thickness for a second shadow may be specified by using the
XmNshowAsDefault resource. If it has a non-zero value, the Label's
resources XmNmarginLeft, XmNmarginRight, XmNmarginTop, and
XmNmarginBottom may be modified to accommodate the second shadow.
If an initial value is specified for XmNarmPixmap but not for
XmNlabelPixmap, the XmNarmPixmap value is used for XmNlabelPixmap.
Classes
PushButtonGadget inherits behavior and resources from Object, RectObj,
XmGadget and XmLabelGadget classes.
The class pointer is xmPushButtonGadgetClass.
The class name is XmPushButtonGadget.
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
10/89 Page 1
XmPushButtonGadget(3X) UNIX System V XmPushButtonGadget(3X)
applicable (N/A).
____________________________________________________________________________________________________________________
| XmPushButtonGadget |
|_______________________________|_________________________________|________________|______________________|________|
|Name | Class | Type | Default | Access|
|_______________________________|_________________________________|________________|______________________|________|
|_______________________________|_________________________________|________________|______________________|________|
|XmNactivateCallback | XmCCallback | XtCallbackList| NULL | C |
|_______________________________|_________________________________|________________|______________________|________|
|XmNarmCallback | XmCCallback | XtCallbackList| NULL | C |
|_______________________________|_________________________________|________________|______________________|________|
|XmNarmColor | XmCArmColor | Pixel | dynamic | CSG |
|_______________________________|_________________________________|________________|______________________|________|
|XmNarmPixmap | XmCArmPixmap | Pixmap | XmUNSPECIFIED_PIXMAP| CSG |
|_______________________________|_________________________________|________________|______________________|________|
|XmNdefaultButtonShadowThickness| XmCdefaultButtonShadowThickness| Dimension | dynamic | CSG |
|_______________________________|_________________________________|________________|______________________|________|
|XmNdisarmCallback | XmCCallback | XtCallbackList| NULL | C |
|_______________________________|_________________________________|________________|______________________|________|
|XmNfillOnArm | XmCFillOnArm | Boolean | True | CSG |
|_______________________________|_________________________________|________________|______________________|________|
|XmNmultiClick | XmCMultiClick | unsigned char | dynamic | CSG |
|_______________________________|_________________________________|________________|______________________|________|
|XmNshowAsDefault | XmCShowAsDefault | Dimension | 0 | CSG |
|_______________________________|_________________________________|________________|______________________|________|
XmNactivateCallback
Specifies the list of callbacks that is called when the
PushButtonGadget is activated. It is activated when the user
presses and releases the active mouse button while the pointer is
inside the PushButtonGadget. Activating PushButtonGadget also
disarms it. For this callback the reason is XmCR_ACTIVATE.
XmNarmCallback
Specifies the list of callbacks that is called when
PushButtonGadget is armed. It is armed when the user presses the
active mouse button while the pointer is inside the
PushButtonGadget. For this callback the reason is XmCR_ARM.
XmNarmColor
Specifies the color with which to fill the armed button.
XmNfillOnArm must be set to True for this resource to have an
effect. The 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, and any text in the
label appears in the background color when the button is armed.
XmNarmPixmap
Specifies the pixmap to be used as the button face if XmNlabeltype
is XmPIXMAP and PushButtonGadget is armed. This resource is
Page 2 10/89
XmPushButtonGadget(3X) UNIX System V XmPushButtonGadget(3X)
disabled when the PushButtonGadget is in a menu.
XmNdefaultButtonShadowThickness
This resource specifies the width of the default button indicator
shadow. If this resource is zero, the width of the shadow comes
from the value of the XmNshowAsDefault resource. If this resource
is greater than zero, the XmNshowAsDefault resource is only used to
specify whether this button is the default. The default value is
the initial value of XmNshowAsDefault.
XmNdisarmCallback
Specifies the list of callbacks that is called when the
PushButtonGadget is disarmed. PushButtonGadget is disarmed when
the user presses and releases the active mouse button while the
pointer is inside that gadget. For this callback, the reason is
XmCR_DISARM.
XmNfillOnArm
Forces the PushButtonGadget to fill the background of the button
with the color specified by XmNarmColor when the button is armed
and when this resource is set to True. If False, only the top and
bottom shadow colors are switched. When the PushButtonGadget is in
a menu, this resource is ignored and assumed to be False.
XmNmultiClick
If a button click is followed by another button click within the
time span specified by the display's multi-click time, and this
resource is set to XmMULTICLICK_DISCARD, do not process the second
click. If this resource is set to XmMULTICLICK_KEEP, process the
event and increment click_count in the callback structure. When
the PushButtonGadget is not in a menu, the default value is
XmMULTICLICK_KEEP.
XmNshowAsDefault
If XmNdefaultButtonShadowThickness is greater than zero, a value
greater than zero in this resource specifes to mark this button as
the default button. If XmNdefaultButtonShadowThickness is zero, a
value greater than zero in this resource specifies to mark this
button as the default button with the shadow thickness specified by
this resource. The space between the shadow and the default shadow
is equal to the sum of both shadows. The default value is zero.
When this value is not zero, the Label resources XmNmarginLeft,
XmNmarginRight, XmNmarginTop, and XmNmarginBottom may be modified
to accommodate the second shadow. This resource is disabled when
the PushButton is in a menu.
Inherited Resources
PushButtonGadget inherits behavior and resources from the following
superclasses. For a complete description of each resource, refer to the
man page for that superclass.
10/89 Page 3
XmPushButtonGadget(3X) UNIX System V XmPushButtonGadget(3X)
___________________________________________________________________________________________________________
| XmLabelGadget 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 | dynamic | 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 | dynamic | 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 |
|_________________________|___________________________|___________________|______________________|________|
Page 4 10/89
XmPushButtonGadget(3X) UNIX System V XmPushButtonGadget(3X)
_____________________________________________________________________________________
| XmGadget Resource Set |
|_____________________|_______________________|__________________|_________|________|
|Name | Class | Type | Default| Access|
|_____________________|_______________________|__________________|_________|________|
|_____________________|_______________________|__________________|_________|________|
|XmNhelpCallback | XmCCallback | XtCallbackList | NULL | C |
|_____________________|_______________________|__________________|_________|________|
|XmNhighlightOnEnter | XmCHighlightOnEnter | Boolean | False | CSG |
|_____________________|_______________________|__________________|_________|________|
|XmNhighlightThickness| XmCHighlightThickness| Dimension | 2 | CSG |
|_____________________|_______________________|__________________|_________|________|
|XmNnavigationType | XmCNavigationType | XmNavigationType| XmNONE | G |
|_____________________|_______________________|__________________|_________|________|
|XmNshadowThickness | XmCShadowThickness | Dimension | 2 | CSG |
|_____________________|_______________________|__________________|_________|________|
|XmNtraversalOn | XmCTraversalOn | Boolean | True | CSG |
|_____________________|_______________________|__________________|_________|________|
|XmNunitType | XmCUnitType | unsigned char | dynamic| CSG |
|_____________________|_______________________|__________________|_________|________|
|XmNuserData | XmCUserData | Pointer | NULL | CSG |
|_____________________|_______________________|__________________|_________|________|
______________________________________________________________________
| RectObj Resource Set |
|_____________________|________________|___________|_________|________|
| Name | Class | Type | Default| Access|
|_____________________|________________|___________|_________|________|
|_____________________|________________|___________|_________|________|
| XmNancestorSensitive| XmCSensitive | Boolean | dynamic| G |
|_____________________|________________|___________|_________|________|
| XmNborderWidth | XmCBorderWidth| Dimension| 0 | CSG |
|_____________________|________________|___________|_________|________|
| XmNheight | XmCHeight | Dimension| dynamic| CSG |
|_____________________|________________|___________|_________|________|
| XmNsensitive | XmCSensitive | Boolean | True | CSG |
|_____________________|________________|___________|_________|________|
| XmNwidth | XmCWidth | Dimension| dynamic| CSG |
|_____________________|________________|___________|_________|________|
| XmNx | XmCPosition | Position | 0 | CSG |
|_____________________|________________|___________|_________|________|
| XmNy | XmCPosition | Position | 0 | CSG |
|_____________________|________________|___________|_________|________|
______________________________________________________________________
Object Resource Set
______________________________________________________________________
Name Class Type Default Access
______________________________________________________________________
______________________________________________________________________
XmNdestroyCallback XmCCallback XtCallbackList NULL C
______________________________________________________________________
10/89 Page 5
XmPushButtonGadget(3X) UNIX System V XmPushButtonGadget(3X)
| | | | | |
| | | | | |
C
|allback Information| | | | |
| A pointer to the f
|ollowing struc
|ture is passed to
| each call
|back: |
| | | | | |
| typedef struct | | | | |
| { | | | | |
| int reason;
| | | | |
| XEvent * event
|; | | | |
| int click_c
|ount; | | | |
| } XmPushButtonCall
|backStruct; | | | |
| | | | | |
| | | | | |
| reason Indicates wh
|y the callback
| was invoked. | | |
| | | | | |
| event Points to th
|e XEvent that|triggered the cal
|lback. | |
| | | | | |
| click_count | | | | |
| This value|is valid only|when the reason i
|s XmCR_ACT
|IVATE. I
|t
| contains th
|e number of cl
|icks in the last|multiclick
| sequence
| if
| the XmNmult
|iClick resourc
|e is set to XmMUL
|TICLICK_KE
|EP, other
|wise
| it contains
| 1. The acti↓ate callback is i
|nvoked for
| each cli
|ck if
| XmNmultiCli
|ck is set to X
|mMULTICLICK_KEEP.
| | |
| | | | | |
| | | | | |
B
|ehavior | | | | |
| XmPushButtonGadget
| includes beha
|vior from XmGadge
|t. XmPush
|ButtonGad
|get
| includes menu tra↓ersal behavior
| from XmLabelGadg
|et. Addit
|ional beh
|avior
| for XmPushButtonGa
|dget is descri
|bed below: | | |
| | | | | |
| BSelect Press: | | | | |
| This action|arms the PushB
|uttonGadget. | | |
| | | | | |
| In a menu, t
|his action unp
|osts any menus po
|sted by th
|e |
| PushButtonGa
|dget's parent|menu, disables ke
|yboard tra
|versal fo
|r the
| menu, and en
|ables mouse tr
|aversal for the m
|enu. It d
|raws the|
| shadow in th
|e armed state.
| Unless the butt
|on is alre
|ady armed
|, it
| calls the Xm
|NarmCallback c
|allbacks. | | |
| | | | | |
| If the butto
|n is not in a|menu, this action
| draws the
| shadow i
|n the
| armed state.
| If XmNfillOn
|Arm is set to Tru
|e, it fill
|s the but
|ton
| with the col
|or specified b
|y XmNarmColor. I
|f XmNlabel
|Type is |
| XmPIXMAP, th
|e XmNarmPixmap
| is used for the|button fac
|e. It ca
|lls
| the XmNarmCa
|llback callbac
|ks. | | |
| | | |
BSelect Press 2+:
If XmNmultiClick is XmMULTICLICK_DISCARD, this action does nothing.
If XmNmultiClick is XmMULTICLICK_KEEP, this action does the
following: Draws the shadow in the armed state. If the button is
not in a menu and if XmNfillOnArm is set to True, fills the button
Page 6 10/89
XmPushButtonGadget(3X) UNIX System V XmPushButtonGadget(3X)
with the color specified by XmNarmColor. If XmNlabelType is
XmPIXMAP, the XmNarmPixmap is used for the button face. Calls the
XmNarmCallback callbacks.
BSelect Click or BSelect Release:
In a menu, this action unposts all menus in the menu hierarchy and
activates the PushButtonGadget. It calls the XmNactivateCallback
callbacks and then the XmNdisarmCallback callbacks.
If the PushButtonGadget is not in a menu, this action draws the
shadow in the unarmed state. If XmNfillOnArm is set to True, the
background color reverts to the unarmed color. If XmNlabelType is
XmPIXMAP, the XmNlabelPixmap is used for the button face. If the
pointer is still within the button, this action calls the callbacks
for XmNactivateCallback. Calls the callbacks for
XmNdisarmCallback.
BSelect Release 2+:
If XmNmultiClick is XmMULTICLICK_DISCARD, this action does nothing.
If XmNmultiClick is XmMULTICLICK_KEEP, this action does the
following: Increments click_count in the callback structure.
Draws the shadow in the unarmed state. If the button is not in a
menu and if XmNfillOnArm is set to True, the background color
reverts to the unarmed color. If XmNlabelType is XmPIXMAP, the
XmNlabelPixmap is used for the button face. If the pointer is
within the PushButtonGadget, calls the callbacks for
XmNactivateCallback. Calls the callbacks for XmNdisarmCallback.
KActivate or KSelect:
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 XmNactivateCallback and
XmNdisarmCallback callbacks.
Outside a menu, does the following: Draws the shadow in the armed
state and, if XmNfillOnArm is set to True, fills the button with
the color specified by XmNarmColor. If XmNlabelType is XmPIXMAP,
the XmNarmPixmap is used for the button face. Calls the
XmNarmCallback callbacks.
Outside a menu, this action also arranges for the following to
happen, either immediately or at a later time: The shadow is drawn
in the unarmed state and, if XmNfillOnArm is set to True, the
background color reverts to the unarmed color. If XmNlabelType is
XmPIXMAP, the XmNlabelPixmap is used for the button face. The
XmNactivateCallback and XmNdisarmCallback callbacks are called.
KHelp:
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
10/89 Page 7
XmPushButtonGadget(3X) UNIX System V XmPushButtonGadget(3X)
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.
MAny KCancel:
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.
<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 PushButtonGadget is not in a menu and the cursor leaves and
then reenters the PushButtonGadget while the button is pressed,
this action draws the shadow in the armed state. If XmNfillOnArm
is set to True, it also fills the button with the color specified
by XmNarmColor. If XmNlabelType is XmPIXMAP, the XmNarmPixmap is
used for the button face.
<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 PushButtonGadget is not in a menu and the cursor leaves the
PushButtonGadget while the button is pressed, this action draws the
shadow in the unarmed state. If XmNfillOnArm is set to True, the
background color reverts to the unarmed color. If XmNlabelType is
XmPIXMAP, the XmNlabelPixmap is used for the button face.
Virtual Bindings
The bindings for virtual keys are vendor specific. For information about
bindings for virtual buttons and keys, see VirtualBindings(3X).
RELATED INFORMATION
Object(3X), RectObj(3X), XmCreatePushButtonGadget(3X), XmGadget(3X),
XmLabelGadget(3X), and XmRowColumn(3X).
Page 8 10/89