


XmFrame(3X)							  XmFrame(3X)
OSF/Motif							    OSF/Motif



NAME
  XXmmFFrraammee - The	Frame widget class

SYNOPSIS


  ##iinncclluuddee <<XXmm//FFrraammee..hh>>

DESCRIPTION
  Frame	is a very simple manager used to enclose a single work area child in
  a border drawn by Frame.  It uses the	Manager	class resources	for border
  drawing and performs geometry	management so that its size always matches
  its child's outer size plus the Frame's margins and shadow thickness.

  Frame	is most	often used to enclose other managers when the application
  developer desires the	manager	to have	the same border	appearance as the
  primitive widgets.  Frame can	also be	used to	enclose	primitive widgets
  that do not support the same type of border drawing.	This gives visual
  consistency when you develop applications using diverse widget sets.	Con-
  straint resources are	used to	designate a child as the Frame title, align
  its text, and	control	its vertical alignment in relation to Frame's top
  shadow.  The title appears only at the top of	the Frame.

  If the Frame's parent	is a Shell widget, XXmmNNsshhaaddoowwTTyyppee defaults to
  XXmmSSHHAADDOOWW__OOUUTT,	and Manager's resource XXmmNNsshhaaddoowwTThhiicckknneessss defaults to 1.

  If the Frame's parent	is not a Shell widget, XXmmNNsshhaaddoowwTTyyppee defaults to
  XXmmSSHHAADDOOWW__EETTCCHHEEDD__IINN, and Manager's resource XXmmNNsshhaaddoowwTThhiicckknneessss	defaults to
  2.

  Classes

  Frame	inherits behavior and resources	from the CCoorree, CCoommppoossiittee, CCoonnssttrraaiinntt,
  and XXmmMMaannaaggeerr	classes.

  The class pointer is xxmmFFrraammeeWWiiddggeettCCllaassss.

  The class name is XXmmFFrraammee.

  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mFFrraamme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
	     _____________________________________________________
	     _____________________________________________________
	     XmNmarginWidth	     0			    CSG
		   XmCMarginWidth	    Dimension
	     _____________________________________________________
	     XmNmarginHeight	     0			    CSG
		   XmCMarginHeight	    Dimension
	     _____________________________________________________
	     XmNshadowType	     dynamic		    CSG
		   XmCShadowType	    unsigned char
	     _____________________________________________________

  XXmmNNmmaarrggiinnWWiiddtthh
	    Specifies the padding space	on the left and	right sides between
	    Frame's child and Frame's shadow drawing.

  XXmmNNmmaarrggiinnHHeeiigghhtt
	    Specifies the padding space	on the top and bottom sides between
	    Frame's child and Frame's shadow drawing.  When a title is
	    present, the top margin equals the value specified by this
	    resource plus the distance (if any)	that the title extends below
	    the	top shadow.

  XXmmNNsshhaaddoowwTTyyppee
	    Describes the drawing style	for Frame.  This resource can have
	    the	following values:

	      oo++
	      XXmmSSHHAADDOOWW__IINN-draws	Frame so that it appears inset.	 This means
	      that the bottom shadow visuals and top shadow visuals are
	      reversed.

	      oo++
	      XXmmSSHHAADDOOWW__OOUUTT-draws Frame so that it appears outset.  This	is
	      the default if Frame's parent is a Shell widget.

	      oo++
	      XXmmSSHHAADDOOWW__EETTCCHHEEDD__IINN-draws Frame using a double line giving	the
	      effect of	a line etched into the window.	The thickness of the
	      double 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.	This
	      is the default when Frame's parent is not	a Shell	widget.

	      oo++
	      XXmmSSHHAADDOOWW__EETTCCHHEEDD__OOUUTT-draws	Frame using a double line giving the
	      effect of	a line coming out of the window.  The thickness	of
	      the double 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.

			XXmmFFrraammee	CCoonnssttrraaiinnt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
      ___________________________________________________________________
      ___________________________________________________________________
      XmNchildType			  XmFRAME_WORKAREA_CHILD   CSG
	    XmCChildType			 unsigned char
      ___________________________________________________________________
      XmNchildHorizontalAlignment	  XmALIGNMENT_BEGINNING	   CSG
	    XmCChildHorizontalAlignment		 unsigned char
      ___________________________________________________________________
      XmNchildHorizontalSpacing		  dynamic		   CSG
	    XmCChildHorizontalSpacing		 Dimension
      ___________________________________________________________________
      XmNchildVerticalAlignment		  XmALIGNMENT_CENTER	   CSG
	    XmCChildVerticalAlignment		 unsigned char
      ___________________________________________________________________

  XXmmNNcchhiillddTTyyppee
	    Specifies whether a	child is a title or work area.	Frame
	    supports a single title and/or work	area child.  The possible
	    values are:

	      oo++
	      XXmmFFRRAAMMEE__TTIITTLLEE__CCHHIILLDD

	      oo++
	      XXmmFFRRAAMMEE__WWOORRKKAARREEAA__CCHHIILLDD

	      oo++
	      XXmmFFRRAAMMEE__GGEENNEERRIICC__CCHHIILLDD
	      The Frame	geometry manager ignores any child of type
	      XXmmFFRRAAMMEE__GGEENNEERRIICC__CCHHIILLDD.

  XXmmNNcchhiillddHHoorriizzoonnttaallAAlliiggnnmmeenntt
	    Specifies the alignment of the title.  This	resource has the fol-
	    lowing values:

	      oo++
	      XXmmAALLIIGGNNMMEENNTT__BBEEGGIINNNNIINNGG

	      oo++
	      XXmmAALLIIGGNNMMEENNTT__CCEENNTTEERR

	      oo++
	      XXmmAALLIIGGNNMMEENNTT__EENNDD
	      See the description of  XXmmNNaalliiggnnmmeenntt in the XXmmLLaabbeell man page
	      for an explanation of these values.

  XXmmNNcchhiillddHHoorriizzoonnttaallSSppaacciinngg
	    Specifies the minimum distance between either edge of the title
	    text and the inner edge of the Frame shadow.  Clipping of the
	    title text occurs in order to maintain this	spacing.  The default
	    value is the margin	width of the Frame.

  XXmmNNcchhiillddVVeerrttiiccaallAAlliiggnnmmeenntt
	    Specifies the vertical alignment of	the title text,	or the title
	    area in relation to	the top	shadow of the Frame.

	      oo++
	      XXmmAALLIIGGNNMMEENNTT__BBAASSEELLIINNEE__BBOOTTTTOOMM-causes the baseline of the title to
	      align vertically with the	top shadow of the Frame.  In the case
	      of a multi-line title, the baseline of the last line of text
	      aligns vertically	with the top shadow of the Frame.

	      oo++
	      XXmmAALLIIGGNNMMEENNTT__BBAASSEELLIINNEE__TTOOPP-causes the baseline of the first	line
	      of the title to align vertically with the	top shadow of the
	      Frame.

	      oo++
	      XXmmAALLIIGGNNMMEENNTT__WWIIDDGGEETT__TTOOPP-causes the	top edge of the	title area to
	      align vertically with the	top shadow of the Frame.

	      oo++
	      XXmmAALLIIGGNNMMEENNTT__CCEENNTTEERR-causes	the center of the title	area to	align
	      vertically with the top shadow of	the Frame.

	      oo++
	      XXmmAALLIIGGNNMMEENNTT__WWIIDDGGEETT__BBOOTTTTOOMM-causes the bottom edge of the title
	      area to align vertically with the	top shadow of the Frame.

  Inherited Resources

  Frame	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mMMaannaaggeer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
	_______________________________________________________________
	_______________________________________________________________
	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
	_______________________________________________________________
	XmNhighlightPixmap	      dynamic			 CSG
	      XmCHighlightPixmap	     Pixmap
	_______________________________________________________________
	XmNinitialFocus		      NULL			 CSG
	      XmCInitialFocus		     Widget
	_______________________________________________________________
	XmNnavigationType	      XmTAB_GROUP		 CSG
	      XmCNavigationType		     XmNavigationType
	_______________________________________________________________
	XmNshadowThickness	      dynamic			 CSG
	      XmCShadowThickness	     Dimension
	_______________________________________________________________
	XmNstringDirection	      dynamic			 CG
	      XmCStringDirection	     XmStringDirection
	_______________________________________________________________
	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
	_______________________________________________________________

			    CCoommppoossiitte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
	     _____________________________________________________
	     _____________________________________________________
	     XmNchildren	       NULL		    G
		   XmCReadOnly		      WidgetList
	     _____________________________________________________
	     XmNinsertPosition	       NULL		    CSG
		   XmCInsertPosition	      XtOrderProc
	     _____________________________________________________
	     XmNnumChildren	       0		    G
		   XmCReadOnly		      Cardinal
	     _____________________________________________________

			      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

  XmFrame inherits translations	from XmManager.

RELATED	INFORMATION
  CCoommppoossiittee((33XX)), CCoonnssttrraaiinntt((33XX)), CCoorree((33XX)), XXmmCCrreeaatteeFFrraammee((33XX)), and
  XXmmMMaannaaggeerr((33XX)).

























































