


XmDragIcon(3X)						       XmDragIcon(3X)
OSF/Motif							    OSF/Motif



NAME
  XXmmDDrraaggIIccoonn - The DragIcon widget class

SYNOPSIS


  ##iinncclluuddee <<XXmm//DDrraaggDDrroopp..hh>>

DESCRIPTION
  A DragIcon is	a component of the visual used to represent the	source data
  in a drag and	drop transaction.  During a drag operation, a real or simu-
  lated	X cursor provides drag-over visuals consisting of a static portion
  that represents the object being dragged, and	dynamic	cues that provide
  visual feedback during the drag operation.  The visual is attained by
  blending together various XXmmDDrraaggIIccoonnss	specified in the XXmmDDrraaggCCoonntteexxtt asso-
  ciated with the drag operation.

  The static portion of	the drag-over visual is	the graphic representation
  that identifies the drag source.  For	example, when a	user drags several
  items	within a list, a DragIcon depicting a list might be supplied as	the
  visual.  The XXmmDDrraaggCCoonntteexxtt resources,	XXmmNNssoouurrcceeCCuurrssoorrIIccoonn or XXmmNNssoouurrcceePPiixx--
  mmaappIIccoonn, specify a DragIcon to use for the static portion of the visual.

  A drag-over visual incorporates dynamic cues in order	to provide visual
  feedback in response to the user's actions.  For instance, the drag-over
  visual might use different indicators	to identify the	type of	operation
  (copy, link, or move)	being performed.  Dynamic cues could also alert	the
  user that a drop site	is valid or invalid as the pointer traverses the drop
  site.	 The XXmmNNooppeerraattiioonnCCuurrssoorrIIccoonn and	XXmmNNssttaatteeCCuurrssoorrIIccoonn resources of
  XXmmDDrraaggCCoonntteexxtt	specify	DragIcons for dynamic cues.

  A drag-over visual typically consists	of a source, operation and state
  DragIcon.  The XXmmNNbblleennddMMooddeell resource	of XXmmDDrraaggCCoonntteexxtt offers	several
  options that determine which icons are blended to produce the	drag-over
  visual.  DragIcon resources control the relative position of the operation
  and state icons (if used).  If a particular DragIcon is not specified, the
  toolkit uses the XXmmSSccrreeeenn default DragIcons.

  An application initializes a DragIcon	with the function XXmmCCrreeaatteeDDrraaggIIccoonn or
  through entries in the resource database.  If	a pixmap and its mask
  (optional) are specified in the resource database, the toolkit converts the
  values in the	X11 Bitmap file	format and assigns values to the correspond-
  ing resources.

  Classes

  DragIcon inherits behavior and a resource from OObbjjeecctt.

  The class pointer is xxmmDDrraaggIIccoonnOObbjjeeccttCCllaassss.

  The class name is XXmmDDrraaggIIccoonn.

  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C), set by using XXttSSeettVVaalluueess
  (SS), retrieved by using XXttGGeettVVaalluueess (GG), or is not applicable	(NN//AA).

			    XXmmDDrraaggIIccoonn 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
	      ___________________________________________________
	      ___________________________________________________
	      XmNattachment	    XmATTACH_NORTH_WEST	   CSG
		    XmCAttachment	   unsigned char
	      ___________________________________________________
	      XmNdepth		    1			   CSG
		    XmCDepth		   int
	      ___________________________________________________
	      XmNheight		    0			   CSG
		    XmCHeight		   Dimension
	      ___________________________________________________
	      XmNhotX		    0			   CSG
		    XmCHot		   Position
	      ___________________________________________________
	      XmNhotY		    0			   CSG
		    XmCHot		   Position
	      ____________________
	      XmNmask		    XmUNSPECIFIED_PIXMAP   CSG
		    XmCPixmap		   Pixmap
	      ___________________________________________________
	      XmNoffsetX	    0			   CSG
		    XmCOffset		   Position
	      ___________________________________________________
	      XmNoffsetY	    0			   CSG
		    XmCOffset		   Position
	      ___________________________________________________
	      XmNpixmap		    XmUNSPECIFIED_PIXMAP   CSG
		    XmCPixmap		   Pixmap
	      ___________________________________________________
	      XmNwidth		    0			   CSG
		    XmCWidth		   Dimension
	      ___________________________________________________

  XXmmNNaattttaacchhmmeenntt
	      Specifies	a relative location on the source icon for the
	      attachment of the	state or operation icon.  The origin of	the
	      state and	operation icons	is aligned with	the specified compass
	      point on the source icon.	 The XXmmNNooffffsseettXX	and XXmmNNooffffsseettYY
	      resources	can be used to further refine the icon positions.
	      The possible values are:

	      XXmmAATTTTAACCHH__NNOORRTTHH__WWEESSTT
			Attaches the origin of the state or operation icon to
			the northwest point on the source icon.

	      XXmmAATTTTAACCHH__NNOORRTTHH
			Attaches the origin of the state or operation icon to
			the north point	on the source icon.

	      XXmmAATTTTAACCHH__NNOORRTTHH__EEAASSTT
			Attaches the origin of the state or operation icon to
			the northeast point on the source icon.

	      XXmmAATTTTAACCHH__EEAASSTT
			Attaches the origin of the state or operation icon to
			the east point on the source icon.

	      XXmmAATTTTAACCHH__SSOOUUTTHH__EEAASSTT
			Attaches the origin of the state or operation icon to
			the southeast point on the source icon.

	      XXmmAATTTTAACCHH__SSOOUUTTHH
			Attaches the origin of the state or operation icon to
			the south point	on the source icon.

	      XXmmAATTTTAACCHH__SSOOUUTTHH__WWEESSTT
			Attaches the origin of the state or operation icon to
			the southwest point on the source icon.

	      XXmmAATTTTAACCHH__WWEESSTT
			Attaches the origin of the state or operation icon to
			the west point on the source icon.

	      XXmmAATTTTAACCHH__CCEENNTTEERR
			Attaches the origin of the state or operation icon to
			the center of the source icon.	The XXmmNNooffffsseettXX and
			XXmmNNooffffsseettYY resources may be used to center the
			attached icon.

	      XXmmAATTTTAACCHH__HHOOTT
			Attaches the hotspot coordinates of a state or opera-
			tion DragIcon to an _x,_y	position on the	source icon.
			The _x,_y	coordinate is taken from the event passed to
			the XXmmDDrraaggSSttaarrtt	function, and made relative to the
			widget passed as an argument to	the same function.

  XXmmNNddeepptthh    Specifies	the depth of the pixmap.

  XXmmNNhheeiigghhtt   Specifies	the height of the pixmap.

  XXmmNNhhoottXX     Specifies	the x-coordinate of the	hotspot	of a cursor DragIcon
	      in relation to the origin	of the pixmap bounding box.

  XXmmNNhhoottYY     Specifies	the y-coordinate of the	hotspot	of a cursor DragIcon
	      in relation to the origin	of the pixmap bounding box.

  XXmmNNmmaasskk     Specifies	a pixmap of depth one to use as	the DragIcon mask
	      pixmap.

  XXmmNNooffffsseettXX  Specifies	a horizontal offset (in	pixels)	of the origin of the
	      state or operation icon relative to the attachment point on the
	      source icon.  A positive offset value moves the origin to	the
	      right; a negative	value moves the	origin to the left.

  XXmmNNooffffsseettYY  Specifies	a vertical offset (in pixels) of the origin of the
	      state or operation icon relative to the attachment point on the
	      source icon.  A positive offset value moves the origin down; a
	      negative value moves the origin up.

  XXmmNNppiixxmmaapp   Specifies	a pixmap to use	as the DragIcon	pixmap.

  XXmmNNwwiiddtthh    Specifies	the width of the pixmap.



  Inherited Resources

  DragIcon inherits behavior and a resource from OObbjjeecctt.  For a	complete
  description of this resource,	refer to the OObbjjeecctt man	page.


			      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
	      ___________________________________________________

RELATED	INFORMATION
  OObbjjeecctt((33XX)), XXmmCCrreeaatteeDDrraaggIIccoonn((33XX)), XXmmDDiissppllaayy((33XX)), XXmmDDrraaggCCoonntteexxtt((33XX)),
  XXmmDDrrooppSSiittee((33XX)), XXmmDDrrooppTTrraannssffeerr((33XX)), and XXmmSSccrreeeenn((33XX)).





















































