NAME

XmGadget—The Gadget widget class

SYNOPSIS

#include <Xm/Xm.h>

DESCRIPTION

Gadget is a widget class used as a supporting superclass for other gadget classes.  It handles shadow-border drawing and highlighting, traversal activation and deactivation, and various callback lists needed by gadgets. 

The color and pixmap resources defined by XmManager are directly used by gadgets.  If XtSetValues is used to change one of the resources for a manager widget, all of the gadget children within the manager also change. 

Classes

Gadget inherits behavior and resources from Object and RectObj classes. 

The class pointer is xmGadgetClass. 

The class name is XmGadget. 

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

XmGadget Resource Set
NameClassTypeDefaultAccess

XmNbottomShadowColorXmCBottomShadowColorPixeldynamicG
XmNhelpCallbackXmCCallbackXtCallbackListNULLC
XmNhighlightColorXmCHighlightColorPixeldynamicG
XmNhighlightOnEnterXmCHighlightOnEnterBooleanFalseCSG
XmNhighlightThicknessXmCHighlightThicknessDimension2CSG
XmNnavigationTypeXmCNavigationTypeXmNavigationTypeXmNONECSG
XmNshadowThicknessXmCShadowThicknessDimension2CSG
XmNtopShadowColorXmCTopShadowColorPixeldynamicG
XmNtraversalOnXmCTraversalOnBooleanTrueCSG
XmNunitTypeXmCUnitTypeunsigned chardynamicCSG
XmNuserDataXmCUserDataXtPointerNULLCSG

XmNbottomShadowColorContains the color to use to draw the bottom and right sides of the
border shadow.

XmNhelpCallbackSpecifies the list of callbacks that is called when the help key sequence
is pressed.  The reason sent by the callback is XmCR_HELP.

XmNhighlightColorContains the color of the highlighting rectangle.

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

XmNhighlightThicknessSpecifies the thickness of the highlighting rectangle.

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

       •XmEXCLUSIVE_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
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
XmEXCLUSIVE_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.

XmNshadowThicknessSpecifies the size of the drawn border shadow.

XmNtopShadowColorContains the color to use to draw the top and left sides of the border
shadow.

XmNtraversalOnSpecifies traversal activation for this gadget.

XmNunitTypeProvides 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.
A font unit has horizontal and vertical components.
These are the values of the XmScreen resources XmNhorizontalFontUnit
and XmNverticalFontUnit.

XmNuserDataAllows the application to attach any necessary specific data to the gadget.
This is an internally unused resource.

Inherited Resources

Gadget inherits the following resources from the named superclass.  For a complete description of each resource, refer to the man page for that superclass. 

RectObj Resource Set
NameClassTypeDefaultAccess

XmNancestorSensitiveXmCSensitiveBooleandynamicG
XmNborderWidthXmCBorderWidthDimension0CSG
XmNheightXmCHeightDimensiondynamicCSG
XmNsensitiveXmCSensitiveBooleanTrueCSG
XmNwidthXmCWidthDimensiondynamicCSG
XmNxXmCPositionPosition0CSG
XmNyXmCPositionPosition0CSG

Object Resource Set
NameClassTypeDefaultAccess

XmNdestroyCallbackXmCCallbackXtCallbackListNULLC

Callback Information

A pointer to the following structure is passed to each callback:

typedef struct
{
intreason;
XEvent∗ event;
} XmAnyCallbackStruct;

reasonIndicates why the callback was invoked.  For this callback, reason is set to XmCR_HELP. 

eventPoints to the XEvent that triggered the callback. 

Behavior

Gadgets cannot have translations associated with them.  Because of this, a Gadget’s behavior is determined by the Manager widget into which the Gadget is placed.  If focus is on a Gadget, events are passed to the Gadget by its Manager. 

RELATED INFORMATION

Object(3X), RectObj(3X), XmManager(3X), and XmScreen(3X). 

SunOS   —  Last change: