'\" t
...\" SeparA.sgm /main/9 1996/09/08 21:01:35 rws $
.de P!
.fl
\!!1 setgray
.fl
\\&.\"
.fl
\!!0 setgray
.fl			\" force out current output buffer
\!!save /psv exch def currentpoint translate 0 0 moveto
\!!/showpage{}def
.fl			\" prolog
.sy sed -e 's/^/!/' \\$1\" bring in postscript file
\!!psv restore
.
.de pF
.ie     \\*(f1 .ds f1 \\n(.f
.el .ie \\*(f2 .ds f2 \\n(.f
.el .ie \\*(f3 .ds f3 \\n(.f
.el .ie \\*(f4 .ds f4 \\n(.f
.el .tm ? font overflow
.ft \\$1
..
.de fP
.ie     !\\*(f4 \{\
.	ft \\*(f4
.	ds f4\"
'	br \}
.el .ie !\\*(f3 \{\
.	ft \\*(f3
.	ds f3\"
'	br \}
.el .ie !\\*(f2 \{\
.	ft \\*(f2
.	ds f2\"
'	br \}
.el .ie !\\*(f1 \{\
.	ft \\*(f1
.	ds f1\"
'	br \}
.el .tm ? font underflow
..
.ds f1\"
.ds f2\"
.ds f3\"
.ds f4\"
.ta 8n 16n 24n 32n 40n 48n 56n 64n 72n 
.TH "XmSeparator" "library call"
.SH "NAME"
\fBXmSeparator\fP \(em The Separator widget class
.iX "XmSeparator"
.iX "widget class" "Separator"
.SH "SYNOPSIS"
.PP
.nf
#include <Xm/Separator\&.h>
.fi
.SH "DESCRIPTION"
.PP
Separator is a primitive widget that
separates items in a display\&. Several different
line drawing styles are provided, as well as horizontal or vertical
orientation\&.
.PP
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 \fBXtSetValues\fP with a new \fBXmNseparatorType\fP 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
\fBXtSetValues\fP call\&.
.PP
Separator does not draw shadows around the separator\&.
The Primitive resource \fBXmNshadowThickness\fP is used for the
Separator\&'s thickness when \fBXmNseparatorType\fP is \fBXmSHADOW_ETCHED_IN\fP,
\fBXmSHADOW_ETCHED_IN_DASH\fP, \fBXmSHADOW_ETCHED_OUT\fP, or
\fBXmSHADOW_ETCHED_OUT_DASH\fP\&.
.PP
Separator does not highlight and allows no traversing\&. The primitive
resource \fBXmNtraversalOn\fP is forced to False\&.
.PP
The \fBXmNseparatorType\fP of \fBXmNO_LINE\fP 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
\fBXmNbackgroundPixmap\fP
argument type as defined by \fBCore\fP\&.
Whenever the widget is redrawn,
its background is displayed containing the desired separator drawing\&.
Separator holds the \fBXmQTmenuSavvy\fP trait\&.
.SS "Classes"
.PP
Separator inherits behavior, resources, and traits from \fBCore\fP
and \fBXmPrimitive\fP\&.
.PP
The class pointer is \fBxmSeparatorWidgetClass\fP\&.
.PP
The class name is \fBXmSeparator\fP\&.
.SS "New Resources"
.PP
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 \fB\&.Xdefaults\fP file, remove the \fBXmN\fP or
\fBXmC\fP prefix and use the remaining letters\&. To specify one of the defined
values for a resource in a \fB\&.Xdefaults\fP file, remove the \fBXm\fP prefix anduse 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 \fBXtSetValues\fP (S),
retrieved by using \fBXtGetValues\fP (G), or is not applicable (N/A)\&.
.PP
.TS
tab() box;
c s s s s
l| l| l| l| l.
\fBXmSeparator Resource Set\fP
\fBName\fP\fBClass\fP\fBType\fP\fBDefault\fP\fBAccess\fP
_____
XmNmarginXmCMarginDimension0CSG
_____
XmNorientationXmCOrientationunsigned charXmHORIZONTALCSG
_____
XmNseparatorTypeXmCSeparatorTypeunsigned charXmSHADOW_ETCHED_INCSG
_____
.TE
.IP "\fBXmNmargin\fP" 10
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\&.
.IP "\fBXmNorientation\fP" 10
Displays Separator vertically or horizontally\&.
This resource can have values of \fBXmVERTICAL\fP and \fBXmHORIZONTAL\fP\&.
.IP "\fBXmNseparatorType\fP" 10
Specifies the type of line drawing to be done in the Separator widget\&.
.RS
.IP "\fBXmSINGLE_LINE\fP" 10
Single line
.IP "\fBXmDOUBLE_LINE\fP" 10
Double line
.IP "\fBXmSINGLE_DASHED_LINE\fP" 10
Single-dashed line
.IP "\fBXmDOUBLE_DASHED_LINE\fP" 10
Double-dashed line
.IP "\fBXmNO_LINE\fP" 10
No line
.IP "\fBXmSHADOW_ETCHED_IN\fP" 10
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 \fBXmNshadowThickness\fP\&. For
horizontal orientation, the top shadow is drawn in \fBXmNtopShadowColor\fP
and the bottom shadow is drawn in \fBXmNbottomShadowColor\fP\&. For
vertical orientation, the left edge is drawn in \fBXmNtopShadowColor\fP
and the right edge is drawn in \fBXmNbottomShadowColor\fP\&.
.IP "\fBXmSHADOW_ETCHED_OUT\fP" 10
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 \fBXmNshadowThickness\fP\&. For horizontal
orientation, the top shadow is drawn in \fBXmNbottomShadowColor\fP and
the bottom shadow is drawn in \fBXmNtopShadowColor\fP\&. For vertical
orientation, the left edge is drawn in \fBXmNbottomShadowColor\fP and
the right edge is drawn in \fBXmNtopShadowColor\fP\&.
.IP "\fBXmSHADOW_ETCHED_IN_DASH\fP" 10
Identical to
\fBXmSHADOW_ETCHED_IN\fP except a series of lines creates a dashed line\&.
.IP "\fBXmSHADOW_ETCHED_OUT_DASH\fP" 10
Identical to
\fBXmSHADOW_ETCHED_OUT\fP except a series of lines creates a dashed line\&.
.RE
.SS "Inherited Resources"
.PP
Separator inherits behavior and resources from the
superclasses in the following table\&.
For a complete description of each resource, refer to the
reference page for that superclass\&.
.PP
.TS
tab() box;
c s s s s
l| l| l| l| l.
\fBXmPrimitive Resource Set\fP
\fBName\fP\fBClass\fP\fBType\fP\fBDefault\fP\fBAccess\fP
_____
XmNbottomShadowColorXmCBottomShadowColorPixeldynamicCSG
_____
XmNbottomShadowPixmapXmCBottomShadowPixmapPixmapXmUNSPECIFIED_PIXMAPCSG
_____
XmNconvertCallbackXmCCallbackXtCallbackListNULLC
_____
XmNforegroundXmCForegroundPixeldynamicCSG
_____
XmNhelpCallbackXmCCallbackXtCallbackListNULLC
_____
XmNhighlightColorXmCHighlightColorPixeldynamicCSG
_____
XmNhighlightOnEnterXmCHighlightOnEnterBooleanFalseCSG
_____
XmNhighlightPixmapXmCHighlightPixmapPixmapdynamicCSG
_____
XmNhighlightThicknessXmCHighlightThicknessDimension0CSG
_____
XmNlayoutDirectionXmCLayoutDirectionXmDirectiondynamicCG
_____
XmNnavigationTypeXmCNavigationTypeXmNavigationTypeXmNONECSG
_____
XmNpopupHandlerCallbackXmCCallbackXtCallbackListNULLC
_____
XmNshadowThicknessXmCShadowThicknessDimension2CSG
_____
XmNtopShadowColorXmCTopShadowColorPixeldynamicCSG
_____
XmNtopShadowPixmapXmCTopShadowPixmapPixmapdynamicCSG
_____
XmNtraversalOnXmCTraversalOnBooleanFalseG
_____
XmNunitTypeXmCUnitTypeunsigned chardynamicCSG
_____
XmNuserDataXmCUserDataXtPointerNULLCSG
_____
.TE
.PP
.TS
tab() box;
c s s s s
l| l| l| l| l.
\fBCore Resource Set\fP
\fBName\fP\fBClass\fP\fBType\fP\fBDefault\fP\fBAccess\fP
_____
XmNacceleratorsXmCAcceleratorsXtAcceleratorsdynamicCSG
_____
XmNancestorSensitiveXmCSensitiveBooleandynamicG
_____
XmNbackgroundXmCBackgroundPixeldynamicCSG
_____
XmNbackgroundPixmapXmCPixmapPixmapXmUNSPECIFIED_PIXMAPCSG
_____
XmNborderColorXmCBorderColorPixelXtDefaultForegroundCSG
_____
XmNborderPixmapXmCPixmapPixmapXmUNSPECIFIED_PIXMAPCSG
_____
XmNborderWidthXmCBorderWidthDimension0CSG
_____
XmNcolormapXmCColormapColormapdynamicCG
_____
XmNdepthXmCDepthintdynamicCG
_____
XmNdestroyCallbackXmCCallbackXtCallbackListNULLC
_____
XmNheightXmCHeightDimensiondynamicCSG
_____
XmNinitialResourcesPersistentXmCInitialResourcesPersistentBooleanTrueC
_____
XmNmappedWhenManagedXmCMappedWhenManagedBooleanTrueCSG
_____
XmNscreenXmCScreenScreen *dynamicCG
_____
XmNsensitiveXmCSensitiveBooleanTrueCSG
_____
XmNtranslationsXmCTranslationsXtTranslationsdynamicCSG
_____
XmNwidthXmCWidthDimensiondynamicCSG
_____
XmNxXmCPositionPosition0CSG
_____
XmNyXmCPositionPosition0CSG
_____
.TE
.SS "Translations"
.PP
There are no translations for \fBXmSeparator\fP\&.
.SH "RELATED"
.PP
\fBCore\fP(3),
\fBXmCreateSeparator\fP(3),
\fBXmVaCreateSeparator\fP(3), and
\fBXmVaCreateManagedSeparator\fP(3)\&.