


XmSeparator(3X)						      XmSeparator(3X)
OSF/Motif							    OSF/Motif



NAME
  XXmmSSeeppaarraattoorr -	The Separator widget class

SYNOPSIS


  ##iinncclluuddee <<XXmm//SSeeppaarraattoorr..hh>>

DESCRIPTION
  Separator is a primitive widget that separates items in a display.  Several
  different line drawing styles	are provided, as well as horizontal or verti-
  cal orientation.

  The Separator	line drawing is	automatically centered within the height of
  the widget for a horizontal orientation and centered within the width	of
  the widget for a vertical orientation.  An XXttSSeettVVaalluueess with a	new
  XXmmNNsseeppaarraattoorrTTyyppee resizes the widget to its minimal height (for horizontal
  orientation) or its minimal width (for vertical orientation) unless height
  or width is explicitly set in	the XXttSSeettVVaalluueess	call.

  Separator does not draw shadows around the separator.	 The Primitive
  resource XXmmNNsshhaaddoowwTThhiicckknneessss is used for the Separator's thickness when
  XXmmNNsseeppaarraattoorrTTyyppee is XXmmSSHHAADDOOWW__EETTCCHHEEDD__IINN, XXmmSSHHAADDOOWW__EETTCCHHEEDD__IINN__DDAASSHH,
  XXmmSSHHAADDOOWW__EETTCCHHEEDD__OOUUTT, or XXmmSSHHAADDOOWW__EETTCCHHEEDD__OOUUTT__DDAASSHH.

  Separator does not highlight and allows no traversing.  The primitive
  resource XXmmNNttrraavveerrssaallOOnn is forced to False.

  The XXmmNNsseeppaarraattoorrTTyyppee of XXmmNNOO__LLIINNEE provides an	escape to the application
  programmer who needs a different style of drawing.  A	pixmap the height of
  the widget can be created and	used as	the background pixmap by building an
  argument list	using the XXmmNNbbaacckkggrroouunnddPPiixxmmaapp argument type as defined by
  CCoorree.	 Whenever the widget is	redrawn, its background	is displayed contain-
  ing the desired separator drawing.

  Classes

  Separator inherits behavior and resources from CCoorree and XXmmPPrriimmiittiivvee
  Classes.

  The class pointer is xxmmSSeeppaarraattoorrWWiiddggeettCCllaassss.

  The class name is XXmmSSeeppaarraattoorr.

  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mSSeeppaarraattoorr 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
	    ______________________________________________________
	    ______________________________________________________
	    XmNmargin		     0			    CSG
		  XmCMargin		    Dimension
	    ______________________________________________________
	    XmNorientation	     XmHORIZONTAL	    CSG
		  XmCOrientation	    unsigned char
	    ______________________________________________________
	    XmNseparatorType	     XmSHADOW_ETCHED_IN	    CSG
		  XmCSeparatorType	    unsigned char
	    ______________________________________________________

  XXmmNNmmaarrggiinn For	horizontal orientation,	specifies the space on the left	and
	    right sides	between	the border of the Separator and	the line
	    drawn.  For	vertical orientation, specifies	the space on the top
	    and	bottom between the border of the Separator and the line
	    drawn.

  XXmmNNoorriieennttaattiioonn
	    Displays Separator vertically or horizontally.  This resource can
	    have values	of XXmmVVEERRTTIICCAALL and XXmmHHOORRIIZZOONNTTAALL.

  XXmmNNsseeppaarraattoorrTTyyppee
	    Specifies the type of line drawing to be done in the Separator
	    widget.

	      oo++
	      XXmmSSIINNGGLLEE__LLIINNEE-single line.

	      oo++
	      XXmmDDOOUUBBLLEE__LLIINNEE-double line.

	      oo++
	      XXmmSSIINNGGLLEE__DDAASSHHEEDD__LLIINNEE-single-dashed line.

	      oo++
	      XXmmDDOOUUBBLLEE__DDAASSHHEEDD__LLIINNEE-double-dashed line.

	      oo++
	      XXmmNNOO__LLIINNEE-no line.

	      oo++
	      XXmmSSHHAADDOOWW__EETTCCHHEEDD__IINN-a line	whose shadows give the effect of a
	      line etched into the window.  The	thickness of the line is
	      equal to the value of XXmmNNsshhaaddoowwTThhiicckknneessss.	 For horizontal
	      orientation, the top shadow is drawn in XXmmNNttooppSShhaaddoowwCCoolloorr	and
	      the bottom shadow	is drawn in XXmmNNbboottttoommSShhaaddoowwCCoolloorr.  For verti-
	      cal orientation, the left	edge is	drawn in XXmmNNttooppSShhaaddoowwCCoolloorr
	      and the right edge is drawn in XXmmNNbboottttoommSShhaaddoowwCCoolloorr.

	      oo++
	      XXmmSSHHAADDOOWW__EETTCCHHEEDD__OOUUTT-a line whose shadows give the	effect of an
	      etched line coming out of	the window.  The thickness of the
	      line is equal to the value of XXmmNNsshhaaddoowwTThhiicckknneessss.	 For horizon-
	      tal orientation, the top shadow is drawn in XXmmNNbboottttoommSShhaa--
	      ddoowwCCoolloorr and the bottom shadow is	drawn in XXmmNNttooppSShhaaddoowwCCoolloorr.
	      For vertical orientation,	the left edge is drawn in XXmmNNbboott--
	      ttoommSShhaaddoowwCCoolloorr and the right edge	is drawn in XXmmNNttooppSShhaa--
	      ddoowwCCoolloorr.

	      oo++
	      XXmmSSHHAADDOOWW__EETTCCHHEEDD__IINN__DDAASSHH-identical	to XXmmSSHHAADDOOWW__EETTCCHHEEDD__IINN except
	      a	series of lines	creates	a dashed line.

	      oo++
	      XXmmSSHHAADDOOWW__EETTCCHHEEDD__OOUUTT__DDAASSHH-identical to XXmmSSHHAADDOOWW__EETTCCHHEEDD__OOUUTT
	      except a series of lines creates a dashed	line.

  Inherited Resources

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

			   XXmmPPrriimmiittiivvee 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			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	      0				CSG
	      XmCHighlightThickness	     Dimension
	______________________________________________________________
	XmNnavigationType	      XmNONE			CSG
	      XmCNavigationType		     XmNavigationType
	______________________________________________________________
	XmNshadowThickness	      2				CSG
	      XmCShadowThickness	     Dimension
	______________________________________________________________
	XmNtopShadowColor	      dynamic			CSG
	      XmCTopShadowColor		     Pixel
	______________________________________________________________
	XmNtopShadowPixmap	      dynamic			CSG
	      XmCTopShadowPixmap	     Pixmap
	______________________________________________________________
	XmNtraversalOn		      False			G
	      XmCTraversalOn		     Boolean
	______________________________________________________________
	XmNunitType		      dynamic			CSG
	      XmCUnitType		     unsigned char
	______________________________________________________________
	XmNuserData		      NULL			CSG
	      XmCUserData		     XtPointer
	______________________________________________________________

			      CCoorree 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
     ____________________________________________________________________
     ____________________________________________________________________
     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
     ____________________________________________________________________

  Translations

  There	are no translations for	XmSeparator.

RELATED	INFORMATION
  CCoorree((33XX)), XXmmCCrreeaatteeSSeeppaarraattoorr((33XX)), and XXmmPPrriimmiittiivvee((33XX)).
































































