XmArrowButton(3X)XmArrowButton(3X)NAMEXmArrowButton - 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 changes to give the appearance
that the ArrowButton has been pressed in. When the ArrowButton is uns‐
elected, the shadow reverts 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 pro‐
grammer to specify data. The programmer can also set the resource val‐
ues 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).
XmArrowButton Resource Set
Class: XmCCallback
Default: NULL
Type: XtCallbackList
Access: C
Class: XmCCallback
Default: NULL
Type: XtCallbackList
Access: C
Class: XmCArrowDirection
Default: XmARROW_UP
Type: unsigned char
Access: CSG
Class: XmCCallback
Default: NULL
Type: XtCallbackList
Access: C
Class: XmCMultiClick
Default: dynamic
Type: unsigned char
Access: CSG
Specifies a list of callbacks that is called when the ArrowBut‐
ton is activated. To activate the button, press and release BSe‐
lect while the pointer is inside the ArrowButton widget. Acti‐
vating the ArrowButton also disarms it. The reason sent by this
callback is XmCR_ACTIVATE. Specifies a list of callbacks that
is called when the ArrowButton is armed. To arm this widget,
press BSelect while the pointer is inside the ArrowButton. The
reason sent by this callback is XmCR_ARM. Sets the arrow direc‐
tion. The following are values for this resource: XmARROW_UP.
XmARROW_DOWN. XmARROW_LEFT. XmARROW_RIGHT. Specifies a list
of callbacks that is called when the ArrowButton is disarmed. To
disarm this widget, press and release BSelect while the pointer
is inside the ArrowButton. The reason for this callback is
XmCR_DISARM. 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 XmMUL‐
TICLICK_KEEP, process the event and increment click_count in the
callback structure. When the button is not in a menu, the
default value is XmMULTICLICK_KEEP.
Inherited Resources
ArrowButton inherits behavior and resources from the following super‐
classes. For a complete description of each resource, refer to the man
page for that superclass.
XmPrimitive Resource Set
Class: XmCBottomShadowColor
Default: dynamic
Type: Pixel
Access: CSG
Class: XmCBottomShadowPixmap
Default: XmUNSPECIFIED_PIXMAP
Type: Pixmap
Access: CSG
Class: XmCForeground
Default: dynamic
Type: Pixel
Access: CSG
Class: XmCCallback
Default: NULL
Type: XtCallbackList
Access: C
Class: XmCHighlightColor
Default: dynamic
Type: Pixel
Access: CSG
Class: XmCHighlightOnEnter
Default: False
Type: Boolean
Access: CSG
Class: XmCHighlightPixmap
Default: dynamic
Type: Pixmap
Access: CSG
Class: XmCHighlightThickness
Default: 2
Type: Dimension
Access: CSG
Class: XmCNavigationType
Default: XmNONE
Type: XmNavigationType
Access: CSG
Class: XmCShadowThickness
Default: 2
Type: Dimension
Access: CSG
Class: XmCTopShadowColor
Default: dynamic
Type: Pixel
Access: CSG
Class: XmCTopShadowPixmap
Default: dynamic
Type: Pixmap
Access: CSG
Class: XmCTraversalOn
Default: True
Type: Boolean
Access: CSG
Class: XmCUnitType
Default: dynamic
Type: unsigned char
Access: CSG
Class: XmCUserData
Default: NULL
Type: XtPointer
Access: CSG
Core Resource Set
Class: XmCAccelerators
Default: dynamic
Type: XtAccelerators
Access: CSG
Class: XmCSensitive
Default: dynamic
Type: Boolean
Access: G
Class: XmCBackground
Default: dynamic
Type: Pixel
Access: CSG
Class: XmCPixmap
Default: XmUNSPECIFIED_PIXMAP
Type: Pixmap
Access: CSG
Class: XmCBorderColor
Default: XtDefaultForeground
Type: Pixel
Access: CSG
Class: XmCPixmap
Default: XmUNSPECIFIED_PIXMAP
Type: Pixmap
Access: CSG
Class: XmCBorderWidth
Default: 0
Type: Dimension
Access: CSG
Class: XmCColormap
Default: dynamic
Type: Colormap
Access: CG
Class: XmCDepth
Default: dynamic
Type: int
Access: CG
Class: XmCCallback
Default: NULL
Type: XtCallbackList
Access: C
Class: XmCHeight
Default: dynamic
Type: Dimension
Access: CSG
Class: XmCInitialResourcesPersistent
Default: True
Type: Boolean
Access: C
Class: XmCMappedWhenManaged
Default: True
Type: Boolean
Access: CSG
Class: XmCScreen
Default: dynamic
Type: Screen *
Access: CG
Class: XmCSensitive
Default: True
Type: Boolean
Access: CSG
Class: XmCTranslations
Default: dynamic
Type: XtTranslations
Access: CSG
Class: XmCWidth
Default: dynamic
Type: Dimension
Access: CSG
Class: XmCPosition
Default: 0
Type: Position
Access: CSG
Class: XmCPosition
Default: 0
Type: Position
Access: CSG
Callback Information
A pointer to the following structure is passed to each callback: type‐
def struct {
int reason;
XEvent * event;
int click_count; } XmArrowButtonCallbackStruct;
Indicates why the callback was invoked. Points to the XEvent that
triggered the callback. This value is valid only when the reason is
XmCR_ACTIVATE. It contains the number of clicks in the last multiclick
sequence if the XmNmultiClick resource is set to XmMULTICLICK_KEEP;
otherwise it contains 1. The activate callback is invoked for each
click if XmNmultiClick is set to XmMULTICLICK_KEEP.
Translations
XmArrowButton includes translations for XmPrimitive. Additional XmAr‐
rowButton translations are listed below. These translations may not
directly correspond to a translation table. BSelect Press: Arm() BSe‐
lect Click: Activate()Disarm() BSelect Release:Activate()Disarm() BSelect Press 2+:MultiArm() BSelect Release
2+:MultiActivate() KSelect: ArmAndActivate() KHelp:
Help()
Action Routines
The XmArrowButton action routines are described below: Draws the shadow
in the unselected state. If the pointer is within the ArrowButton,
calls the callbacks for XmNactivateCallback. Draws the shadow in the
selected state and calls the callbacks for XmNarmCallback. Draws the
shadow in the selected state and calls the callbacks for XmNarmCall‐
back. 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. Draws the shadow in the
unselected state and calls the callbacks for XmNdisarmCallback. Calls
the callbacks for 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. If XmNmultiClick is XmMULTICLICK_DIS‐
CARD, this action does nothing.
If XmNmultiClick is XmMULTICLICK_KEEP, this action does the fol‐
lowing: Increments click_count in the callback structure. Draws
the shadow in the unselected state. If the pointer is within the
ArrowButton, calls the callbacks for XmNactivateCallback. Calls
the callbacks for XmNdisarmCallback. If XmNmultiClick is XmMUL‐
TICLICK_DISCARD, this action does nothing. If XmNmultiClick is
XmMULTICLICK_KEEP, this action draws the shadow in the selected
state and calls the callbacks for XmNarmCallback.
Additional Behavior
This widget has the additional behavior described below: Draws the
ArrowButton shadow in its selected state if the pointer leaves and re-
enters the window while BSelect is pressed. Draws the ArrowButton
shadow in its unselected state if the pointer leaves the window 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).
SEE ALSOCore(3X), XmCreateArrowButton(3X), XmPrimitive(3X)XmArrowButton(3X)
