XmPrimitive(3X)XmPrimitive(3X)NAMEXmPrimitive - 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 Prim‐
itive 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 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).
XmPrimitive Resource Set
Class: XmCBottomShadowColor
Default: dynamic
Type: Pixel
Access: CSG
Class: XmCBottomShadowPixmap
Default: XmUNSPECIFIED_PIXMAP
Type: Pixmap
Access: CSG
Class: XmCForeground
Default: dynamic
Type: Pixel
Access: CSG
Class: XmCCallback
Default: NULL
Type: XtCallbackList
Access: C
Class: XmCHighlightColor
Default: dynamic
Type: Pixel
Access: CSG
Class: XmCHighlightOnEnter
Default: False
Type: Boolean
Access: CSG
Class: XmCHighlightPixmap
Default: dynamic
Type: Pixmap
Access: CSG
Class: XmCHighlightThickness
Default: 2
Type: Dimension
Access: CSG
Class: XmCNavigationType
Default: XmNONE
Type: XmNavigationType
Access: CSG
Class: XmCShadowThickness
Default: 2
Type: Dimension
Access: CSG
Class: XmCTopShadowColor
Default: dynamic
Type: Pixel
Access: CSG
Class: XmCTopShadowPixmap
Default: dynamic
Type: Pixmap
Access: CSG
Class: XmCTraversalOn
Default: True
Type: Boolean
Access: CSG
Class: XmCUnitType
Default: dynamic
Type: unsigned char
Access: CSG
Class: XmCUserData
Default: NULL
Type: XtPointer
Access: CSG
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. Specifies the pixmap to use to draw
the bottom and right sides of the border shadow. Specifies the
foreground drawing color used by Primitive widgets. Specifies
the list of callbacks that is called when the help key is
pressed. The reason sent by the callback is XmCR_HELP. Speci‐
fies the color of the highlighting rectangle. This color is used
if the highlight pixmap resource is XmUNSPECIFIED_PIXMAP. Spec‐
ifies if the highlighting rectangle is drawn when the cursor
moves into the widget. If the shell's focus policy is XmEX‐
PLICIT, 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 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 cursor moves into
the widget. The default is False. Specifies the pixmap used to
draw the highlighting rectangle. Specifies the thickness of the
highlighting rectangle. 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
XmEXCLUSIVE_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. XmEXCLU‐
SIVE_TAB_GROUP indicates that the widget is a tab group and that
widgets in the hierarchy whose XmNnavigationType is XmTAB_GROUP
are not tab groups.
When a parent widget has an XmNnavigationType of XmEXCLU‐
SIVE_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 XmEX‐
CLUSIVE_TAB_GROUP, traversal of tab groups in the hierarchy pro‐
ceeds 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 size of the drawn border shadow. 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. Specifies the pixmap to use to draw the top and
left sides of the border shadow. Specifies if traversal is
activated for this widget. In CascadeButton and CascadeButton‐
Gadget, this resource is forced to TRUE unless the parent is an
OptionMenu. Provides the basic support for resolution indepen‐
dence. 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 pro‐
vided 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 applica‐
tions and is defined as 1/72 inch. Xm100TH_FONT_UNITS--all val‐
ues provided to the widget are treated as 1/100 of a font unit.
A font unit has horizontal and vertical components. These are
the values of the XmScreen resources XmNhorizontalFontUnit and
XmNverticalFontUnit. Allows the application to attach any nec‐
essary specific data to the widget. It 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. XmChangeColor
can be used to recalculate all associated colors based on a new back‐
ground color.
Inherited Resources
Primitive inherits behavior and resources from the following super‐
class. For a complete description of each resource, refer to the man
page for that superclass.
Core Resource Set
Class: XmCAccelerators
Default: dynamic
Type: XtAccelerators
Access: CSG
Class: XmCSensitive
Default: dynamic
Type: Boolean
Access: G
Class: XmCBackground
Default: dynamic
Type: Pixel
Access: CSG
Class: XmCPixmap
Default: XmUNSPECIFIED_PIXMAP
Type: Pixmap
Access: CSG
Class: XmCBorderColor
Default: XtDefaultForeground
Type: Pixel
Access: CSG
Class: XmCPixmap
Default: XmUNSPECIFIED_PIXMAP
Type: Pixmap
Access: CSG
Class: XmCBorderWidth
Default: 0
Type: Dimension
Access: CSG
Class: XmCColormap
Default: dynamic
Type: Colormap
Access: CG
Class: XmCDepth
Default: dynamic
Type: int
Access: CG
Class: XmCCallback
Default: NULL
Type: XtCallbackList
Access: C
Class: XmCHeight
Default: dynamic
Type: Dimension
Access: CSG
Class: XmCInitialResourcesPersistent
Default: True
Type: Boolean
Access: C
Class: XmCMappedWhenManaged
Default: True
Type: Boolean
Access: CSG
Class: XmCScreen
Default: dynamic
Type: Screen *
Access: CG
Class: XmCSensitive
Default: True
Type: Boolean
Access: CSG
Class: XmCTranslations
Default: dynamic
Type: XtTranslations
Access: CSG
Class: XmCWidth
Default: dynamic
Type: Dimension
Access: CSG
Class: XmCPosition
Default: 0
Type: Position
Access: CSG
Class: XmCPosition
Default: 0
Type: Position
Access: CSG
Callback Information
A pointer to the following structure is passed to each callback:
typedef struct {
int reason;
XEvent * event; } XmAnyCallbackStruct;
Indicates why the callback was invoked. For this callback, reason is
set to XmCR_HELP. Points to the XEvent that triggered the callback.
Translations
The XmPrimitive translations are listed below. These translations may
not directly correspond to a translation table.
Note that for buttons in menus, altering translations in #override or
#augment mode is undefined. KUp: PrimitiveTraverseUp()
KDown: PrimitiveTraverseDown() KLeft: PrimitiveTra‐
verseLeft() KRight: PrimitiveTraverseRight() KBeginLine:
PrimitiveTraverseHome() KNextField: PrimitiveNextTabGroup() KPre‐
vField: PrimitivePrevTabGroup() KActivate: PrimitiveParentAc‐
tivate() KCancel: PrimitiveParentCancel() KHelp: Primi‐
tiveHelp()
Action Routines
The XmPrimitive action routines are described below: Calls the call‐
backs 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. 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. If the parent
is a manager, passes the KActivate event received by the widget to the
parent. If the parent is a manager, Passes the KCancel event received
by the widget to the parent. Traverses to the first item in the previ‐
ous tab group. If the beginning of the tab group list is reached, it
wraps to the end of the tab group list. Traverses to the next item
below the current widget in the current tab group, wrapping if neces‐
sary. Traverses to the first widget or gadget in the current tab
group. Traverses to the next item to the left of the current widget in
the current tab group, wrapping if necessary. Traverses to the next
item in the current tab group, wrapping if necessary. Traverses to the
previous item in the current tab group, wrapping if necessary. Tra‐
verses to the next item to the right of the current gadget in the cur‐
rent tab group, wrapping if necessary. Traverses to the next item
above the current gadget in the current tab group, wrapping if neces‐
sary.
Additional Behavior
This widget has the additional behavior described below: If the shell's
keyboard focus policy is XmEXPLICIT, highlights the widget and gives it
the focus. If the shell's keyboard focus policy is XmEXPLICIT, unhigh‐
lights 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).
SEE ALSOCore(3X), XmChangeColor(3X), XmScreen(3X)XmPrimitive(3X)