XmDrawnButton man page on Ultrix

Man page or keyword search:  
man Server   3690 pages
apropos Keyword Search (all sections)
Output format
Ultrix logo
[printable version]

XmDrawnButton(3X)		   OSF/Motif		     XmDrawnButton(3X)

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 applica‐
       tion 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  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).

			     XmDrawnButton Resource Set
	     ────────────────────────────────────────────────────────────
	     Name			  Default		  Access
		   Class			Type
	     ────────────────────────────────────────────────────────────
	     ────────────────────────────────────────────────────────────
	     XmNactivateCallback	  NULL			  C
		   XmCCallback			 XtCallbackList
	     ────────────────────────────────────────────────────────────
	     XmNarmCallback		  NULL			  C
		   XmCCallback			 XtCallbackList
	     ────────────────────────────────────────────────────────────
	     XmNdisarmCallback		  NULL			  C
		   XmCCallback			 XtCallbackList
	     ────────────────────────────────────────────────────────────
	     XmNexposeCallback		  NULL			  C
		   XmCCallback			 XtCallbackList
	     ────────────────────────────────────────────────────────────
	     XmNmultiClick		  dynamic		  CSG
		   XmCMultiClick		 unsigned char
	     ────────────────────────────────────────────────────────────

	     XmNpushButtonEnabled	  False			  CSG
		   XmCPushButtonEnabled		 Boolean
	     ────────────────────────────────────────────────────────────
	     XmNresizeCallback		  NULL			  C
		   XmCCallback			 XtCallbackList
	     ────────────────────────────────────────────────────────────
	     XmNshadowType		  XmSHADOW_ETCHED_IN	  CSG
		   XmCShadowType		 unsigned char
	     ────────────────────────────────────────────────────────────
       Specifies the list of callbacks that is called when the widget  becomes
       selected.  The reason sent by the callback is XmCR_ACTIVATE.  Specifies
       the list of callbacks that is called when  the  widget  becomes	armed.
       The  reason  sent  by  the callback is XmCR_ARM.	 Specifies the list of
       callbacks that is called when the widget becomes disarmed.  The	reason
       sent  by	 the callback is XmCR_DISARM.  Specifies the list of callbacks
       that is called when the widget receives an exposure event.  The	reason
       sent  by the callback is XmCR_EXPOSE.  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 call‐
       back structure.	When the button is not in a menu, the default value is
       XmMULTICLICK_KEEP.   Enables  or	 disables the three-dimensional shadow
       drawing as in PushButton.  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.
       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  DrawnBut‐
       ton  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	Drawn‐
       Button 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 super‐
       classes.	 For a complete description of each resource, refer to the man
       page for that superclass.

				XmLabel Resource Set
	 ────────────────────────────────────────────────────────────────────
	 Name				   Default		      Access
	       Class				 Type
	 ────────────────────────────────────────────────────────────────────
	 ────────────────────────────────────────────────────────────────────
	 XmNaccelerator			   NULL			      N/A
	       XmCAccelerator			  String
	 ────────────────────────────────────────────────────────────────────
	 XmNacceleratorText		   NULL			      N/A
	       XmCAcceleratorText		  XmString
	 ────────────────────────────────────────────────────────────────────
	 XmNalignment			   dynamic		      CSG
	       XmCAlignment			  unsigned char
	 ────────────────────────────────────────────────────────────────────
	 XmNfontList			   dynamic		      CSG
	       XmCFontList			  XmFontList
	 ────────────────────────────────────────────────────────────────────
	 XmNlabelInsensitivePixmap	   XmUNSPECIFIED_PIXMAP	      CSG
	       XmCLabelInsensitivePixmap	  Pixmap
	 ────────────────────────────────────────────────────────────────────
	 XmNlabelPixmap			   XmUNSPECIFIED_PIXMAP	      CSG

	       XmCLabelPixmap			  Pixmap
	 ────────────────────────────────────────────────────────────────────
	 XmNlabelString			   "\0"			      CSG
	       XmCXmString			  XmString
	 ────────────────────────────────────────────────────────────────────
	 XmNlabelType			   XmSTRING		      CSG
	       XmCLabelType			  unsigned char
	 ────────────────────────────────────────────────────────────────────
	 XmNmarginBottom		   0			      CSG
	       XmCMarginBottom			  Dimension
	 ────────────────────────────────────────────────────────────────────
	 XmNmarginHeight		   2			      CSG
	       XmCMarginHeight			  Dimension
	 ────────────────────────────────────────────────────────────────────
	 XmNmarginLeft			   0			      CSG
	       XmCMarginLeft			  Dimension
	 ────────────────────────────────────────────────────────────────────
	 XmNmarginRight			   0			      CSG
	       XmCMarginRight			  Dimension
	 ────────────────────────────────────────────────────────────────────
	 XmNmarginTop			   0			      CSG
	       XmCMarginTop			  Dimension
	 ────────────────────────────────────────────────────────────────────
	 XmNmarginWidth			   2			      CSG
	       XmCMarginWidth			  Dimension
	 ────────────────────────────────────────────────────────────────────
	 XmNmnemonic			   NULL			      N/A
	       XmCMnemonic			  KeySym
	 ────────────────────────────────────────────────────────────────────
	 XmNmnemonicCharSet		   XmFONTLIST_DEFAULT_TAG     N/A
	       XmCMnemonicCharSet		  String
	 ────────────────────────────────────────────────────────────────────
	 XmNrecomputeSize		   True			      CSG
	       XmCRecomputeSize			  Boolean
	 ────────────────────────────────────────────────────────────────────
	 XmNstringDirection		   dynamic		      CSG
	       XmCStringDirection		  XmStringDirection
	 ────────────────────────────────────────────────────────────────────

			      XmPrimitive Resource Set
	   ───────────────────────────────────────────────────────────────
	   Name				 Default		   Access
		 Class			       Type
	   ───────────────────────────────────────────────────────────────
	   ───────────────────────────────────────────────────────────────
	   XmNbottomShadowColor		 dynamic		   CSG
		 XmCBottomShadowColor		Pixel
	   ───────────────────────────────────────────────────────────────
	   XmNbottomShadowPixmap	 XmUNSPECIFIED_PIXMAP	   CSG
		 XmCBottomShadowPixmap		Pixmap
	   ───────────────────────────────────────────────────────────────
	   XmNforeground		 dynamic		   CSG
		 XmCForeground			Pixel
	   ───────────────────────────────────────────────────────────────
	   XmNhelpCallback		 NULL			   C
		 XmCCallback			XtCallbackList
	   ───────────────────────────────────────────────────────────────
	   XmNhighlightColor		 dynamic		   CSG
		 XmCHighlightColor		Pixel
	   ───────────────────────────────────────────────────────────────
	   XmNhighlightOnEnter		 False			   CSG
		 XmCHighlightOnEnter		Boolean
	   ───────────────────────────────────────────────────────────────
	   XmNhighlightPixmap		 dynamic		   CSG

		 XmCHighlightPixmap		Pixmap
	   ───────────────────────────────────────────────────────────────
	   XmNhighlightThickness	 2			   CSG
		 XmCHighlightThickness		Dimension
	   ───────────────────────────────────────────────────────────────
	   XmNnavigationType		 XmNONE			   CSG
		 XmCNavigationType		XmNavigationType
	   ───────────────────────────────────────────────────────────────
	   XmNshadowThickness		 2			   CSG
		 XmCShadowThickness		Dimension
	   ───────────────────────────────────────────────────────────────
	   XmNtopShadowColor		 dynamic		   CSG
		 XmCTopShadowColor		Pixel
	   ───────────────────────────────────────────────────────────────
	   XmNtopShadowPixmap		 dynamic		   CSG
		 XmCTopShadowPixmap		Pixmap
	   ───────────────────────────────────────────────────────────────
	   XmNtraversalOn		 True			   CSG
		 XmCTraversalOn			Boolean
	   ───────────────────────────────────────────────────────────────
	   XmNunitType			 dynamic		   CSG
		 XmCUnitType			unsigned char
	   ───────────────────────────────────────────────────────────────
	   XmNuserData			 NULL			   CSG
		 XmCUserData			XtPointer
	   ───────────────────────────────────────────────────────────────

				 Core Resource Set
	─────────────────────────────────────────────────────────────────────
	Name				      Default		      Access
	      Class				    Type
	─────────────────────────────────────────────────────────────────────
	─────────────────────────────────────────────────────────────────────
	XmNaccelerators			      dynamic		      CSG
	      XmCAccelerators			     XtAccelerators
	─────────────────────────────────────────────────────────────────────
	XmNancestorSensitive		      dynamic		      G
	      XmCSensitive			     Boolean
	─────────────────────────────────────────────────────────────────────
	XmNbackground			      dynamic		      CSG
	      XmCBackground			     Pixel
	─────────────────────────────────────────────────────────────────────
	XmNbackgroundPixmap		      XmUNSPECIFIED_PIXMAP    CSG
	      XmCPixmap				     Pixmap
	─────────────────────────────────────────────────────────────────────
	XmNborderColor			      XtDefaultForeground     CSG
	      XmCBorderColor			     Pixel
	─────────────────────────────────────────────────────────────────────
	XmNborderPixmap			      XmUNSPECIFIED_PIXMAP    CSG
	      XmCPixmap				     Pixmap
	─────────────────────────────────────────────────────────────────────
	XmNborderWidth			      0			      CSG
	      XmCBorderWidth			     Dimension
	─────────────────────────────────────────────────────────────────────
	XmNcolormap			      dynamic		      CG
	      XmCColormap			     Colormap
	─────────────────────────────────────────────────────────────────────
	XmNdepth			      dynamic		      CG
	      XmCDepth				     int
	─────────────────────────────────────────────────────────────────────
	XmNdestroyCallback		      NULL		      C
	      XmCCallback			     XtCallbackList
	─────────────────────────────────────────────────────────────────────
	XmNheight			      dynamic		      CSG

	      XmCHeight				     Dimension
	─────────────────────────────────────────────────────────────────────
	XmNinitialResourcesPersistent	      True		      C
	      XmCInitialResourcesPersistent	     Boolean
	─────────────────────────────────────────────────────────────────────
	XmNmappedWhenManaged		      True		      CSG
	      XmCMappedWhenManaged		     Boolean
	─────────────────────────────────────────────────────────────────────
	XmNscreen			      dynamic		      CG
	      XmCScreen				     Screen *
	─────────────────────────────────────────────────────────────────────
	XmNsensitive			      True		      CSG
	      XmCSensitive			     Boolean
	─────────────────────────────────────────────────────────────────────
	XmNtranslations			      dynamic		      CSG
	      XmCTranslations			     XtTranslations
	─────────────────────────────────────────────────────────────────────
	XmNwidth			      dynamic		      CSG
	      XmCWidth				     Dimension
	─────────────────────────────────────────────────────────────────────
	XmNx				      0			      CSG
	      XmCPosition			     Position
	─────────────────────────────────────────────────────────────────────
	XmNy				      0			      CSG
	      XmCPosition			     Position
	─────────────────────────────────────────────────────────────────────

   Callback Information
       A  pointer to the following structure is passed to each callback: type‐
       def struct {   int      reason;	 XEvent	  * event;    Window   window;
	 int	  click_count;	}  XmDrawnButtonCallbackStruct;	 Indicates why
       the callback was invoked.  Points to  the  XEvent  that	triggered  the
       callback.   This	 is  NULL for XmNresizeCallback.  Is set to the window
       ID in which the event occurred.	Contains the number of clicks  in  the
       last multiclick sequence if the XmNmultiClick resource is set to XmMUL‐
       TICLICK_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:Acti‐
       vate()		      Disarm()	BSelect	 Press	2+:MultiArm()  BSelect
       Release	     2+:MultiActivate()	       KSelect:	      ArmAndActivate()
       KHelp:	      Help()

   Action Routines
       The XmDrawnButton action routines are described below: If XmNpushButto‐
       nEnabled is True, redraws the shadow in the  unselected	state;	other‐
       wise, redraws the shadow according to XmNshadowType.  If the pointer is
       within the DrawnButton, calls the  XmNactivateCallback  callbacks.   If
       XmNpushButtonEnabled is True, redraws the shadow in the selected state;
       otherwise, redraws the shadow according to  XmNshadowType.   Calls  the
       callbacks for XmNarmCallback.  If XmNpushButtonEnabled is True, redraws
       the shadow in the selected state; otherwise, redraws the shadow accord‐
       ing 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 XmN‐
       shadowType.  The callbacks for XmNactivateCallback  and	XmNdisarmCall‐
       back  are  called.   Marks  the DrawnButton as unselected and calls the
       callbacks for XmNdisarmCallback.	 Calls the callbacks for  XmNhelpCall‐
       back  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_DISCARD, this action does noth‐
       ing.

       If XmNmultiClick is XmMULTICLICK_KEEP, this action does the  following:
       Increments  click_count in the callback structure.  If XmNpushButtonEn‐
       abled 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.  If XmNmultiClick is XmMUL‐
       TICLICK_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: 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.	 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).

RELATED INFORMATION
       Core(3X), XmCreateDrawnButton, XmLabel(3X), XmPrimitive(3X), XmPushBut‐
       ton, and XmSeparator(3X).

							     XmDrawnButton(3X)
[top]

List of man pages available for Ultrix

Copyright (c) for man pages and the logo by the respective OS vendor.

For those who want to learn more, the polarhome community provides shell access and support.

[legal] [privacy] [GNU] [policy] [cookies] [netiquette] [sponsors] [FAQ]
Tweet
Polarhome, production since 1999.
Member of Polarhome portal.
Based on Fawad Halim's script.
....................................................................
Vote for polarhome
Free Shell Accounts :: the biggest list on the net