OSF/Motif

NAME

XmDrawnButton − The DrawnButton widget class

SYNOPSIS

#include <Xm/DrawnB.h>

DESCRIPTION

The DrawnButton widget consists of an empty widget window surrounded by a shadow border.  It provides the application developer with a graphics area that can have PushButton input semantics. 

Callback types are defined for widget exposure and widget resize to allow the application to redraw or reposition its graphics.  If the DrawnButton widget has a highlight and shadow thickness, the application should not draw in that area. To avoid drawing in the highlight and shadow area, create the graphics context with a clipping rectangle for drawing in the widget. The clipping rectangle should take into account the size of the widget’s highlight thickness and shadow. 

Classes

DrawnButton inherits behavior and resources from Core, XmPrimitive, and XmLabel Classes. 

The class pointer is xmDrawnButtonWidgetClass. 

The class name is XmDrawnButton. 

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). 

XmDrawnButton Resource Set

XmNactivateCallback

Class: XmCCallback
Default: NULL
Type:  XtCallbackList
Access: C

XmNarmCallback

Class: XmCCallback
Default: NULL
Type:  XtCallbackList
Access: C

XmNdisarmCallback

Class: XmCCallback
Default: NULL
Type:  XtCallbackList
Access: C

XmNexposeCallback

Class: XmCCallback
Default: NULL
Type:  XtCallbackList
Access: C

XmNmultiClick

Class: XmCMultiClick
Default: dynamic
Type:  unsigned char
Access: CSG

XmNpushButtonEnabled

Class: XmCPushButtonEnabled
Default: False
Type:  Boolean
Access: CSG

XmNresizeCallback

Class: XmCCallback
Default: NULL
Type:  XtCallbackList
Access: C

XmNshadowType

Class: XmCShadowType
Default: XmSHADOW_ETCHED_IN
Type:  unsigned char
Access: CSG

XmNactivateCallback
Specifies the list of callbacks that is called when the widget becomes selected. The reason sent by the callback is XmCR_ACTIVATE. 

XmNarmCallback
Specifies the list of callbacks that is called when the widget becomes armed. The reason sent by the callback is XmCR_ARM. 

XmNdisarmCallback
Specifies the list of callbacks that is called when the widget becomes disarmed. The reason sent by the callback is XmCR_DISARM. 

XmNexposeCallback
Specifies the list of callbacks that is called when the widget receives an exposure event. The reason sent by the callback is XmCR_EXPOSE. 

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 button is not in a menu, the default value is XmMULTICLICK_KEEP. 

XmNpushButtonEnabled
Enables or disables the three-dimensional shadow drawing as in PushButton.

XmNresizeCallback
Specifies the list of callbacks that is called when the widget receives a resize event. The reason sent by the callback is XmCR_RESIZE.  The event returned for this callback is NULL. 

XmNshadowType
Describes the drawing style for the DrawnButton.  This resource can have the following values:

       •XmSHADOW_IN−−draws the DrawnButton so that the shadow appears inset.  This means that the bottom shadow visuals and top shadow visuals are reversed. 

       •XmSHADOW_OUT−−draws the DrawnButton so that the shadow appears outset. 

       •XmSHADOW_ETCHED_IN−−draws the DrawnButton using a double line.  This gives the effect of a line etched into the window.  The thickness of the double line is equal to the value of XmNshadowThickness. 

       •XmSHADOW_ETCHED_OUT−−draws the DrawnButton using a double line.  This gives the effect of a line coming out of the window.  The thickness of the double line is equal to the value of XmNshadowThickness. 

Inherited Resources

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

XmLabel Resource Set

XmNaccelerator

Class: XmCAccelerator
Default: NULL
Type:  String
Access: N/A

XmNacceleratorText

Class: XmCAcceleratorText
Default: NULL
Type:  XmString
Access: N/A

XmNalignment

Class: XmCAlignment
Default: dynamic
Type:  unsigned char
Access: CSG

XmNfontList

Class: XmCFontList
Default: dynamic
Type:  XmFontList
Access: CSG

XmNlabelInsensitivePixmap

Class: XmCLabelInsensitivePixmap
Default: XmUNSPECIFIED_PIXMAP
Type:  Pixmap
Access: CSG

XmNlabelPixmap

