


XmPanedWindow(3X)					    XmPanedWindow(3X)
OSF/Motif							    OSF/Motif



NAME
  XXmmPPaanneeddWWiinnddooww	- The PanedWindow widget class

SYNOPSIS


  ##iinncclluuddee <<XXmm//PPaanneeddWW..hh>>

DESCRIPTION
  PanedWindow is a composite widget that lays out children in a	vertically
  tiled	format.	 Children appear in top-to-bottom fashion, with	the first
  child	inserted appearing at the top of the PanedWindow and the last child
  inserted appearing at	the bottom.  The PanedWindow grows to match the	width
  of its widest	child and all other children are forced	to this	width. The
  height of the	PanedWindow is equal to	the sum	of the heights of all its
  children, the	spacing	between	them, and the size of the top and bottom mar-
  gins.

  The user can also adjust the size of the panes.  To facilitate this adjust-
  ment,	a pane control sash is created for most	children.  The sash appears
  as a square box positioned on	the bottom of the pane that it controls.  The
  user can adjust the size of a	pane by	using the mouse	or keyboard.

  The PanedWindow is also a constraint widget, which means that	it creates
  and manages a	set of constraints for each child.  You	can specify a minimum
  and maximum size for each pane.  The PanedWindow does	not allow a pane to
  be resized below its minimum size or beyond its maximum size.	 Also, when
  the minimum size of a	pane is	equal to its maximum size, no control sash is
  presented for	that pane or for the lowest pane.

  The default XXmmNNiinnsseerrttPPoossiittiioonn	procedure for PanedWindow causes sashes	to be
  inserted at the end of the list of children and causes non-sash widgets to
  be inserted after other non-sash children but	before any sashes.

  All panes and	sashes in a PanedWindow	must be	tab groups.  When a pane is
  inserted as a	child of the PanedWindow, if the pane's	XXmmNNnnaavviiggaattiioonnTTyyppee is
  not XXmmEEXXCCLLUUSSIIVVEE__TTAABB__GGRROOUUPP, PanedWindow sets it to XXmmSSTTIICCKKYY__TTAABB__GGRROOUUPP.

  Classes

  PanedWindow inherits behavior	and resources from the 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, and XXmmMMaannaaggeerr classes.

  The class pointer is xxmmPPaanneeddWWiinnddoowwWWiiddggeettCCllaassss.

  The class name is XXmmPPaanneeddW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 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mPPaanne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
	     ____________________________________________________
	     ____________________________________________________
	     XmNmarginHeight		3		   CSG
		   XmCMarginHeight	       Dimension
	     ____________________________________________________
	     XmNmarginWidth		3		   CSG
		   XmCMarginWidth	       Dimension
	     ____________________________________________________
	     XmNrefigureMode		True		   CSG
		   XmCBoolean		       Boolean
	     ____________________________________________________
	     XmNsashHeight		10		   CSG
		    XmCSashHeight	       Dimension
	     ____________________________________________________
	     XmNsashIndent		-10		   CSG
		   XmCSashIndent	       Position
	     ____________________________________________________
	     XmNsashShadowThickness	dynamic		   CSG
		   XmCShadowThickness	       Dimension
	     ____________________________________________________
	     XmNsashWidth		10		   CSG
		    XmCSashWidth	       Dimension
	     ____________________________________________________
	     XmNseparatorOn		True		   CSG
		   XmCSeparatorOn	       Boolean
	     ____________________________________________________
	     XmNspacing			8		   CSG
		   XmCSpacing		       Dimension
	     ____________________________________________________

  XXmmNNmmaarrggiinnHHeeiigghhtt
	    Specifies the distance between the top and bottom edges of the
	    PanedWindow	and its	children.

  XXmmNNmmaarrggiinnWWiiddtthh
	    Specifies the distance between the left and	right edges of the
	    PanedWindow	and its	children.

  XXmmNNrreeffiigguurreeMMooddee
	    Determines whether the panes' positions are	recomputed and repo-
	    sitioned when programmatic changes are being made to the
	    PanedWindow.  Setting this resource	to True	resets the children
	    to their appropriate positions.

  XXmmNNssaasshhHHeeiigghhtt
	    Specifies the height of the	sash.

  XXmmNNssaasshhIInnddeenntt
	    Specifies the horizontal placement of the sash along each pane.
	    A positive value causes the	sash to	be offset from the near
	    (left) side	of the PanedWindow, and	a negative value causes	the
	    sash to be offset from the far (right) side	of the PanedWindow.
	    If the offset is greater than the width of the PanedWindow minus
	    the	width of the sash, the sash is placed flush against the	near
	    side of the	PanedWindow.

	    Whether the	placement actually corresponds to the left or right
	    side of the	PanedWindow may	depend on the value of the XXmmNNssttrriinngg--
	    DDiirreeccttiioonn resource.

  XXmmNNssaasshhSShhaaddoowwTThhiicckknneessss
	    Specifies the thickness of the shadows of the sashes.

  XXmmNNssaasshhWWiiddtthh
	    Specifies the width	of the sash.

  XXmmNNsseeppaarraattoorrOOnn
	    Determines whether a separator is created between each of the
	    panes.  Setting this resource to True creates a Separator at the
	    midpoint between each of the panes.

  XXmmNNssppaacciinngg
	    Specifies the distance between each	child pane.

			 XXmmPPaanneeddWWiinnddooww 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
		   __________________________________________________
		   __________________________________________________
		   XmNallowResize	    False	       CSG
			 XmCBoolean		   Boolean
		   __________________________________________________
		   XmNpaneMaximum	    1000	       CSG
			 XmCPaneMaximum		   Dimension
		   __________________________________________________
		   XmNpaneMinimum	    1		       CSG
			 XmCPaneMinimum		   Dimension
		   __________________________________________________
		   XmNpositionIndex	    XmLAST_POSITION    CSG
			 XmCPositionIndex	   short
		   __________________________________________________
		   XmNskipAdjust	    False	       CSG
			 XmCBoolean		   Boolean
		   __________________________________________________

  XXmmNNaalllloowwRReessiizzee
	    Allows an application to specify whether the PanedWindow should
	    allow a pane to request to be resized.  This flag has an effect
	    only after the PanedWindow and its children	have been realized.
	    If this flag is set	to True, the PanedWindow tries to honor
	    requests to	alter the height of the	pane. If False,	it always
	    denies pane	requests to resize.

  XXmmNNppaanneeMMaaxxiimmuumm
	    Allows an application to specify the maximum size to which a pane
	    may	be resized.  This value	must be	greater	than the specified
	    minimum.

  XXmmNNppaanneeMMiinniimmuumm
	    Allows an application to specify the minimum size to which a pane
	    may	be resized.  This value	must be	greater	than 0.

  XXmmNNppoossiittiioonnIInnddeexx
	    Specifies the position of the widget in its	parent's list of
	    children (the list of pane children, not including sashes).	 The
	    value is an	integer	that is	no less	than zero and no greater than
	    the	number of children in the list at the time the value is
	    specified.	A value	of zero	means that the child is	placed at the
	    beginning of the list.  The	value can also be  specified as
	    XXmmLLAASSTT__PPOOSSIITTIIOONN (the default), which means that the	child is
	    placed at the end of the list.  Any	other value is ignored.
	    XXttGGeettVVaalluueess	returns	the position of	the widget in its parent's
	    child list at the time of the call to XXttGGeettVVaalluueess.

	    When a widget is inserted into its parent's	child list, the
	    positions of any existing children that are	greater	than or	equal
	    to the specified widget's XXmmNNppoossiittiioonnIInnddeexx are increased by	one.
	    The	effect of a call to XXttSSeettVVaalluueess	for XXmmNNppoossiittiioonnIInnddeexx is	to
	    remove the specified widget	from its parent's child	list,
	    decrease by	one the	positions of any existing children that	are
	    greater than the specified widget's	former position	in the list,
	    and	then insert the	specified widget into its parent's child list
	    as described in the	preceding sentence.

  XXmmNNsskkiippAAddjjuusstt
	    When set to	True, this Boolean resource allows an application to
	    specify that the PanedWindow should	not automatically resize this
	    pane.

  Inherited Resources

  PanedWindow inherits behavior	and resources from the following superc-
  lasses.  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	      2				 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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
     ____________________________________________________________________

			    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	       default procedure    CSG
		   XmCInsertPosition	      XtOrderProc
	     _____________________________________________________
	     XmNnumChildren	       0		    G
		   XmCReadOnly		      Cardinal
	     _____________________________________________________

  Translations

  XmPanedWindow	inherits translations from XmManager.

  The translations for sashes within the PanedWindow are listed	below.	These
  translations may not directly	correspond to a	translation table.

       BBSSeelleecctt PPrreessss:: SSaasshhAAccttiioonn((SSttaarrtt))
       BBSSeelleecctt MMoottiioonn::SSaasshhAAccttiioonn((MMoovvee))
       BBSSeelleecctt RReelleeaassee::SSaasshhAAccttiioonn((CCoommmmiitt))
       BBDDrraagg PPrreessss::   SSaasshhAAccttiioonn((SSttaarrtt))
       BBDDrraagg MMoottiioonn::  SSaasshhAAccttiioonn((MMoovvee))
       BBDDrraagg RReelleeaassee:: SSaasshhAAccttiioonn((CCoommmmiitt))
       KKUUpp::	      SSaasshhAAccttiioonn((KKeeyy,,DDeeffaauullttIInnccrr,,UUpp))
       MMCCttrrll KKUUpp::     SSaasshhAAccttiioonn((KKeeyy,,LLaarrggeeIInnccrr,,UUpp))
       KKDDoowwnn::	      SSaasshhAAccttiioonn((KKeeyy,,DDeeffaauullttIInnccrr,,DDoowwnn))
       MMCCttrrll KKDDoowwnn::   SSaasshhAAccttiioonn((KKeeyy,,LLaarrggeeIInnccrr,,DDoowwnn))
       KKNNeexxttFFiieelldd::    NNeexxttTTaabbGGrroouupp(())
       KKPPrreevvFFiieelldd::    PPrreevvTTaabbGGrroouupp(())
       KKHHeellpp::	      HHeellpp(())

  Action Routines

  The XmPanedWindow action routines are	described below:

  HHeellpp(()):   Calls the callbacks	for XXmmNNhheellppCCaallllbbaacckk if any exist.  If there
	    are	no help	callbacks for this widget, this	action calls the help
	    callbacks for the nearest ancestor that has	them.

  NNeexxttTTaabbGGrroouupp(()):
	    Moves the keyboard focus to	the next tab group.  By	default	each
	    pane and sash is a tab group.

  PPrreevvTTaabbGGrroouupp(()):
	    Moves the keyboard focus to	the previous tab group.	 By default
	    each pane and sash is a tab	group.

  SSaasshhAAccttiioonn((_a_c_t_i_o_n)) or	SSaasshhAAccttiioonn((KKeeyy,,_i_n_c_r_e_m_e_n_t,,_d_i_r_e_c_t_i_o_n)):
	    The	SSttaarrtt action activates the interactive placement of the
	    pane's borders.  The MMoovvee action causes the	sash to	track the
	    position of	the pointer.  If one of	the panes reaches its minimum
	    or maximum size, adjustment	continues with the next	adjustable
	    pane.  The CCoommmmiitt action ends sash motion.

	    When sash action is	caused by a keyboard event, the	sash with the
	    keyboard focus is moved according to the _i_n_c_r_e_m_e_n_t and _d_i_r_e_c_t_i_o_n
	    specified.	DDeeffaauullttIInnccrr adjusts the	sash by	one line.  LLaarrggeeIInnccrr
	    adjusts the	sash by	one view region.  The _d_i_r_e_c_t_i_o_n	is specified
	    as either UUpp or DDoowwnn.

	    Note that the SashAction action routine is not a direct action
	    routine of the XmPanedWindow, but rather an	action of the Sash
	    control created by the XmPanedWindow.

  Additional Behavior

  This widget has the additional behavior described below:

  <<FFooccuussIInn>>:
	    Moves the keyboard focus to	the sash and highlights	it.

  <<FFooccuussOOuutt>>:
	    Unsets the keyboard	focus in the sash and unhighlights it.

  Virtual Bindings

  The bindings for virtual keys	are vendor specific.  For information about
  bindings for virtual buttons and keys, see VViirrttuuaallBBiinnddiinnggss((33XX)).

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ePPaanneeddWWiinnddooww((33XX)), and
  XXmmMMaannaaggeerr((33XX)).








































