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 moves to give the appearance that the ArrowButtonGadget has been pressed in.  When it is unselected, the shadow moves 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 lower case or upper case, 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). 

XmNactivateCallback
Specifies a list of callbacks that is called when the ArrowButtonGadget is activated. To activate the button, press and release mouse button 1 while the pointer is inside the ArrowButtonGadget.  Activating the ArrowButtonGadget also disarms it. The reason sent by this callback is XmCR_ACTIVATE. 

XmNarmCallback
Specifies a list of callbacks that is called when the ArrowButtonGadget is armed. To arm this widget, press mouse button 1 while the pointer is inside the ArrowButtonGadget. For this callback the reason is XmCR_ARM. 

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 mouse button one while the pointer is inside the ArrowButtonGadget. For this callback  the reason is XmCR_DISARM. 

Inherited Resources

ArrowButtonGadget inherits behavior and resources from the following superclasses.  For a complete description of these resources, refer to the man page for that superclass. 

Callback Information

The following structure is returned with each callback:

typedef struct
{
intreason;
XEvent∗ event;
} XmAnyCallbackStruct;

reasonIndicates why the callback was invoked. 

eventPoints to the XEvent that triggered the callback.  This event will be NULL for the XmNactivateCallback if the callback was triggered when Primitive’s resource XmNtraversalOn was True or if the callback was accessed through the ArmAndActivate action routine. 

Behavior

<Btn1Down>:
This action causes the arrow to be armed, and the shadow to be drawn in the selected state. The callbacks for XmNarmCallback are called. 

<Btn1Up>:
If the mouse button release occurs when the pointer is within the ArrowButtonGadget, then the  arrow shadows are redrawn in the unselected state. The callbacks for XmNactivateCallback are called, followed by callbacks for XmNdisarmCallback. 

If the mouse button release occurs when the pointer is outside the ArrowButtonGadget, the callbacks for XmNdisarmCallback are called. 

<Leave Window>:
If the mouse button is pressed and the cursor leaves the widget’s window, the arrow shadow will be redrawn in its unselected state.

<Enter Window>:
If the mouse button is pressed and the cursor leaves and re-enters the widget’s window, the arrow shadow  will be drawn in the same manner as when the button was first armed.

Keyboard Traversal

For information on keyboard traversal, see the man page for XmGadget(3Xm) and its sections on behavior and default translations. 

RELATED INFORMATION

Object(3Xm), RectObj(3Xm), XmCreateArrowButtonGadget(3Xm), and XmGadget(3Xm). 

7th Edition