XmSeparatorGadget(Xm) UNIX System V
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 centered within the width of the gadget for
a vertical orientation. An XtSetValues with a new
XmNseparatorType will resize the widget to its minimal
height (for horizontal orientation) or its minimal width
(for vertical orientation) unless height or width is
explicitly set in the XtSetValues call.
SeparatorGadget does not draw shadows. The Gadget resource
XmNshadowThickness is used for the SeparatorGadget's
thickness when XmNshadowType is XmSHADOWETCHEDIN or
XmSHADOWETCHEDOUT.
SeparatorGadget does not highlight and allows no traversing.
The Gadget 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 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 lower
case or upper case, 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
Name Class Type Default Access
_________________________________________________________________________________
XmNmargin XmCMargin short 0 CSG
XmNorientation XmCOrientation unsigned char XmHORIZONTAL CSG
XmNseparatorType XmCSeparatorType unsigned char XmSHADOW_ETCHED_IN CSG
XmNmargin
Specifies the space on the left and right sides between
the border of SeparatorGadget and the line drawn for
horizontal orientation. For vertical orientation,
specifies the space on the top and bottom between the
border of SeparatorGadget and the line drawn.
XmNorientation
Specifies whether SeparatorGadget is displayed
vertically or horizontally. This resource can have
values of XmVERTICAL and XmHORIZONTAL.
XmNseparatorType
Specifies the type of line drawing to be done in the
Separator widget.
⊕ XmSINGLELINE - single line.
⊕ XmDOUBLELINE - double line.
⊕ XmSINGLEDASHEDLINE - single-dashed line.
⊕ XmDOUBLEDASHEDLINE - double-dashed line.
⊕ XmNOLINE - no line.
⊕ XmSHADOWETCHEDIN - double line giving the effect of a
line etched into the window. The thickness of the double
line is equal to the value of XmNshadowThickness. For
horizontal orientation, the top line is drawn in
XmNtopShadowColor and the bottom line is drawn in
XmNbottomShadowColor. For vertical orientation, the left
line is drawn in XmNtopShadowColor and the right line is
drawn in XmNbottomShadowColor.
⊕ XmSHADOWETCHEDOUT - double line giving the effect of an
etched line coming out from the window. The thickness of
the double line is equal to the value of
XmNshadowThickness. For horizontal orientation, the top
line is drawn in XmNbottomShadowColor and the bottom line
is drawn in XmNtopShadowColor. For vertical orientation,
the left line is drawn in XmNbottomShadowColor and the
right line is drawn in XmNtopShadowColor.
Inherited Resources
SeparatorGadget inherits behavior and resources from the
following superclasses. For a complete description of these
resources, refer to the man page for that superclass.
XmGadget Resource Set
Name Class Type Default Access
__________________________________________________________________________________
XmNhelpCallback XmCCallback XtCallbackList NULL C
XmNhighlightOnEnter XmCHighlightOnEnter Boolean False CSG
XmNhighlightThickness XmCHighlightThickness short 0 CSG
XmNshadowThickness XmCShadowThickness short 2 CSG
XmNtraversalOn XmCTraversalOn Boolean False CSG
XmNunitType XmCUnitType unsigned char XmPIXELS CSG
XmNuserData XmCUserData caddr_t NULL CSG
RectObj Resource Set
Name Class Type Default Access
_____________________________________________________________________________
XmNancestorSensitive XmCSensitive Boolean XtCopyFromParent CSG
XmNborderWidth XmCBorderWidth Dimension 1 CSG
XmNheight XmCHeight Dimension 0 CSG
XmNsensitive XmCSensitive Boolean True CSG
XmNwidth XmCWidth Dimension 0 CSG
XmNx XmCPosition Position 0 CSG
XmNy XmCPosition Position 0 CSG
Object Resource Set
Name Class Type Default Access
____________________________________________________________________
XmNdestroyCallback XmCCallback XtCallbackList NULL C
Keyboard Traversal
For information on keyboard traversal, see the man page for
XmGadget(Xm) and its sections on behavior and default
translations.
RELATED INFORMATION
Object(Xm), RectObject(Xm), XmCreateSeparatorGadget(Xm), and
XmGadget(Xm).
(printed 2/14/90) XmSeparatorGadget(Xm)