XmPanedWindow(3X) UNIX System V XmPanedWindow(3X)
NAME
XmPanedWindow - the PanedWindow widget class.
SYNOPSIS
#include <Xm/PanedW.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 margins.
The user can also adjust the size of the panes. To facilitate this
adjustment, 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 XmNinsertPosition 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.
Classes
PanedWindow inherits behavior and resources from the Core, Composite,
Constraint, and XmManager classes.
The class pointer is xmPanedWindowWidgetClass.
The class name is XmPanedWindow.
New Resources
The following table defines a set of widget resources used by the
programmer 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
XmN or XmC prefix and use the remaining letters. To specify one of the
10/89 Page 1
XmPanedWindow(3X) UNIX System V XmPanedWindow(3X)
defined values for a resource in a .Xdefaults file, remove the Xm 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 XtSetValues (S), retrieved by using XtGetValues (G), or is not
applicable (N/A).
____________________________________________________________________________
| XmPanedWindow Resource Set |
|_______________________|____________________|___________|_________|________|
| Name | Class | Type | Default| Access|
|_______________________|____________________|___________|_________|________|
|_______________________|____________________|___________|_________|________|
| XmNmarginHeight | XmCMarginHeight | Dimension| 3 | CSG |
|_______________________|____________________|___________|_________|________|
| XmNmarginWidth | XmCMarginWidth | Dimension| 3 | CSG |
|_______________________|____________________|___________|_________|________|
| XmNrefigureMode | XmCBoolean | Boolean | True | CSG |
|_______________________|____________________|___________|_________|________|
| XmNsashHeight | XmCSashHeight | Dimension| 10 | CSG |
|_______________________|____________________|___________|_________|________|
| XmNsashIndent | XmCSashIndent | Position | -10 | CSG |
|_______________________|____________________|___________|_________|________|
| XmNsashShadowThickness| XmCShadowThickness| Dimension| dynamic| CSG |
|_______________________|____________________|___________|_________|________|
| XmNsashWidth | XmCSashWidth | Dimension| 10 | CSG |
|_______________________|____________________|___________|_________|________|
| XmNseparatorOn | XmCSeparatorOn | Boolean | True | CSG |
|_______________________|____________________|___________|_________|________|
| XmNspacing | XmCSpacing | Dimension| 8 | CSG |
|_______________________|____________________|___________|_________|________|
XmNmarginHeight
Specifies the distance between the top and bottom edges of the
PanedWindow and its children.
XmNmarginWidth
Specifies the distance between the left and right edges of the
PanedWindow and its children.
XmNrefigureMode
Determines whether the panes' positions are recomputed and
repositioned when programmatic changes are being made to the
PanedWindow. Setting this resource to True resets the children to
their appropriate positions.
XmNsashHeight
Specifies the height of the sash.
Page 2 10/89
XmPanedWindow(3X) UNIX System V XmPanedWindow(3X)
XmNsashIndent
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
XmNstringDirection resource.
XmNsashShadowThickness
Specifies the thickness of the shadows of the sashes.
XmNsashWidth
Specifies the width of the sash.
XmNseparatorOn
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.
XmNspacing
Specifies the distance between each child pane.
________________________________________________________________
| XmPanedWindow Constraint Resource Set |
|_______________|________________|___________|_________|________|
| Name | Class | Type | Default| Access|
|_______________|________________|___________|_________|________|
|_______________|________________|___________|_________|________|
| XmNallowResize| XmCBoolean | Boolean | False | CSG |
|_______________|________________|___________|_________|________|
| XmNpaneMaximum| XmCPaneMaximum| Dimension| 1000 | CSG |
|_______________|________________|___________|_________|________|
| XmNpaneMinimum| XmCPaneMinimum| Dimension| 1 | CSG |
|_______________|________________|___________|_________|________|
| XmNskipAdjust | XmCBoolean | Boolean | False | CSG |
|_______________|________________|___________|_________|________|
XmNallowResize
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.
10/89 Page 3
XmPanedWindow(3X) UNIX System V XmPanedWindow(3X)
XmNpaneMaximum
Allows an application to specify the maximum size to which a pane
may be resized. This value must be greater than the specified
minimum.
XmNpaneMinimum
Allows an application to specify the minimum size to which a pane
may be resized. This value must be greater than 0.
XmNskipAdjust
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
superclasses. For a complete description of each resource, refer to the
man page for that superclass.
_________________________________________________________________________________________________________
XmManager Resource Set
_________________________________________________________________________________________________________
Name Class Type Default Access
_________________________________________________________________________________________________________
_________________________________________________________________________________________________________
XmNbottomShadowColor XmCBottomShadowColor Pixel dynamic CSG
_________________________________________________________________________________________________________
XmNbottomShadowPixmap XmCBottomShadowPixmap Pixmap XmUNSPECIFIED_PIXMAP CSG
_________________________________________________________________________________________________________
XmNforeground XmCForeground Pixel dynamic CSG
_________________________________________________________________________________________________________
XmNhelpCallback XmCCallback XtCallbackList NULL C
_________________________________________________________________________________________________________
XmNhighlightColor XmCHighlightColor Pixel dynamic CSG
_________________________________________________________________________________________________________
XmNhighlightPixmap XmCHighlightPixmap Pixmap dynamic CSG
_________________________________________________________________________________________________________
XmNnavigationType XmCNavigationType XmNavigationType XmTAB_GROUP CSG
_________________________________________________________________________________________________________
XmNshadowThickness XmCShadowThickness Dimension 2 CSG
_________________________________________________________________________________________________________
XmNstringDirection XmCStringDirection XmStringDirection dynamic CG
_________________________________________________________________________________________________________
XmNtopShadowColor XmCBackgroundTopShadowColor Pixel dynamic CSG
_________________________________________________________________________________________________________
XmNtopShadowPixmap XmCTopShadowPixmap Pixmap dynamic CSG
_________________________________________________________________________________________________________
XmNtraversalOn XmCTraversalOn Boolean True CSG
_________________________________________________________________________________________________________
XmNunitType XmCUnitType unsigned char dynamic CSG
_________________________________________________________________________________________________________
Page 4 10/89
XmPanedWindow(3X) UNIX System V XmPanedWindow(3X)
|XmNuserData | XmCUserData | Pointer | NULL | CSG |
|_____________________|_____________________________|___________________|______________________|________|
________________________________________________________________________________________________________________
| Core Resource Set |
|_____________________________|_______________________________|________________|______________________|________|
|Name | Class | Type | Default | Access|
|_____________________________|_______________________________|________________|______________________|________|
|_____________________________|_______________________________|________________|______________________|________|
|XmNaccelerators | XmCAccelerators | XtAccelerators| dynamic | CSG |
|_____________________________|_______________________________|________________|______________________|________|
|XmNancestorSensitive | XmCSensitive | Boolean | dynamic | G |
|_____________________________|_______________________________|________________|______________________|________|
|XmNbackground | XmCBackground | Pixel | dynamic | CSG |
|_____________________________|_______________________________|________________|______________________|________|
|XmNbackgroundPixmap | XmCPixmap | Pixmap | XmUNSPECIFIED_PIXMAP| CSG |
|_____________________________|_______________________________|________________|______________________|________|
|XmNborderColor | XmCBorderColor | Pixel | XtDefaultForeground | CSG |
|_____________________________|_______________________________|________________|______________________|________|
|XmNborderPixmap | XmCPixmap | Pixmap | XmUNSPECIFIED_PIXMAP| CSG |
|_____________________________|_______________________________|________________|______________________|________|
|XmNborderWidth | XmCBorderWidth | Dimension | 0 | CSG |
|_____________________________|_______________________________|________________|______________________|________|
|XmNcolormap | XmCColormap | Colormap | dynamic | CG |
|_____________________________|_______________________________|________________|______________________|________|
|XmNdepth | XmCDepth | int | dynamic | CG |
|_____________________________|_______________________________|________________|______________________|________|
|XmNdestroyCallback | XmCCallback | XtCallbackList| NULL | C |
|_____________________________|_______________________________|________________|______________________|________|
|XmNheight | XmCHeight | Dimension | dynamic | CSG |
|_____________________________|_______________________________|________________|______________________|________|
|XmNinitialResourcesPersistent| XmCInitialResourcesPersistent| Boolean | True | C |
|_____________________________|_______________________________|________________|______________________|________|
|XmNmappedWhenManaged | XmCMappedWhenManaged | Boolean | True | CSG |
|_____________________________|_______________________________|________________|______________________|________|
|XmNscreen | XmCScreen | Screen * | dynamic | CG |
|_____________________________|_______________________________|________________|______________________|________|
|XmNsensitive | XmCSensitive | Boolean | True | CSG |
|_____________________________|_______________________________|________________|______________________|________|
|XmNtranslations | XmCTranslations | XtTranslations| dynamic | CSG |
|_____________________________|_______________________________|________________|______________________|________|
|XmNwidth | XmCWidth | Dimension | dynamic | CSG |
|_____________________________|_______________________________|________________|______________________|________|
|XmNx | XmCPosition | Position | 0 | CSG |
|_____________________________|_______________________________|________________|______________________|________|
|XmNy | XmCPosition | Position | 0 | CSG |
|_____________________________|_______________________________|________________|______________________|________|
10/89 Page 5
XmPanedWindow(3X) UNIX System V XmPanedWindow(3X)
_________________________________________________________________________________
| Composite Resource Set |
|_________________|___________________|____________|___________________|________|
|Name | Class | Type | Default | Access|
|_________________|___________________|____________|___________________|________|
|_________________|___________________|____________|___________________|________|
|XmNchildren | XmCReadOnly | WidgetList| NULL | G |
|_________________|___________________|____________|___________________|________|
|XmNinsertPosition| XmCInsertPosition| (*)() | default procedure| CSG |
|_________________|___________________|____________|___________________|________|
|XmNnumChildren | XmCReadOnly | Cardinal | 0 | G |
|_________________|___________________|____________|___________________|________|
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.
BSelect Press: SashAction(Start)
BSelect Motion:SashAction(Move)
BSelect Release:SashAction(Commit)
BDrag Press: SashAction(Start)
BDrag Motion: SashAction(Move)
BDrag Release: SashAction(Commit)
KUp: SashAction(Key,DefaultIncr,Up)
MCtrl KUp: SashAction(Key,LargeIncr,Up)
KDown: SashAction(Key,DefaultIncr,Down)
MCtrl KDown: SashAction(Key,LargeIncr,Down)
KNextField: NextTabGroup()
KPrevField: PrevTabGroup()
KHelp: Help()
Action Routines
The XmPanedWindow action routines are described below:
Help():
Calls the callbacks for XmNhelpCallback 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.
NextTabGroup():
Moves the keyboard focus to the next tab group. By default each
pane and sash is a tab group.
Page 6 10/89
XmPanedWindow(3X) UNIX System V XmPanedWindow(3X)
PrevTabGroup():
Moves the keyboard focus to the previous tab group. By default
each pane and sash is a tab group.
SashAction(action) or SashAction(Key,increment,direction):
The Start action activates the interactive placement of the pane's
borders. The Move 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
Commit action ends sash motion.
When sash action is caused by a keyboard event, the sash with the
keyboard focus is moved according to the increment and direction
specified. DefaultIncr adjusts the sash by one line. LargeIncr
adjusts the sash by one view region. The direction is specified as
either Up or Down.
Additional Behavior
This widget has the additional behavior described below:
<FocusIn>:
Moves the keyboard focus to the sash and highlights it.
<FocusOut>:
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 VirtualBindings(3X).
RELATED INFORMATION
Composite(3X), Constraint(3X), Core(3X), XmCreatePanedWindow(3X), and
XmManager(3X).
10/89 Page 7