


XmMainWindow(3X)					     XmMainWindow(3X)
OSF/Motif							    OSF/Motif



NAME
  XXmmMMaaiinnWWiinnddooww - The MainWindow	widget class

SYNOPSIS


  ##iinncclluuddee <<XXmm//MMaaiinnWW..hh>>

DESCRIPTION
  MainWindow provides a	standard layout	for the	primary	window of an applica-
  tion.	 This layout includes a	MenuBar, a CommandWindow, a work region, a
  MessageWindow, and ScrollBars.  Any or all of	these areas are	optional.
  The work region and ScrollBars in the	MainWindow behave identically to the
  work region and ScrollBars in	the ScrolledWindow widget.  The	user can
  think	of the MainWindow as an	extended ScrolledWindow	with an	optional
  MenuBar and optional CommandWindow and MessageWindow.

  In a fully-loaded MainWindow,	the MenuBar spans the top of the window	hor-
  izontally.  The CommandWindow	spans the MainWindow horizontally just below
  the MenuBar, and the work region lies	below the CommandWindow.  The Mes-
  sageWindow is	is below the work region.  Any space remaining below the Mes-
  sageWindow is	managed	in a manner identical to ScrolledWindow.  The
  behavior of ScrolledWindow can be controlled by the ScrolledWindow
  resources.  To create	a MainWindow, first create the work region elements,
  a MenuBar, a CommandWindow, a	MessageWindow, a horizontal ScrollBar, and a
  vertical ScrollBar widget, and then call XXmmMMaaiinnWWiinnddoowwSSeettAArreeaass	with those
  widget IDs.

  MainWindow can also create three Separator widgets that provide a visual
  separation of	MainWindow's four components.  The user	can specify resources
  in a resource	file for the automatically created gadgets that	contain	the
  MainWindow separators.  The name of the first	separator gadget is "Separa-
  tor1"; the second is "Separator2"; and the third is "Separator3".

  Classes

  MainWindow inherits behavior and resources from CCoorree,	CCoommppoossiittee, CCoonn--
  ssttrraaiinntt, XXmmMMaannaaggeerr, and SSccrroolllleeddWWiinnddooww classes.

  The class pointer is xxmmMMaaiinnWWiinnddoowwWWiiddggeettCCllaassss.

  The class name is XXmmMMaaiinnWWiinnddooww.

  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
  underscores 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mMMaaiinnWWiinnddooww	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
	_______________________________________________________________
	_______________________________________________________________
	XmNcommandWindow		  NULL			 CSG
	      XmCCommandWindow			 Widget
	_______________________________________________________________
	XmNcommandWindowLocation	  ABOVE	(See Desc.)	 CG
	      XmCCommandWindowLocation		 unsigned char
	_______________________________________________________________
	XmNmainWindowMarginHeight	  0			 CSG
	      XmCMainWindowMarginHeight		 Dimension
	_______________________________________________________________
	XmNmainWindowMarginWidth	  0			 CSG
	      XmCMainWindowMarginWidth		 Dimension
	_______________________________________________________________
	XmNmenuBar			  NULL			 CSG
	      XmCMenuBar			 Widget
	_______________________________________________________________
	XmNmessageWindow		  NULL			 CSG
	      XmCMessageWindow			 Widget
	_______________________________________________________________
	XmNshowSeparator		  False			 CSG
	      XmCShowSeparator			 Boolean
	_______________________________________________________________

  XXmmNNccoommmmaannddWWiinnddooww
	    Specifies the widget to be laid out	as the CommandWindow.  This
	    widget must	have been previously created and managed as a child
	    of MainWindow.

  XXmmNNccoommmmaannddWWiinnddoowwLLooccaattiioonn
	    Controls the position of the command window.
	    XXmmCCOOMMMMAANNDD__AABBOOVVEE__WWOORRKKSSPPAACCEE locates the command window between the
	    menu bar and the work window.  XXmmCCOOMMMMAANNDD__BBEELLOOWW__WWOORRKKSSPPAACCEE locates
	    the	command	window between the work	window and the message win-
	    dow.

  XXmmNNmmaaiinnWWiinnddoowwMMaarrggiinnHHeeiigghhtt
	    Specifies the margin height	on the top and bottom of MainWindow.
	    This resource overrides any	setting	of the ScrolledWindow
	    resource XXmmNNssccrroolllleeddWWiinnddoowwMMaarrggiinnHHeeiigghhtt.

  XXmmNNmmaaiinnWWiinnddoowwMMaarrggiinnWWiiddtthh
	    Specifies the margin width on the right and	left sides of
	    MainWindow.	 This resource overrides any setting of	the Scrol-
	    ledWindow resource XXmmNNssccrroolllleeddWWiinnddoowwMMaarrggiinnWWiiddtthh.

  XXmmNNmmeennuuBBaarr
	    Specifies the widget to be laid out	as the MenuBar.	 This widget
	    must have been previously created and managed as a child of
	    MainWindow.

  XXmmNNmmeessssaaggeeWWiinnddooww
	    Specifies the widget to be laid out	as the MessageWindow.  This
	    widget must	have been previously created and managed as a child
	    of MainWindow.  The	MessageWindow is positioned at the bottom of
	    the	MainWindow.  If	this value is NULL, no message window is
	    included in	the MainWindow.

  XXmmNNsshhoowwSSeeppaarraattoorr
	    Displays separators	between	the components of the MainWindow when
	    set	to True.  If set to False, no separators are displayed.

  Inherited Resources

  MainWindow 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mSSccrroolllleeddWWiinnddooww 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
     ____________________________________________________________________
     ____________________________________________________________________
     XmNclipWindow			   dynamic		   G
	   XmCClipWindow			  Widget
     ____________________________________________________________________
     XmNhorizontalScrollBar		   dynamic		   CSG
	   XmCHorizontalScrollBar		  Widget
     ____________________________________________________________________
     XmNscrollBarDisplayPolicy		   dynamic		   CSG
	   XmCScrollBarDisplayPolicy		  unsigned char
     ____________________________________________________________________
     XmNscrollBarPlacement		   XmBOTTOM_RIGHT	   CSG
	   XmCScrollBarPlacement		  unsigned char
     ____________________________________________________________________
     XmNscrolledWindowMarginHeight	   0			   N/A
	   XmCScrolledWindowMarginHeight	  Dimension
     ____________________________________________________________________
     XmNscrolledWindowMarginWidth	   0			   N/A
	   XmCScrolledWindowMarginWidth		  Dimension
     ____________________________________________________________________
     XmNscrollingPolicy			   XmAPPLICATION_DEFINED   CG
	   XmCScrollingPolicy			  unsigned char
     ____________________________________________________________________
     XmNspacing				   4			   CSG
	   XmCSpacing				  Dimension
     ____________________________________________________________________
     XmNtraverseObscuredCallback	   NULL			   CSG
	   XmCCallback				  XtCallbackList
     ____________________________________________________________________
     XmNverticalScrollBar		   dynamic		   CSG
	   XmCVerticalScrollBar			  Widget
     ____________________________________________________________________
     XmNvisualPolicy			   dynamic		   G
	   XmCVisualPolicy			  unsigned char
     ____________________________________________________________________
     XmNworkWindow			   NULL			   CSG
	   XmCWorkWindow			  Widget
     ____________________________________________________________________

			    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	      0				 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

  MainWindow inherits translations from	ScrolledWindow.

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eMMaaiinnWWiinnddooww((33XX)),
  XXmmMMaaiinnWWiinnddoowwSSeepp11((33XX)),	XXmmMMaaiinnWWiinnddoowwSSeepp22((33XX)), XXmmMMaaiinnWWiinnddoowwSSeepp33((33XX)),
  XXmmMMaaiinnWWiinnddoowwSSeettAArreeaass((33XX)), XXmmMMaannaaggeerr((33XX)), and XXmmSSccrroolllleeddWWiinnddooww((33XX))








