OSF

NAME

XmManager — 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 mechanisms. 

Classes

Manager inherits behavior and resources from Core, Composite, and Constraint 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 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 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	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	0	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
XmNuserData	XmCUserData	Pointer	NULL	CSG

XmNbottomShadowColor
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. 

XmNbottomShadowPixmap
Specifies the pixmap to use to draw the bottom and right sides of the border shadow.

XmNforeground
Specifies the foreground drawing color used by manager widgets.

XmNhelpCallback
Specifies the list of callbacks that are called when the help key sequence is pressed.  The reason sent by this callback is XmCR_HELP.  No translation is bound to this resource.  It is up to the application to install a translation for help. 

XmNhighlightColor
Specifies the color of the highlighting rectangle. This color is used if the highlight pixmap resource is XmUNSPECIFIED_PIXMAP. 

XmNhighlightPixmap
Specifies the pixmap used to draw the highlighting rectangle.

XmNnavigationType
Controls whether the Widget is a navigation group.

•XmNONE indicates that the Widget is not a navigation group. 

•XmTAB_GROUP indicates that the Widget is included automatically in keyboard navigation, unless XmAddTabGroup has been called. 

•XmSTICKY_TAB_GROUP indicates that the Widget is included automatically in keyboard navigation, even if XmAddTabGroup has been called. 

•XmEXCLUSIVE_TAB_GROUP indicates that the Widget is included explicitly in keyboard navigation by the application.  With XmEXCLUSIVE_TAB_GROUP, traversal of widgets within the group is based on the order of children. 

XmNshadowThickness
Specifies the thickness of the drawn border shadow. XmBulletinBoard and its descendants set this value dynamically.  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. 

XmNstringDirection
Specifies the initial direction to draw strings.  The values are XmSTRING_DIRECTION_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. 

XmNtopShadowColor
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. 

XmNtopShadowPixmap
Specifies the pixmap to use to draw the top and left sides of the border shadow.

XmNtraversalOn
Specifies traversal activation for this manager.

XmNunitType
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 widget’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.  The value to be used for the font unit is determined in one of three ways:

•The application can use XmSetFontUnits to specify the font unit values. 

•If the application has not called XmSetFontUnits, the font units can be derived from a font.  The user specifies this font by using the font resource in a defaults file or on the command line, or by using the standard command line options −fn and −font. 

•If the application has not called XmSetFontUnits and the user has not specified a font resource, the horizontal and vertical font units default to 10. 

A horizontal font unit is derived from a font as follows:

•If the font has an AVERAGE_WIDTH property, the horizontal font unit is the AVERAGE_WIDTH property divided by 10. 

•If the font has no AVERAGE_WIDTH property but has a QUAD_WIDTH property, the horizontal font unit is the QUAD_WIDTH property. 

•If the font has no AVERAGE_WIDTH or QUAD_WIDTH property, the horizontal font unit is the sum of the font struct’s min_bounds.width and max_bounds.width divided by 2.3. 

A vertical font unit is derived from a font as follows:

•If the font has a PIXEL_SIZE property, the vertical font unit is the PIXEL_SIZE property divided by 1.8. 

•If the font has no PIXEL_SIZE property but has POINT_SIZE and RESOLUTION_Y properties, the vertical font unit is the product of the POINT_SIZE and RESOLUTION_Y properties divided by 1400. 

•If the font has no PIXEL_SIZE, POINT_SIZE, or RESOLUTION_Y properties, the vertical font unit is the sum of the font struct’s max_bounds.ascent and max_bounds.descent divided by 2.2. 

XmNuserData
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, and bottom shadow resources are dynamically defaulted.  If no color data is specified, the colors are automatically generated.  On a single-plane system, a black and white color scheme is generated.  Otherwise, four colors are generated, which display the correct shading for the 3-D visuals.  If the background is the only color specified for a widget, the top shadow, bottom shadow, and foreground colors are generated to give the 3-D appearance. 

Colors are generated only at creation.  Resetting the background through XtSetValues does not regenerate the other colors. 

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	Class	Type	Default	Access
XmNchildren	XmCReadOnly	WidgetList	NULL	G
XmNinsertPosition	XmCInsertPosition	(∗)()	NULL	CSG
XmNnumChildren	XmCReadOnly	Cardinal	0	G

Core Resource Set
Name	Class	Type	Default	Access
XmNaccelerators	XmCAccelerators	XtAccelerators	NULL	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	CG
XmNmappedWhenManaged	XmCMappedWhenManaged	Boolean	True	CSG
XmNscreen	XmCScreen	Screen ∗	dynamic	CG
XmNsensitive	XmCSensitive	Boolean	True	CSG
XmNtranslations	XmCTranslations	XtTranslations	NULL	CSG
XmNwidth	XmCWidth	Dimension	dynamic	CSG
XmNx	XmCPosition	Position	0	CSG
XmNy	XmCPosition	Position	0	CSG

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:ManagerGadgetActivate()
BSelect Press 2+: ManagerGadgetMultiArm()
BSelect Release 2+: ManagerGadgetMultiActivate()
KSelect:ManagerGadgetSelect()
KActivate:ManagerGadgetSelect()
KPrevField:ManagerGadgetPrevTabGroup()
KNextField:ManagerGadgetNextTabGroup()
KUp:ManagerGadgetTraverseUp()
KDown:ManagerGadgetTraverseDown()
KLeft:ManagerGadgetTraverseLeft()
KRight:ManagerGadgetTraverseRight()
KBeginLine:ManagerGadgetTraverseHome()
KHelp:ManagerGadgetHelp()
KAny:ManagerGadgetKeyInput()

Action Routines

The XmManager action routines are described below:

ManagerGadgetActivate():
Causes the current gadget to be activated.

ManagerGadgetArm():
Causes the current gadget to be armed.

ManagerGadgetButtonMotion():
Causes the current gadget to process a mouse motion event.

ManagerGadgetHelp():
Calls the callbacks for the current gadget’s 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. 

ManagerGadgetKeyInput():
Causes the current gadget to process a keyboard event.

ManagerGadgetMultiActivate():
Causes the current gadget to process a multiple mouse click.

ManagerGadgetMultiArm():
Causes the current gadget to process a multiple mouse button press.

ManagerGadgetNextTabGroup():
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.

ManagerGadgetPrevTabGroup():
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.

ManagerGadgetSelect():
Causes the current gadget to be armed and activated.

ManagerGadgetTraverseDown():
Traverses to the next item below the current gadget in the current tab group, wrapping if necessary.

ManagerGadgetTraverseHome():
Traverses to the first widget or gadget in the current tab group.

ManagerGadgetTraverseLeft():
Traverses to the next item to the left of the current gadget in the current tab group, wrapping if necessary.

ManagerGadgetTraverseNext():
Traverses to the next item in the current tab group, wrapping if necessary.

ManagerGadgetTraversePrev():
Traverses to the previous item in the current tab group, wrapping if necessary.

ManagerGadgetTraverseRight():
Traverses to the next item to the right of the current gadget in the current tab group, wrapping if necessary.

ManagerGadgetTraverseUp():
Traverses to the next item above the current gadget in the current tab group, wrapping if necessary.

Additional Behavior

This widget has the additional behavior described below:

<FocusIn>:
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. 

<FocusOut>:
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 INFORMATION

Composite(3X), Constraint(3X), Core(3X), and XmGadget3X).