Class: XmCLabelPixmap
Default: XmUNSPECIFIED_PIXMAP
Type:  Pixmap
Access: CSG

XmNlabelString

Class: XmCXmString
Default: "\0"
Type:  XmString
Access: CSG

XmNlabelType

Class: XmCLabelType
Default: XmSTRING
Type:  unsigned char
Access: CSG

XmNmarginBottom

Class: XmCMarginBottom
Default: 0
Type:  Dimension
Access: CSG

XmNmarginHeight

Class: XmCMarginHeight
Default: 2
Type:  Dimension
Access: CSG

XmNmarginLeft

Class: XmCMarginLeft
Default: 0
Type:  Dimension
Access: CSG

XmNmarginRight

Class: XmCMarginRight
Default: 0
Type:  Dimension
Access: CSG

XmNmarginTop

Class: XmCMarginTop
Default: 0
Type:  Dimension
Access: CSG

XmNmarginWidth

Class: XmCMarginWidth
Default: 2
Type:  Dimension
Access: CSG

XmNmnemonic

Class: XmCMnemonic
Default: NULL
Type:  KeySym
Access: N/A

XmNmnemonicCharSet

Class: XmCMnemonicCharSet
Default: XmFONTLIST_DEFAULT_TAG
Type:  String
Access: N/A

XmNrecomputeSize

Class: XmCRecomputeSize
Default: True
Type:  Boolean
Access: CSG

XmNstringDirection

Class: XmCStringDirection
Default: dynamic
Type:  XmStringDirection
Access: CSG

XmPrimitive Resource Set

XmNbottomShadowColor

Class: XmCBottomShadowColor
Default: dynamic
Type:  Pixel
Access: CSG

XmNbottomShadowPixmap

Class: XmCBottomShadowPixmap
Default: XmUNSPECIFIED_PIXMAP
Type:  Pixmap
Access: CSG

XmNforeground

Class: XmCForeground
Default: dynamic
Type:  Pixel
Access: CSG

XmNhelpCallback

Class: XmCCallback
Default: NULL
Type:  XtCallbackList
Access: C

XmNhighlightColor

Class: XmCHighlightColor
Default: dynamic
Type:  Pixel
Access: CSG

XmNhighlightOnEnter

Class: XmCHighlightOnEnter
Default: False
Type:  Boolean
Access: CSG

XmNhighlightPixmap

Class: XmCHighlightPixmap
Default: dynamic
Type:  Pixmap
Access: CSG

XmNhighlightThickness

Class: XmCHighlightThickness
Default: 2
Type:  Dimension
Access: CSG

XmNnavigationType

Class: XmCNavigationType
Default: XmNONE
Type:  XmNavigationType
Access: CSG

XmNshadowThickness

Class: XmCShadowThickness
Default: 2
Type:  Dimension
Access: CSG

XmNtopShadowColor

Class: XmCTopShadowColor
Default: dynamic
Type:  Pixel
Access: CSG

XmNtopShadowPixmap

Class: XmCTopShadowPixmap
Default: dynamic
Type:  Pixmap
Access: CSG

XmNtraversalOn

Class: XmCTraversalOn
Default: True
Type:  Boolean
Access: CSG

XmNunitType

Class: XmCUnitType
Default: dynamic
Type:  unsigned char
Access: CSG

XmNuserData

Class: XmCUserData
Default: NULL
Type:  XtPointer
Access: CSG

Core Resource Set

XmNaccelerators

Class: XmCAccelerators
Default: dynamic
Type:  XtAccelerators
Access: CSG

XmNancestorSensitive

Class: XmCSensitive
Default: dynamic
Type:  Boolean
Access: G

XmNbackground

Class: XmCBackground
Default: dynamic
Type:  Pixel
Access: CSG

XmNbackgroundPixmap

Class: XmCPixmap
Default: XmUNSPECIFIED_PIXMAP
Type:  Pixmap
Access: CSG

XmNborderColor

Class: XmCBorderColor
Default: XtDefaultForeground
Type:  Pixel
Access: CSG

XmNborderPixmap

Class: XmCPixmap
Default: XmUNSPECIFIED_PIXMAP
Type:  Pixmap
Access: CSG

XmNborderWidth

Class: XmCBorderWidth
Default: 0
Type:  Dimension
Access: CSG

XmNcolormap

