XmPrimitive(3X) UNIX System V XmPrimitive(3X)
NAME
XmPrimitive - the Primitive widget class.
SYNOPSIS
#include <Xm/Xm.h>
DESCRIPTION
Primitive is a widget class used as a supporting superclass for other
widget classes. It handles border drawing and highlighting, traversal
activation and deactivation, and various callback lists needed by
Primitive widgets.
Classes
Primitive inherits behavior and resources from Core class.
The class pointer is xmPrimitiveWidgetClass.
The class name is XmPrimitive.
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).
10/89 Page 1
XmPrimitive(3X) UNIX System V XmPrimitive(3X)
__________________________________________________________________________________________________
| XmPrimitive 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 |
|_____________________|_______________________|__________________|______________________|________|
|XmNhighlightOnEnter | XmCHighlightOnEnter | Boolean | False | CSG |
|_____________________|_______________________|__________________|______________________|________|
|XmNhighlightPixmap | XmCHighlightPixmap | Pixmap | dynamic | CSG |
|_____________________|_______________________|__________________|______________________|________|
|XmNhighlightThickness| XmCHighlightThickness| Dimension | 2 | CSG |
|_____________________|_______________________|__________________|______________________|________|
|XmNnavigationType | XmCNavigationType | XmNavigationType| XmNONE | G |
|_____________________|_______________________|__________________|______________________|________|
|XmNshadowThickness | XmCShadowThickness | Dimension | 2 | CSG |
|_____________________|_______________________|__________________|______________________|________|
|XmNtopShadowColor | XmCTopShadowColor | 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 XmNtopShadowPixmap
resource is unspecified.
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 Primitive widgets.
Page 2 10/89
XmPrimitive(3X) UNIX System V XmPrimitive(3X)
XmNhelpCallback
Specifies the list of callbacks that is called when the help key is
pressed. The reason sent by the callback is XmCR_HELP.
XmNhighlightColor
Specifies the color of the highlighting rectangle. This color is
used if the highlight pixmap resource is XmUNSPECIFIED_PIXMAP.
XmNhighlightOnEnter
Specifies if the highlighting rectangle is drawn when the cursor
moves into the widget. If the shell's focus policy is XmEXPLICIT,
this resource is ignored, and the widget is highlighted when it has
the focus. If the shell's focus policy is XmPOINTER and if this
resource is True, the highlighting rectangle is drawn when the the
cursor moves into the widget. If the shell's focus policy is
XmPOINTER and if this resource is False, the highlighting rectangle
is not drawn when the the cursor moves into the widget. The
default is False.
XmNhighlightPixmap
Specifies the pixmap used to draw the highlighting rectangle.
XmNhighlightThickness
Specifies the thickness of 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.
If the widget's parent is a shell, the default is XmTAB_GROUP;
otherwise, the default is XmNONE.
XmNshadowThickness
Specifies the size of the drawn border shadow.
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 unspecified.
10/89 Page 3
XmPrimitive(3X) UNIX System V XmPrimitive(3X)
XmNtopShadowPixmap
Specifies the pixmap to use to draw the top and left sides of the
border shadow.
XmNtraversalOn
Specifies if traversal is activated for this widget.
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:
Page 4 10/89
XmPrimitive(3X) UNIX System V XmPrimitive(3X)
⊕ 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. It 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
Primitive inherits behavior and resources from the following superclass.
For a complete description of each resource, refer to the man page for
that superclass.
10/89 Page 5
XmPrimitive(3X) UNIX System V XmPrimitive(3X)
________________________________________________________________________________________________________________
| 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 |
|_____________________________|_______________________________|________________|______________________|________|
Translations
The XmPrimitive translations are listed below. These translations may
not directly correspond to a translation table.
Page 6 10/89
XmPrimitive(3X) UNIX System V XmPrimitive(3X)
Note that for buttons in menus, altering translations in #override or
#augment mode is undefined.
KUp: PrimitiveTraverseUp()
KDown: PrimitiveTraverseDown()
KLeft: PrimitiveTraverseLeft()
KRight: PrimitiveTraverseRight()
KBeginLine: PrimitiveTraverseHome()
KNextField: PrimitiveNextTabGroup()
KPrevField: PrimitivePrevTabGroup()
KHelp: PrimitiveHelp()
Action Routines
The XmPrimitive action routines are described below:
PrimitiveHelp():
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.
PrimitiveNextTabGroup():
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.
PrimitivePrevTabGroup():
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.
PrimitiveTraverseDown():
Traverses to the next item below the current widget in the current
tab group, wrapping if necessary.
PrimitiveTraverseHome():
Traverses to the first widget or gadget in the current tab group.
PrimitiveTraverseLeft():
Traverses to the next item to the left of the current widget in the
current tab group, wrapping if necessary.
PrimitiveTraverseNext():
Traverses to the next item in the current tab group, wrapping if
necessary.
10/89 Page 7
XmPrimitive(3X) UNIX System V XmPrimitive(3X)
PrimitiveTraversePrev():
Traverses to the previous item in the current tab group, wrapping
if necessary.
PrimitiveTraverseRight():
Traverses to the next item to the right of the current gadget in
the current tab group, wrapping if necessary.
PrimitiveTraverseUp():
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, highlights the
widget and gives it the focus.
<FocusOut>:
If the shell's keyboard focus policy is XmEXPLICIT, unhighlights
the widget and removes 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
Core(3X).
Page 8 10/89