Manual Page Result
0
Command: XmSeparatorGadget | Section: 3 | Source: Digital UNIX | File: XmSeparatorGadget.3X.gz
XmSeparatorGadget(3X) XmSeparatorGadget(3X)
NAME
XmSeparatorGadget - The SeparatorGadget widget class
SYNOPSIS
#include <Xm/SeparatoG.h>
DESCRIPTION
SeparatorGadget separates items in a display. Several line drawing
styles are provided, as well as horizontal or vertical orientation.
Lines drawn within the SeparatorGadget are automatically centered
within the height of the gadget for a horizontal orientation and cen-
tered within the width of the gadget for a vertical orientation. An
XtSetValues with a new XmNseparatorType resizes the widget to its mini-
mal height (for horizontal orientation) or its minimal width (for ver-
tical orientation) unless height or width is explicitly set in the
XtSetValues call.
SeparatorGadget does not draw shadows around the separator. The Gadget
resource XmNshadowThickness is used for the SeparatorGadget's thickness
when XmNseparatorType is XmSHADOW_ETCHED_IN, XmSHADOW_ETCHED_IN_DASH,
XmSHADOW_ETCHED_OUT, or XmSHADOW_ETCHED_OUT_DASH.
SeparatorGadget does not highlight and allows no traversing. The Gad-
get resource XmNtraversalOn is forced to False.
Classes
SeparatorGadget inherits behavior and resources from Object, RectObj,
and XmGadget Classes.
The class pointer is xmSeparatorGadgetClass.
The class name is XmSeparatorGadget.
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).
XmSeparatorGadget Resource Set
Class: XmCMargin Default: 0 Type: Dimension Access: CSG Class: XmCOri-
entation Default: XmHORIZONTAL Type: unsigned char Access: CSG Class:
XmCSeparatorType Default: XmSHADOW_ETCHED_IN Type: unsigned char Ac-
cess: CSG
For horizontal orientation, specifies the space on the left and
right sides between the border of SeparatorGadget and the line
drawn. For vertical orientation, specifies the space on the top
and bottom between the border of SeparatorGadget and the line
drawn. Specifies whether SeparatorGadget is displayed verti-
cally or horizontally. This resource can have values of XmVERTI-
CAL and XmHORIZONTAL. Specifies the type of line drawing to be
done in the Separator widget. XmSINGLE_LINE--single line. Xm-
DOUBLE_LINE--double line. XmSINGLE_DASHED_LINE--single-dashed
line. XmDOUBLE_DASHED_LINE--double-dashed line. XmNO_LINE--no
line. XmSHADOW_ETCHED_IN--a line whose shadows give the effect
of a line etched into the window. The thickness of the line is
equal to the value of XmNshadowThickness. For horizontal orien-
tation, the top shadow is drawn in XmNtopShadowColor and the
bottom shadow is drawn in XmNbottomShadowColor. For vertical
orientation, the left edge is drawn in XmNtopShadowColor and the
right edge is drawn in XmNbottomShadowColor.
XmSHADOW_ETCHED_OUT--a line whose shadows give the effect of an
etched line coming out of the window. The thickness of the line
is equal to the value of XmNshadowThickness. For horizontal
orientation, the top shadow is drawn in XmNbottomShadowColor and
the bottom shadow is drawn in XmNtopShadowColor. For vertical
orientation, the left edge is drawn in XmNbottomShadowColor and
the right edge is drawn in XmNtopShadowColor.
XmSHADOW_ETCHED_IN_DASH--identical to XmSHADOW_ETCHED_IN except
a series of lines creates a dashed line.
XmSHADOW_ETCHED_OUT_DASH--identical to XmSHADOW_ETCHED_OUT ex-
cept a series of lines creates a dashed line.
Inherited Resources
SeparatorGadget inherits behavior and resources from the following su-
perclasses. For a complete description of each resource, refer to the
man page for that superclass.
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: Xm-
CHighlightOnEnter Default: False Type: Boolean Access: CSG Class: Xm-
CHighlightThickness Default: 0 Type: Dimension Access: CSG Class: XmC-
NavigationType 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: False Type: Boolean Access: G Class: XmCUnit-
Type Default: dynamic Type: unsigned char Access: CSG Class: XmCUser-
Data Default: NULL Type: XtPointer Access: CSG
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 De-
fault: True Type: Boolean Access: CSG Class: XmCWidth Default: dynamic
Type: Dimension Access: CSG Class: XmCPosition Default: 0 Type: Posi-
tion Access: CSG Class: XmCPosition Default: 0 Type: Position Access:
CSG
Object Resource Set
Class: XmCCallback Default: NULL Type: XtCallbackList Access: C
Behavior
XmSeparatorGadget has no behavior.
SEE ALSO
Object(3X), RectObj(3X), XmCreateSeparatorGadget(3X), XmGadget(3X)
XmSeparatorGadget(3X)