XmArrowButton(Xm) UNIX System V
NAME
XmArrowButton - the ArrowButton widget class.
SYNOPSIS
#include <Xm/ArrowB.h>
DESCRIPTION
ArrowButton consists of a directional arrow surrounded by a
border shadow. When it is selected, the shadow moves to
give the appearance that the ArrowButton has been pressed
in. When the ArrowButton is unselected, the shadow moves to
give the appearance that the ArrowButton is released, or
out.
Classes
ArrowButton inherits behavior and resources from Core and
XmPrimitive classes.
The class pointer is xmArrowButtonWidgetClass.
The class name is XmArrowButton.
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).
XmArrowButton 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
XmNactivateCallback
Specifies a list of callbacks that is called when the
ArrowButton is activated. To activate the button,
press and release mouse button 1 while the pointer is
inside the ArrowButton widget. Activating the
ArrowButton also disarms it. The reason sent by this
callback is XmCRACTIVATE.
XmNarmCallback
Specifies a list of callbacks that is called when the
ArrowButton is armed. To arm this widget, press mouse
button 1 while the pointer is inside the ArrowButton.
For this callback the reason is XmCRARM.
XmNarrowDirection
Sets the arrow direction. The following are values for
this resource:
⊕ XmARROWUP.
⊕ XmARROWDOWN.
⊕ XmARROWLEFT.
⊕ XmARROWRIGHT.
XmNdisarmCallback
Specifies a list of callbacks that is called when the
ArrowButton is disarmed. To disarm this widget, press
and release mouse button 1 while the pointer is inside
the ArrowButton. The reason for this callback is
XmCRDISARM.
Inherited Resources
ArrowButton inherits behavior and resources from the
following superclasses. For a complete description of these
resources, refer to the man page for that superclass.
XmPrimitive Resource Set
Name Class Type Default Access
______________________________________________________________________________________
XmNbottomShadowColor XmCForeground Pixel dynamic CSG
XmNbottomShadowPixmap XmCBottomShadowPixmap Pixmap XmUNSPECIFIED_PIXMAP CSG
XmNforeground XmCForeground Pixel dynamic CSG
XmNhelpCallback XmCCallback XtCallbackList NULL C
XmNhighlightColor XmCForeground Pixel Black CSG
XmNhighlightOnEnter XmCHighlightOnEnter Boolean False CSG
XmNhighlightPixmap XmCHighlightPixmap Pixmap dynamic CSG
XmNhighlightThickness XmCHighlightThickness short 0 CSG
XmNshadowThickness XmCShadowThickness short 2 CSG
XmNtopShadowColor XmCBackground Pixel dynamic CSG
XmNtopShadowPixmap XmCTopShadowPixmap Pixmap XmUNSPECIFIED_PIXMAP CSG
XmNtraversalOn XmCTraversalOn Boolean False CSG
XmNunitType XmCUnitType unsigned char XmPIXELS CSG
XmNuserData XmCUserData caddr_t NULL CSG
Core Resource Set
Name Class Type Default Access
____________________________________________________________________________________
XmNaccelerators XmCAccelerators XtTranslations NULL CSG
XmNancestorSensitive XmCSensitive Boolean True G
XmNbackground XmCBackground Pixel dynamic CSG
XmNbackgroundPixmap XmCPixmap Pixmap XmUNSPECIFIED_PIXMAP CSG
XmNborderColor XmCBorderColor Pixel Black CSG
XmNborderPixmap XmCPixmap Pixmap XmUNSPECIFIED_PIXMAP CSG
XmNborderWidth XmCBorderWidth Dimension 0 CSG
XmNcolormap XmCColormap Colormap XtCopyFromParent CG
XmNdepth XmCDepth int XtCopyFromParent CG
XmNdestroyCallback XmCCallback XtCallbackList NULL C
XmNheight XmCHeight Dimension 0 CSG
XmNmappedWhenManaged XmCMappedWhenManaged Boolean True CSG
XmNscreen XmCScreen Pointer XtCopyScreen CG
XmNsensitive XmCSensitive Boolean True CSG
XmNtranslations XmCTranslations XtTranslations NULL CSG
XmNwidth XmCWidth Dimension 0 CSG
XmNx XmCPosition Position 0 CSG
XmNy XmCPosition Position 0 CSG
Callback Information
The following structure is returned with each callback:
typedef struct
{
int reason;
XEvent * event;
} XmAnyCallbackStruct;
reason Indicates why the callback was invoked.
event Points 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 ArrowButton, 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 ArrowButton, 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.
Default Translations
<Btn1Down>: Arm()
<Btn1Up>: Activate()
Disarm()
<Key>Return: ArmAndActivate()
<Key>Space: ArmAndActivate()
<EnterWindow>: Enter()
<LeaveWindow>: Leave()
Keyboard Traversal
For information on keyboard traversal, see the man page for
XmPrimitive(Xm) and its sections on behavior and default
translations.
RELATED INFORMATION
Core(Xm), XmCreateArrowButton(Xm), and XmPrimitive(Xm).
(printed 2/14/90) XmArrowButton(Xm)