Content-type: text/html
Man page of XmGadget
XmGadget
Section: (3X)
Updated:
Index
Return to Main Contents
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
Class: XmCBottomShadowColor
Default: dynamic
Type: Pixel
Access: G
Class: XmCCallback
Default: NULL
Type: XtCallbackList
Access: C
Class: XmCHighlightColor
Default: dynamic
Type: Pixel
Access: G
Class: XmCHighlightOnEnter
Default: False
Type: Boolean
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: G
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
-
Contains the color to use to draw the bottom and right sides
of the border shadow.
Specifies the list of callbacks that is called when the help
key sequence is pressed. The reason sent by the callback is XmCR_HELP.
Contains the color of the highlighting rectangle.
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 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 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.
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.
Specifies the size of the drawn border shadow.
Contains the color to use to draw the top and left sides of
the border shadow.
Specifies traversal activation for this gadget.
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. 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 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
Class: XmCSensitive
Default: dynamic
Type: Boolean
Access: G
Class: XmCBorderWidth
Default: 0
Type: Dimension
Access: CSG
Class: XmCHeight
Default: dynamic
Type: Dimension
Access: CSG
Class: XmCSensitive
Default: True
Type: Boolean
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
-
Object Resource Set
Class: XmCCallback
Default: NULL
Type: XtCallbackList
Access: C
-
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.
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.
SEE ALSO
Object(3X),
RectObj(3X),
XmManager(3X),
XmScreen(3X)
Index
- NAME
-
- SYNOPSIS
-
- DESCRIPTION
-
- Classes
-
- New Resources
-
- Inherited Resources
-
- Callback Information
-
- Behavior
-
- SEE ALSO
-
This document was created by
man2html,
using the manual pages.
Time: 02:41:18 GMT, October 02, 2010