


XmGadget(3X)							 XmGadget(3X)
OSF/Motif							    OSF/Motif



NAME
  XXmmGGaaddggeett - The Gadget	widget class

SYNOPSIS


  ##iinncclluuddee <<XXmm//XXmm..hh>>

DESCRIPTION
  Gadget is a widget class used	as a supporting	superclass for other gadget
  classes.  It handles shadow-border drawing and highlighting, traversal
  activation and deactivation, and various callback lists needed by gadgets.

  The color and	pixmap resources defined by XmManager are directly used	by
  gadgets.  If XXttSSeettVVaalluueess is used to change one of the	resources for a
  manager widget, all of the gadget children within the	manager	also change.

  Classes

  Gadget inherits behavior and resources from OObbjjeecctt and RReeccttOObbjj classes.

  The class pointer is xxmmGGaaddggeettCCllaassss.

  The class name is XXmmGGaaddggeett.

  New Resources

  The following	table defines a	set of widget resources	used by	the program-
  mer 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	XXmmNN or XXmmCC
  prefix and use the remaining letters.	 To specify one	of the defined values
  for a	resource in a .Xdefaults file, remove the XXmm prefix and	use the
  remaining letters (in	either lowercase or uppercase, but include any under-
  scores between words).  The codes in the access column indicate if the
  given	resource can be	set at creation	time (C), set by using XXttSSeettVVaalluueess
  (S), retrieved by using XXttGGeettVVaalluueess (G), or is not applicable	(N/A).

			    XXmmGGaaddggeett RReessoouurrccee SSeett
	______________________________________________________________
	NNaammee			      DDeeffaauulltt			AAcccceessss
	      CCllaassss			    TTyyppee
	______________________________________________________________
	______________________________________________________________
	XmNbottomShadowColor	      dynamic			G
	      XmCBottomShadowColor	     Pixel
	______________________________________________________________
	XmNhelpCallback		      NULL			C
	      XmCCallback		     XtCallbackList
	______________________________________________________________
	XmNhighlightColor	      dynamic			G
	      XmCHighlightColor		     Pixel
	______________________________________________________________
	XmNhighlightOnEnter	      False			CSG
	      XmCHighlightOnEnter	     Boolean
	______________________________________________________________
	XmNhighlightThickness	      2				CSG
	      XmCHighlightThickness	     Dimension
	______________________________________________________________
	XmNnavigationType	      XmNONE			CSG
	      XmCNavigationType		     XmNavigationType
	______________________________________________________________
	XmNshadowThickness	      2				CSG
	      XmCShadowThickness	     Dimension
	______________________________________________________________
	XmNtopShadowColor	      dynamic			G
	      XmCTopShadowColor		     Pixel
	______________________________________________________________
	XmNtraversalOn		      True			CSG
	      XmCTraversalOn		     Boolean
	______________________________________________________________
	XmNunitType		      dynamic			CSG
	      XmCUnitType		     unsigned char
	______________________________________________________________
	XmNuserData		      NULL			CSG
	      XmCUserData		     XtPointer
	______________________________________________________________

  XXmmNNbboottttoommSShhaaddoowwCCoolloorr
	    Contains the color to use to draw the bottom and right sides of
	    the	border shadow.

  XXmmNNhheellppCCaallllbbaacckk
	    Specifies the list of callbacks that is called when	the help key
	    sequence is	pressed.  The reason sent by the callback is
	    XXmmCCRR__HHEELLPP.

  XXmmNNhhiigghhlliigghhttCCoolloorr
	    Contains the color of the highlighting rectangle.

  XXmmNNhhiigghhlliigghhttOOnnEEnntteerr
	    Specifies if the highlighting rectangle is drawn when the cursor
	    moves into the widget.  If the shell's focus policy	is XXmmEEXXPPLLII--
	    CCIITT, this resource is ignored, and the widget is highlighted when
	    it has the focus.  If the shell's focus policy is XXmmPPOOIINNTTEERR	and
	    if this resource is	True, the highlighting rectangle is drawn
	    when the the cursor	moves into the widget.	If the shell's focus
	    policy is XXmmPPOOIINNTTEERR	and if this resource is	False, the highlight-
	    ing	rectangle is not drawn when the	the cursor moves into the
	    widget.  The default is False.

  XXmmNNhhiigghhlliigghhttTThhiicckknneessss
	    Specifies the thickness of the highlighting	rectangle.

  XXmmNNnnaavviiggaattiioonnTTyyppee
	    Determines whether the widget is a tab group.

	      oo++
	      XXmmNNOONNEE indicates that the	widget is not a	tab group.

	      oo++
	      XXmmTTAABB__GGRROOUUPP indicates that the widget is a tab group, unless
	      another widget in	the hierarchy has an XXmmNNnnaavviiggaattiioonnTTyyppee of
	      XXmmEEXXCCLLUUSSIIVVEE__TTAABB__GGRROOUUPP.

	      oo++
	      XXmmSSTTIICCKKYY__TTAABB__GGRROOUUPP indicates that	the widget is a	tab group,
	      even if another widget in	the hierarchy has an
	      XXmmNNnnaavviiggaattiioonnTTyyppee	of XXmmEEXXCCLLUUSSIIVVEE__TTAABB__GGRROOUUPP.

	      oo++
	      XXmmEEXXCCLLUUSSIIVVEE__TTAABB__GGRROOUUPP indicates that the widget is a tab group
	      and that widgets in the hierarchy	whose XXmmNNnnaavviiggaattiioonnTTyyppee	is
	      XXmmTTAABB__GGRROOUUPP are not tab groups.
	      When a parent widget has an XXmmNNnnaavviiggaattiioonnTTyyppee of
	      XXmmEEXXCCLLUUSSIIVVEE__TTAABB__GGRROOUUPP, traversal of non-tab-group	widgets
	      within the group is based	on the order of	those widgets in
	      their parent's XXmmNNcchhiillddrreenn list.
	      When any widget in a hierarchy has an XXmmNNnnaavviiggaattiioonnTTyyppee of
	      XXmmEEXXCCLLUUSSIIVVEE__TTAABB__GGRROOUUPP, traversal of tab groups in	the hierarchy
	      proceeds to widgets in the order in which	their XXmmNNnnaavviiggaattiioonn--
	      TTyyppee resources were specified as XXmmEEXXCCLLUUSSIIVVEE__TTAABB__GGRROOUUPP or
	      XXmmSSTTIICCKKYY__TTAABB__GGRROOUUPP, whether by creating the widgets with that
	      value, by	calling	XXttSSeettVVaalluueess, or	by calling XXmmAAddddTTaabbGGrroouupp.

  XXmmNNsshhaaddoowwTThhiicckknneessss
	    Specifies the size of the drawn border shadow.

  XXmmNNttooppSShhaaddoowwCCoolloorr
	    Contains the color to use to draw the top and left sides of	the
	    border shadow.

  XXmmNNttrraavveerrssaallOOnn
	    Specifies traversal	activation for this gadget.

  XXmmNNuunniittTTyyppee
	    Provides the basic support for resolution independence.  It
	    defines the	type of	units a	widget uses with sizing	and position-
	    ing	resources.  If the widget's parent is a	subclass of XXmmMMaannaaggeerr
	    and	if the XXmmNNuunniittTTyyppee resource is not explicitly set, it
	    defaults to	the unit type of the parent widget.  If	the widget's
	    parent is not a subclass of	XXmmMMaannaaggeerr, the resource	has a default
	    unit type of XXmmPPIIXXEELLSS.
	    XXmmNNuunniittTTyyppee	can have the following values:

	      oo++
	      XXmmPPIIXXEELLSS-all values provided to the widget are treated as	nor-
	      mal pixel	values.

	      oo++
	      XXmm110000TTHH__MMIILLLLIIMMEETTEERRSS-all values provided to the widget are
	      treated as 1/100 millimeter.

	      oo++
	      XXmm11000000TTHH__IINNCCHHEESS-all values provided to the widget	are treated
	      as 1/1000	inch.

	      oo++
	      XXmm110000TTHH__PPOOIINNTTSS-all values	provided to the	widget are treated as
	      1/100 point.  A point is a unit used in text processing appli-
	      cations and is defined as	1/72 inch.

	      oo++
	      XXmm110000TTHH__FFOONNTT__UUNNIITTSS-all values provided to	the widget are
	      treated as 1/100 of a font unit.	A font unit has	horizontal
	      and vertical components.	These are the values of	the XmScreen
	      resources	XXmmNNhhoorriizzoonnttaallFFoonnttUUnniitt and XXmmNNvveerrttiiccaallFFoonnttUUnniitt.

  XXmmNNuusseerrDDaattaa
	    Allows the application to attach any necessary specific data to
	    the	gadget.	 This is an internally unused resource.




  Inherited Resources

  Gadget inherits the following	resources from the named superclass.  For a
  complete description of each resource, refer to the man page for that
  superclass.

			     RReeccttOObbjj RReessoouurrccee SSeett
	       ________________________________________________
	       NNaammee		      DDeeffaauulltt		 AAcccceessss
		     CCllaassss		    TTyyppee
	       ________________________________________________
	       ________________________________________________
	       XmNancestorSensitive   dynamic		 G
		     XmCSensitive	     Boolean
	       ________________________________________________
	       XmNborderWidth	      0			 CSG
		     XmCBorderWidth	     Dimension
	       ________________________________________________
	       XmNheight	      dynamic		 CSG
		     XmCHeight		     Dimension
	       ________________________________________________
	       XmNsensitive	      True		 CSG
		     XmCSensitive	     Boolean
	       ________________________________________________
	       XmNwidth		      dynamic		 CSG
		     XmCWidth		     Dimension
	       ________________________________________________
	       XmNx		      0			 CSG
		     XmCPosition	     Position
	       ________________________________________________
	       XmNy		      0			 CSG
		     XmCPosition	     Position
	       ________________________________________________

			      OObbjjeecctt RReessoouurrccee SSeett
	      ___________________________________________________
	      NNaammee		   DDeeffaauulltt		   AAcccceessss
		    CCllaassss		 TTyyppee
	      ___________________________________________________
	      ___________________________________________________
	      XmNdestroyCallback   NULL			   C
		    XmCCallback		  XtCallbackList
	      ___________________________________________________

  Callback Information

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


  ttyyppeeddeeff ssttrruucctt
  {{
    iinntt		 _r_e_a_s_o_n;;
    XXEEvveenntt	 * _e_v_e_n_t;;
  }} XXmmAAnnyyCCaallllbbaacckkSSttrruucctt;;

  _r_e_a_s_o_n Indicates why the callback was	invoked.  For this callback, _r_e_a_s_o_n
	 is set	to XXmmCCRR__HHEELLPP.

  _e_v_e_n_t	 Points	to the XXEEvveenntt that triggered the callback.







  Behavior

  Gadgets cannot have translations associated with them.  Because of this, a
  Gadget's behavior is determined by the Manager widget	into which the Gadget
  is placed.  If focus is on a Gadget, events are passed to the	Gadget by its
  Manager.

RELATED	INFORMATION
  OObbjjeecctt((33XX)), RReeccttOObbjj((33XX)), XXmmMMaannaaggeerr((33XX)), and XXmmSSccrreeeenn((33XX)).






























































