XmSeparator(Xm) UNIX System V
NAME
XmSeparator - the Separator widget class.
SYNOPSIS
#include <Xm/Separator.h>
DESCRIPTION
Separator is a primitive widget which separates items in a
display. Several different line drawing styles are
provided, as well as horizontal or vertical orientation.
The Separator line drawing is automatically centered within
the height of the widget for a horizontal orientation and
centered within the width of the widget 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.
Separator does not draw shadows. The Primitive resource
XmNshadowThickness is used for the Separator's thickness
when XmNshadowType is XmSHADOWETCHEDIN or
XmSHADOWETCHEDOUT.
Separator does not highlight and allows no traversing. The
primitive resource XmNtraversalOn is forced to False.
The XmNseparatorType of XmNOLINE provides an escape to the
application programmer who needs a different style of
drawing. A pixmap the height of the widget can be created
and used as the background pixmap by building an argument
list using the XmNbackgroundPixmap argument type as defined
by Core. Whenever the widget is redrawn, its background
will be displayed containing the desired separator drawing.
Classes
Separator inherits behavior and resources from Core and
XmPrimitive Classes.
The class pointer is xmSeparatorWidgetClass.
The class name is XmSeparator.
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).
XmSeparator 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 the Separator and the line drawn for
horizontal orientation. For vertical orientation,
specifies the space on the top and bottom between the
border of the Separator and the line drawn.
XmNorientation
Displays Separator 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
Separator inherits behavior and resources from the following
superclasses. For a complete description of these
resources, refer to the man page for that superclass.
XmPrimitive Resource Set
Name Class Type Default Access
______________________________________________________________________________________
XmNbottomShadowColor XmCForeground Pixel dynamic CSG
XmNbottomShadowPixmap XmCBottomShadowPixmap Pixmap XmUNSPECIFIED_PIXMAP CSG
XmNforeground XmCForeground Pixel dynamic CSG
XmNhelpCallback XmCCallback XtCallbackList NULL C
XmNhighlightColor XmCForeground Pixel Black CSG
XmNhighlightOnEnter XmCHighlightOnEnter Boolean False CSG
XmNhighlightPixmap XmCHighlightPixmap Pixmap dynamic CSG
XmNhighlightThickness XmCHighlightThickness short 0 CSG
XmNshadowThickness XmCShadowThickness short 2 CSG
XmNtopShadowColor XmCBackground Pixel dynamic CSG
XmNtopShadowPixmap XmCTopShadowPixmap Pixmap XmUNSPECIFIED_PIXMAP CSG
XmNtraversalOn XmCTraversalOn Boolean False CSG
XmNunitType XmCUnitType unsigned char XmPIXELS CSG
XmNuserData XmCUserData caddr_t NULL CSG
Core Resource Set
Name Class Type Default Access
____________________________________________________________________________________
XmNaccelerators XmCAccelerators XtTranslations NULL CSG
XmNancestorSensitive XmCSensitive Boolean True G
XmNbackground XmCBackground Pixel dynamic CSG
XmNbackgroundPixmap XmCPixmap Pixmap XmUNSPECIFIED_PIXMAP CSG
XmNborderColor XmCBorderColor Pixel Black CSG
XmNborderPixmap XmCPixmap Pixmap XmUNSPECIFIED_PIXMAP CSG
XmNborderWidth XmCBorderWidth Dimension 0 CSG
XmNcolormap XmCColormap Colormap XtCopyFromParent CG
XmNdepth XmCDepth int XtCopyFromParent CG
XmNdestroyCallback XmCCallback XtCallbackList NULL C
XmNheight XmCHeight Dimension 0 CSG
XmNmappedWhenManaged XmCMappedWhenManaged Boolean True CSG
XmNscreen XmCScreen Pointer XtCopyScreen CG
XmNsensitive XmCSensitive Boolean True CSG
XmNtranslations XmCTranslations XtTranslations NULL CSG
XmNwidth XmCWidth Dimension 0 CSG
XmNx XmCPosition Position 0 CSG
XmNy XmCPosition Position 0 CSG
Keyboard Traversal
For information on keyboard traversal, see the man page for
XmPrimitive(Xm) and its sections on behavior and default
translations.
RELATED INFORMATION
Core(Xm), XmCreateSeparator(Xm), and XmPrimitive(Xm).
(printed 2/14/90) XmSeparator(Xm)