Class: XmCColormap
Default: dynamic
Type:  Colormap
Access: CG

XmNdepth

Class: XmCDepth
Default: dynamic
Type:  int
Access: CG

XmNdestroyCallback

Class: XmCCallback
Default: NULL
Type:  XtCallbackList
Access: C

XmNheight

Class: XmCHeight
Default: dynamic
Type:  Dimension
Access: CSG

XmNinitialResourcesPersistent

Class: XmCInitialResourcesPersistent
Default: True
Type:  Boolean
Access: C

XmNmappedWhenManaged

Class: XmCMappedWhenManaged
Default: True
Type:  Boolean
Access: CSG

XmNscreen

Class: XmCScreen
Default: dynamic
Type:  Screen ∗
Access: CG

XmNsensitive

Class: XmCSensitive
Default: True
Type:  Boolean
Access: CSG

XmNtranslations

Class: XmCTranslations
Default: dynamic
Type:  XtTranslations
Access: CSG

XmNwidth

Class: XmCWidth
Default: dynamic
Type:  Dimension
Access: CSG

XmNx

Class: XmCPosition
Default: 0
Type:  Position
Access: CSG

XmNy

Class: XmCPosition
Default: 0
Type:  Position
Access: CSG

Callback Information

A pointer to the following structure is passed to each callback:

typedef struct
{
  int      reason;
  XEvent   ∗ event;
  Window   window;
  int      click_count;
}XmDrawnButtonCallbackStruct;

reason
Indicates why the callback was invoked.

event
Points to the XEvent that triggered the callback. This is  NULL for XmNresizeCallback. 

window
Is set to the window ID in which the event occurred.

click_count
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

XmDrawnButton includes translations from Primitive. Additional XmDrawnButton translations are listed below. These translations may not directly correspond to a translation table. 

BSelect Press: Arm()
BSelect Click: Activate()
               Disarm()
BSelect Release:Activate()
               Disarm()
BSelect Press 2+:MultiArm()
BSelect Release 2+:MultiActivate()
KSelect:       ArmAndActivate()
KHelp:         Help()

Action Routines

The XmDrawnButton action routines are described below:

Activate():
If XmNpushButtonEnabled is True, redraws the shadow in the unselected state; otherwise, redraws the shadow according to XmNshadowType.  If the pointer is within the DrawnButton, calls the XmNactivateCallback callbacks. 

Arm():
If XmNpushButtonEnabled is True, redraws the shadow in the selected state; otherwise, redraws the shadow according to XmNshadowType.  Calls the callbacks for XmNarmCallback. 

ArmAndActivate():
If XmNpushButtonEnabled is True, redraws the shadow in the selected state; otherwise, redraws the shadow according to XmNshadowType.  Calls the callbacks for XmNarmCallback. 

Arranges for the following to happen, either immediately or at a later time: If XmNpushButtonEnabled is True, the shadow is redrawn in the unselected state; otherwise, the shadow is redrawn according to XmNshadowType.  The callbacks for XmNactivateCallback and XmNdisarmCallback are called. 

Disarm():
Marks the DrawnButton as unselected and calls the callbacks for XmNdisarmCallback. 

Help():
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. 

MultiActivate():
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. If XmNpushButtonEnabled is True, redraws the shadow in the unselected state; otherwise, redraws the shadow according to XmNshadowType. If the pointer is within the DrawnButton,  calls the XmNactivateCallback callbacks.  Calls the callbacks for XmNdisarmCallback. 

MultiArm():
If XmNmultiClick is XmMULTICLICK_DISCARD, this action does nothing. 

If XmNmultiClick is XmMULTICLICK_KEEP, this action does the following: If XmNpushButtonEnabled is True, redraws the shadow in the selected state; otherwise, redraws the shadow according to XmNshadowType. Calls the callbacks for XmNarmCallback. 

Additional Behavior

This widget has the additional behavior described below:

<EnterWindow>:
Draws the shadow in its selected state if XmNpushButtonEnabled is True and if the cursor leaves and re-enters the window while BSelect is pressed. 

<LeaveWindow>:
Draws the shadow in its unselected state if XmNpushButtonEnabled is True and if the cursor 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 ALSO

Core(3X), XmCreateDrawnButton(3X), XmLabel(3X), XmPrimitive(3X), XmPushButton(3X), XmSeparator(3X)