XmArrowButtonGadget(3X) UNIX System V XmArrowButtonGadget(3X)
NAME
XmArrowButtonGadget - The ArrowButtonGadget widget class.
SYNOPSIS
#include <Xm/ArrowBG.h>
DESCRIPTION
ArrowButtonGadget consists of a directional arrow surrounded by a border
shadow. When it is selected, the shadow changes to give the appearance
that the ArrowButtonGadget has been pressed in. When it is unselected,
the shadow reverts to give the appearance that the button is released, or
out.
Classes
ArrowButtonGadget inherits behavior and resources from Object, RectObj,
and XmGadget classes.
The class pointer is xmArrowButtonGadgetClass.
The class name is XmArrowButtonGadget.
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).
________________________________________________________________________________
ArrowButtonGadget Resource Set
________________________________________________________________________________
Name Class Type Default Access
________________________________________________________________________________
________________________________________________________________________________
XmNactivateCallback XmCCallback XtCallbackList NULL C
________________________________________________________________________________
XmNarmCallback XmCCallback XtCallbackList NULL C
________________________________________________________________________________
XmNarrowDirection XmCArrowDirection unsigned char XmARROW_UP CSG
________________________________________________________________________________
XmNdisarmCallback XmCCallback XtCallbackList NULL C
________________________________________________________________________________
10/89 Page 1
XmArrowButtonGadget(3X) UNIX System V XmArrowButtonGadget(3X)
| XmNmultiClick | XmCMultiClick | unsigned char | dynamic | CSG |
|____________________|___________________|________________|____________|________|
XmNactivateCallback
Specifies a list of callbacks that is called when the
ArrowButtonGadget is activated. To activate the button, press and
release BSelect while the pointer is inside the ArrowButtonGadget.
Activating the ArrowButtonGadget also disarms it. The reason sent
by this callback is XmCRACTIVATE.
XmNarmCallback
Specifies a list of callbacks that is called when the
ArrowButtonGadget is armed. To arm this widget, press BSelect
while the pointer is inside the ArrowButtonGadget. The reason sent
by this callback is XmCRARM.
XmNarrowDirection
Sets the arrow direction. The values for this resource are:
⊕ XmARROW_UP.
⊕ XmARROW_DOWN.
⊕ XmARROW_LEFT.
⊕ XmARROW_RIGHT.
XmNdisarmCallback
Specifies a list of callbacks that is called when the
ArrowButtonGadget is disarmed. To disarm this widget, press and
release BSelect while the pointer is inside the ArrowButtonGadget.
The reason sent by this callback is XmCR_DISARM.
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 ArrowButtonGadget is not in a menu, the default value is
XmMULTICLICK_KEEP.
Inherited Resources
ArrowButtonGadget inherits behavior and resources from the following
superclasses. For a complete description of each resource, refer to the
man page for that superclass.
Page 2 10/89
XmArrowButtonGadget(3X) UNIX System V XmArrowButtonGadget(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 3
XmArrowButtonGadget(3X) UNIX System V XmArrowButtonGadget(3X)
| | | | | |
| | | | | |
Call
|back Information | | | | |
A
| pointer to the foll
|owing structur
|e is passed to ea
|ch callbac
|k: |
| | | | | |
t
|ypedef struct | | | | |
{
| | | | | |
| int reason; | | | | |
| XEvent * event; | | | | |
| int click_coun
|t; | | | |
|
} XmArrowButtonCallba
|ckStruct; | | | |
| | | | | |
| | | | | |
re
|ason Indicates why t
|he callback wa
|s invoked. | | |
| | | | | |
e↓ent Points to the X
|Event that tri
|ggered the callba
|ck. | |
| | | | | |
cl
|ick_count | | | | |
| This value is|valid only whe
|n the reason is X
|mCR_ACTIVA
|TE. It |
| contains the n
|umber of click
|s in the last mul
|ticlick se
|quence if
|
| the XmNmultiCl
|ick resource i
|s set to XmMULTIC
|LICK_KEEP,
| otherwis
|e
| it contains 1.
| The activate
| callback is invo
|ked for ea
|ch click|if
| XmNmultiClick|is set to XmMU
|LTICLICK_KEEP. | | |
| | | | | |
| | | | | |
Beha
|vior | | | | |
X
|mArrowButtonGadget i
|ncludes behavi
|or from XmGadget.
| Addition
|al |
X
|mArrowButtonGadget b
|ehavior is des
|cribed below: | | |
| | | | | |
B
|Select Press: | | | | |
| Draws the shado
|w in the selec
|ted state and cal
|ls the cal
|lbacks fo
|r
| XmNarmCallback.
| | | | |
| | | | | |
B
|Select Click or BSel
|ectRelease: | | | |
| Draws the shado
|w in the unsel
|ected state. If|the pointe
|r is with
|in
| the ArrowButton
|Gadget, calls|the callbacks for
| XmNactiva
|teCallbac
|k.
| Calls the callb
|acks for XmNdi
|sarmCallback. | | |
| | | | | |
B
|Select Press 2+: | | | | |
| If XmNmultiClic
|k is XmMULTICL
|ICK_DISCARD, this
| action do
|es nothin
|g.
| If XmNmultiClic
|k is XmMULTICL
|ICK_KEEP, this ac
|tion draws
| the shad
|ow
| in the selected
| state and cal
|ls the callbacks|for XmNarm
|Callback.
|
| | | | | |
B
|Select Release 2+: | | | | |
If XmNmultiClic
|k is XmMULTICL
|ICK_DISCARD, this
| action do
|es nothing.
If XmNmultiClick is XmMULTICLICK_KEEP, this action does the
following: Increments click_count in the callback structure.
Draws the shadow in the unselected state. If the pointer is within
the ArrowButtonGadget, calls the callbacks for XmNactivateCallback.
Calls the callbacks for XmNdisarmCallback.
Page 4 10/89
XmArrowButtonGadget(3X) UNIX System V XmArrowButtonGadget(3X)
KActivate or KSelect:
Draws the shadow in the selected state and calls the callbacks for
XmNarmCallback. Arranges for the shadow to be drawn in the
unselected state and the callbacks for XmNactivateCallback and
XmNdisarmCallback to be called, either immediately or at a later
time.
KHelp:
Calls the callbacks for XmNhelpCallback if any exist. If there are
no help callbacks for this widget, this calls the help callbacks
for the nearest ancestor that has them.
<Enter>:
Draws the ArrowButtonGadget shadow in its selected state if the
pointer leaves and re-enters the gadget while BSelect is pressed.
<Leave>:
Draws the ArrowButtonGadget shadow in its unselected state if the
pointer leaves the gadget while BSelect is pressed.
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), XmCreateArrowButtonGadget(3X), and XmGadget(3X).
10/89 Page 5