XmManager(3X) OSF/Motif XmManager(3X)NAMEXmManager - The Manager widget class
SYNOPSIS
#include <Xm/Xm.h>
DESCRIPTION
Manager is a widget class used as a supporting superclass for other
widget classes. It supports the visual resources, graphics contexts,
and traversal resources necessary for the graphics and traversal mecha‐
nisms.
Classes
Manager inherits behavior and resources from Core, Composite, and Con‐
straint classes.
The class pointer is xmManagerWidgetClass.
The class name is XmManager.
New Resources
The following table defines a set of widget resources used by the pro‐
grammer to specify data. The programmer can also set the resource val‐
ues 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 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).
XmManager Resource Set
────────────────────────────────────────────────────────────────
Name Default Access
Class Type
────────────────────────────────────────────────────────────────
────────────────────────────────────────────────────────────────
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
────────────────────────────────────────────────────────────────
Specifies the color to use to draw the bottom and right sides of the
border shadow. This color is used if the XmNbottomShadowPixmap
resource is NULL. Specifies the pixmap to use to draw the bottom and
right sides of the border shadow. Specifies the foreground drawing
color used by manager widgets. Specifies the list of callbacks that
are called when the help key sequence is pressed. The reason sent by
this callback is XmCR_HELP. Specifies the color of the highlighting
rectangle. This color is used if the highlight pixmap resource is
XmUNSPECIFIED_PIXMAP. Specifies the pixmap used to draw the highlight‐
ing rectangle. Specifies the ID of a widget descendant of the manager.
The widget must meet these conditions: The widget must be either a tab
group or a non-tab-group widget that can receive keyboard focus. For
the definition of a tab group, see the description of the Manager,
Primitive, and Gadget XmNnavigationType resources. In general a widget
can receive keyboard focus when it is a primitive, a gadget, or a man‐
ager (such as a DrawingArea with no traversable children) that acts as
a primitive. The widget must not be a descendant of a tab group that
is itself a descendant of the manager. That is, the widget cannot be
contained within a tab group that is nested inside the manager. The
widget and its ancestors must have a value of True for their XmNtraver‐
salOn resources.
If the widget does not meet these conditions, XmNinitialFocus is
treated as if the value were NULL.
This resource is meaningful only when the nearest shell ancestor's
XmNkeyboardFocusPolicy is XmEXPLICIT. It is used to determine which
widget receives focus in these situations: When the manager is the
child of a shell and the shell hierarchy receives focus for the first
time When focus is inside the shell hierarchy, the manager is a compos‐
ite tab group, and the user traverses to the manager via the keyboard
Focus is then determined as follows: If XmNinitialFocus is a traversa‐
ble non-tab-group widget, that widget receives focus. If XmNinitialFo‐
cus is a traversable tab group, that tab group receives focus. If that
tab group is a composite with descendant tab groups or traversable non-
tab-group widgets, these procedures are used recursively to assign
focus to a descendant of that tab group. If XmNinitialFocus is NULL,
the first traversable non-tab-group widget that is not contained within
a nested tab group receives focus. If XmNinitialFocus is NULL and no
traversable non-tab-group widget exists, the first traversable tab
group that is not contained within a nested tab group receives focus.
If that tab group is a composite with descendant tab groups or travers‐
able non-tab-group widgets, these procedures are used recursively to
assign focus to a descendant of that tab group.
If a shell hierarchy regains focus after losing it, focus returns to
the widget that had the focus at the time it left the hierarchy.
The use of XmNinitialFocus is undefined if the manager is a MenuBar,
PulldownMenu, PopupMenu, or OptionMenu. Determines whether the widget
is a tab group. XmNONE indicates that the widget is not a tab group.
XmTAB_GROUP indicates that the widget is a tab group, unless another
widget in the hierarchy has an XmNnavigationType of XmEXCLU‐
SIVE_TAB_GROUP. XmSTICKY_TAB_GROUP indicates that the widget is a tab
group, even if another widget in the hierarchy has an XmNnavigationType
of XmEXCLUSIVE_TAB_GROUP. XmEXCLUSIVE_TAB_GROUP indicates that the
widget is a tab group and that widgets in the hierarchy whose XmNnavi‐
gationType is XmTAB_GROUP are not tab groups.
When a parent widget has an XmNnavigationType of XmEXCLUSIVE_TAB_GROUP,
traversal of non-tab-group widgets within the group is based on the
order of those widgets in their parent's XmNchildren list.
When any widget in a hierarchy has an XmNnavigationType of XmEXCLU‐
SIVE_TAB_GROUP, traversal of tab groups in the hierarchy proceeds to
widgets in the order in which their XmNnavigationType resources were
specified as XmEXCLUSIVE_TAB_GROUP or XmSTICKY_TAB_GROUP, whether by
creating the widgets with that value, by calling XtSetValues, or by
calling XmAddTabGroup. Specifies the thickness of the drawn border
shadow. XmBulletinBoard and its descendants set this value dynami‐
cally. If the widget is a top level window, this value is set to 1.
If it is not a top level window, this value is set to 0. Specifies the
initial direction to draw strings. The values are XmSTRING_DIREC‐
TION_L_TO_R and XmSTRING_DIRECTION_R_TO_L. The value of this resource
is determined at creation time. If the widget's parent is a manager,
this value is inherited from the widget's parent, otherwise it is set
to XmSTRING_DIRECTION_L_TO_R. Specifies the color to use to draw the
top and left sides of the border shadow. This color is used if the
XmNtopShadowPixmap resource is NULL. Specifies the pixmap to use to
draw the top and left sides of the border shadow. Specifies whether
traversal is activated for this widget. Provides the basic support for
resolution independence. It defines the type of units a widget uses
with sizing and positioning resources. If the widget's parent is a
subclass of XmManager and if the XmNunitType resource is not explicitly
set, it defaults to the unit type of the parent widget. If the wid‐
get's parent is not a subclass of XmManager, the resource has a default
unit type of XmPIXELS.
XmNunitType can have the following values: XmPIXELS—all values provided
to the widget are treated as normal pixel values. Xm100TH_MILLIMETERS—
all values provided to the widget are treated as 1/100 millimeter.
Xm1000TH_INCHES—all values provided to the widget are treated as 1/1000
inch. Xm100TH_POINTS—all values provided to the widget are treated as
1/100 point. A point is a unit used in text processing applications
and is defined as 1/72 inch. Xm100TH_FONT_UNITS—all values provided to
the widget are treated as 1/100 of a font unit. A font unit has hori‐
zontal and vertical components. These are the values of the XmScreen
resources XmNhorizontalFontUnit and XmNverticalFontUnit. Allows the
application to attach any necessary specific data to the widget. This
is an internally unused resource.
Dynamic Color Defaults
The foreground, background, top shadow, bottom shadow, and highlight
color resources are dynamically defaulted. If no color data is speci‐
fied, the colors are automatically generated. On a single-plane sys‐
tem, a black and white color scheme is generated. Otherwise, four col‐
ors are generated, which display the correct shading for the 3-D visu‐
als. If the background is the only color specified for a widget, the
top shadow and bottom shadow colors are generated to give the 3-D
appearance. Foreground and highlight colors are generated to provide
sufficient contrast with the background color.
Colors are generated only at creation. Resetting the background
through XtSetValues does not regenerate the other colors. XmChange‐
Color can be used to recalculate all associated colors based on a new
background color.
Inherited Resources
Manager inherits the following resources from the named superclasses.
For a complete description of each resource, refer to the man page for
that superclass.
Composite Resource Set
──────────────────────────────────────────────────────
Name Default Access
Class Type
──────────────────────────────────────────────────────
──────────────────────────────────────────────────────
XmNchildren NULL G
XmCReadOnly WidgetList
──────────────────────────────────────────────────────
XmNinsertPosition NULL CSG
XmCInsertPosition XtOrderProc
──────────────────────────────────────────────────────
XmNnumChildren 0 G
XmCReadOnly Cardinal
──────────────────────────────────────────────────────
Core Resource Set
─────────────────────────────────────────────────────────────────────
Name Default Access
Class Type
─────────────────────────────────────────────────────────────────────
─────────────────────────────────────────────────────────────────────
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
─────────────────────────────────────────────────────────────────────
Callback Information
A pointer to the following structure is passed to each callback: type‐
def struct { int reason; XEvent * event; } XmAny‐
CallbackStruct; Indicates why the callback was invoked. For this call‐
back, reason is set to XmCR_HELP. Points to the XEvent that triggered
the callback.
Translations
The following set of translations are used by Manager widgets that have
Gadget children. Since Gadgets cannot have translations associated
with them, it is the responsibility of the Manager widget to intercept
the events of interest and pass them to any Gadget child with focus.
These events are ignored if no Gadget child has the focus. These
translations may not directly correspond to a translation table. BAny
Motion: ManagerGadgetButtonMotion() BSelect Press: ManagerGadgetArm()
BSelect Click: ManagerGadgetActivate() BSelect Release:ManagerGad‐
getActivate() BSelect Press 2+:ManagerGadgetMultiArm() BSelect Release
2+:ManagerGadgetMultiActivate() BDrag Press: ManagerGadgetDrag()
KSelect: ManagerGadgetSelect() KActivate: ManagerParentActi‐
vate()
KCancel: ManagerParentCancel()
KPrevField: ManagerGadgetPrevTabGroup() KNextField: ManagerGad‐
getNextTabGroup()
KUp: ManagerGadgetTraverseUp() KDown: ManagerGadget‐
TraverseDown() KLeft: ManagerGadgetTraverseLeft()
KRight: ManagerGadgetTraverseRight()
KBeginLine: ManagerGadgetTraverseHome()
KHelp: ManagerGadgetHelp()
KAny: ManagerGadgetKeyInput()
Action Routines
The XmManager action routines are described below: Causes the current
gadget to be activated. Causes the current gadget to be armed. Causes
the current gadget to process a mouse motion event. Drags the contents
of a gadget label, identified by pressing BDrag. This action creates a
DragContext object whose XmNexportTargets resource is set to "COM‐
POUND_TEXT" for a label type of XmSTRING; otherwise, "PIXMAP" if the
label type is XmPIXMAP. This action is undefined for gadgets used in a
menu system. Calls the callbacks for the current gadget's XmNhelpCall‐
back 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. Causes the current gadget to process a keyboard event. Causes
the current gadget to process a multiple mouse click. Causes the cur‐
rent gadget to process a multiple mouse button press. Traverses to the
first item in the next tab group. If the current tab group is the last
entry in the tab group list, it wraps to the beginning of the tab group
list. Traverses to the first item in the previous tab group. If the
beginning of the tab group list is reached, it wraps to the end of the
tab group list. Causes the current gadget to be armed and activated.
Traverses to the next item below the current gadget in the current tab
group, wrapping if necessary. Traverses to the first widget or gadget
in the current tab group. Traverses to the next item to the left of
the current gadget in the current tab group, wrapping if necessary.
Traverses to the next item in the current tab group, wrapping if neces‐
sary. Traverses to the previous item in the current tab group, wrap‐
ping if necessary. Traverses to the next item to the right of the cur‐
rent gadget in the current tab group, wrapping if necessary. Traverses
to the next item above the current gadget in the current tab group,
wrapping if necessary. If the parent is a manager, passes the KActi‐
vate event received by the current widget/gadget to its parent. If the
parent is a manager, passes the KCancel event received by the current
widget/gadget to its parent.
Additional Behavior
This widget has the additional behavior described below: If the shell's
keyboard focus policy is XmEXPLICIT and the event occurs in a gadget,
causes the gadget to be highlighted and to take the focus. If the
shell's keyboard focus policy is XmEXPLICIT and the event occurs in a
gadget, causes the gadget to be unhighlighted and to lose the focus.
Virtual Bindings
The bindings for virtual keys are vendor specific. For information
about bindings for virtual buttons and keys, see VirtualBindings(3X).
RELATED INFORMATIONComposite(3X), Constraint(3X), Core(3X), XmChangeColor(3X), XmGad‐
get(3X), and XmScreen(3X).
XmManager(3X)
