XmSeparator(3X) XmSeparator(3X)
NAME
XmSeparator - The Separator widget class
SYNOPSIS
#include <Xm/Separator.h>
DESCRIPTION
Separator is a primitive widget that separates items in a display. Several different line drawing styles are provided, as well as horizon-
tal 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 resizes 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 around the separator. The Primitive resource XmNshadowThickness is used for the Separator's thickness when
XmNseparatorType is XmSHADOW_ETCHED_IN, XmSHADOW_ETCHED_IN_DASH, XmSHADOW_ETCHED_OUT, or XmSHADOW_ETCHED_OUT_DASH.
Separator does not highlight and allows no traversing. The primitive resource XmNtraversalOn is forced to False.
The XmNseparatorType of XmNO_LINE 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 is 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 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).
XmSeparator Resource Set
Class: XmCMargin Default: 0 Type: Dimension Access: CSG Class: XmCOrientation Default: XmHORIZONTAL Type: unsigned char Access: CSG
Class: XmCSeparatorType Default: XmSHADOW_ETCHED_IN Type: unsigned char Access: CSG
For horizontal orientation, specifies the space on the left and right sides between the border of the Separator and the line drawn.
For vertical orientation, specifies the space on the top and bottom between the border of the Separator and the line drawn. Dis-
plays Separator vertically or horizontally. This resource can have values of XmVERTICAL and XmHORIZONTAL. Specifies the type of
line drawing to be done in the Separator widget. XmSINGLE_LINE--single line. XmDOUBLE_LINE--double line. XmSIN-
GLE_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 XmNshadowThick-
ness. For horizontal orientation, the top shadow is drawn in XmNtopShadowColor and the bottom shadow is drawn in XmNbottomShadow-
Color. 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 bot-
tom 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 except a series of lines creates a dashed line.
Inherited Resources
Separator inherits behavior and resources from the following superclasses. For a complete description of each resource, refer to the man
page for that superclass.
XmPrimitive Resource Set
Class: XmCBottomShadowColor Default: dynamic Type: Pixel Access: CSG Class: XmCBottomShadowPixmap Default: XmUNSPECIFIED_PIXMAP Type:
Pixmap Access: CSG Class: XmCForeground Default: dynamic Type: Pixel Access: CSG Class: XmCCallback Default: NULL Type: XtCallbackList
Access: C Class: XmCHighlightColor Default: dynamic Type: Pixel Access: CSG Class: XmCHighlightOnEnter Default: False Type: Boolean
Access: CSG Class: XmCHighlightPixmap Default: dynamic Type: Pixmap Access: CSG Class: XmCHighlightThickness Default: 0 Type: Dimension
Access: CSG Class: XmCNavigationType Default: XmNONE Type: XmNavigationType Access: CSG Class: XmCShadowThickness Default: 2 Type: Dimen-
sion Access: CSG Class: XmCTopShadowColor Default: dynamic Type: Pixel Access: CSG Class: XmCTopShadowPixmap Default: dynamic Type:
Pixmap Access: CSG Class: XmCTraversalOn Default: False Type: Boolean Access: G Class: XmCUnitType Default: dynamic Type: unsigned char
Access: CSG Class: XmCUserData Default: NULL Type: XtPointer Access: CSG
Core Resource Set
Class: XmCAccelerators Default: dynamic Type: XtAccelerators Access: CSG Class: XmCSensitive Default: dynamic Type: Boolean Access: G
Class: XmCBackground Default: dynamic Type: Pixel Access: CSG Class: XmCPixmap Default: XmUNSPECIFIED_PIXMAP Type: Pixmap Access: CSG
Class: XmCBorderColor Default: XtDefaultForeground Type: Pixel Access: CSG Class: XmCPixmap Default: XmUNSPECIFIED_PIXMAP Type: Pixmap
Access: CSG Class: XmCBorderWidth Default: 0 Type: Dimension Access: CSG Class: XmCColormap Default: dynamic Type: Colormap Access: CG
Class: XmCDepth Default: dynamic Type: int Access: CG Class: XmCCallback Default: NULL Type: XtCallbackList Access: C Class: XmCHeight
Default: dynamic Type: Dimension Access: CSG Class: XmCInitialResourcesPersistent Default: True Type: Boolean Access: C Class: XmCMapped-
WhenManaged Default: True Type: Boolean Access: CSG Class: XmCScreen Default: dynamic Type: Screen * Access: CG Class: XmCSensitive
Default: True Type: Boolean Access: CSG Class: XmCTranslations Default: dynamic Type: XtTranslations Access: CSG Class: XmCWidth Default:
dynamic Type: Dimension Access: CSG Class: XmCPosition Default: 0 Type: Position Access: CSG Class: XmCPosition Default: 0 Type: Posi-
tion Access: CSG
Translations
There are no translations for XmSeparator.
SEE ALSO
Core(3X), XmCreateSeparator(3X), XmPrimitive(3X)
XmSeparator(3X)