Blob Blame History Raw
'\" t
...\" SeparB.sgm /main/9 1996/09/08 21:01:44 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 "XmSeparatorGadget" "library call"
.SH "NAME"
\fBXmSeparatorGadget\fP \(em The SeparatorGadget widget class
.iX "XmSeparatorGadget"
.iX "widget class" "SeparatorGadget"
.SH "SYNOPSIS"
.PP
.nf
#include <Xm/SeparatoG\&.h>
.fi
.SH "DESCRIPTION"
.PP
SeparatorGadget separates items in a display\&.
Several
line drawing styles are provided, as well as horizontal or vertical
orientation\&.
.PP
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 \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
SeparatorGadget does not draw shadows around the separator\&.
The Gadget resource \fBXmNshadowThickness\fP is used for the
SeparatorGadget\&'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
SeparatorGadget does not highlight and allows no traversing\&. The Gadget
resource \fBXmNtraversalOn\fP is forced to False\&.
SeparatorGadget
holds the \fBXmQTmenuSavvy\fP trait\&.
.SS "Classes"
.PP
SeparatorGadget inherits behavior,
resources, and traits from \fBObject\fP, \fBRectObj\fP, and \fBXmGadget\fP\&.
.PP
The class pointer is \fBxmSeparatorGadgetClass\fP\&.
.PP
The class name is \fBXmSeparatorGadget\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 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 \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.
\fBXmSeparatorGadget 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
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\&.
.IP "\fBXmNorientation\fP" 10
Specifies whether SeparatorGadget is displayed 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
SeparatorGadget inherits behavior and resources from the
superclasses in the following tables\&.
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.
\fBXmGadget Resource Set\fP
\fBName\fP\fBClass\fP\fBType\fP\fBDefault\fP\fBAccess\fP
_____
XmNbackgroundXmCBackgroundPixeldynamicCSG
_____
XmNbackgroundPixmapXmCPixmapPixmapXmUNSPECIFIED_PIXMAPCSG
_____
XmNbottomShadowColorXmCBottomShadowColorPixeldynamicCSG
_____
XmNbottomShadowPixmapXmCBottomShadowPixmapPixmapdynamicCSG
_____
XmNhelpCallbackXmCCallbackXtCallbackListNULLC
_____
XmNforegroundXmCForegroundPixeldynamicCSG
_____
XmNhighlightColorXmCHighlightColorPixeldynamicCSG
_____
XmNhighlightOnEnterXmCHighlightOnEnterBooleanFalseCSG
_____
XmNhighlightPixmapXmCHighlightPixmapPixmapdynamicCSG
_____
XmNhighlightThicknessXmCHighlightThicknessDimension0CSG
_____
XmNlayoutDirectionXmNCLayoutDirectionXmDirectiondynamicCG
_____
XmNnavigationTypeXmCNavigationTypeXmNavigationTypeXmNONECSG
_____
XmNshadowThicknessXmCShadowThicknessDimension2CSG
_____
XmNtopShadowColorXmCTopShadowColorPixeldynamicCSG
_____
XmNtopShadowPixmapXmCTopShadowPixmapPixmapdynamicCSG
_____
XmNtraversalOnXmCTraversalOnBooleanFalseG
_____
XmNunitTypeXmCUnitTypeunsigned chardynamicCSG
_____
XmNuserDataXmCUserDataXtPointerNULLCSG
_____
.TE
.PP
.TS
tab() box;
c s s s s
l| l| l| l| l.
\fBRectObj Resource Set\fP
\fBName\fP\fBClass\fP\fBType\fP\fBDefault\fP\fBAccess\fP
_____
XmNancestorSensitiveXmCSensitiveBooleandynamicG
_____
XmNborderWidthXmCBorderWidthDimension0N/A
_____
XmNheightXmCHeightDimensiondynamicCSG
_____
XmNsensitiveXmCSensitiveBooleanTrueCSG
_____
XmNwidthXmCWidthDimensiondynamicCSG
_____
XmNxXmCPositionPosition0CSG
_____
XmNyXmCPositionPosition0CSG
_____
.TE
.PP
.TS
tab() box;
c s s s s
l| l| l| l| l.
\fBObject Resource Set\fP
\fBName\fP\fBClass\fP\fBType\fP\fBDefault\fP\fBAccess\fP
_____
XmNdestroyCallbackXmCCallbackXtCallbackListNULLC
_____
.TE
.SS "Behavior"
.PP
\fBXmSeparatorGadget\fP has no behavior\&.
.SH "RELATED"
.PP
\fBObject\fP(3),
\fBRectObj\fP(3),
\fBXmCreateSeparatorGadget\fP(3),
\fBXmGadget\fP(3),
\fBXmVaCreateSeparatorGadget\fP(3), and
\fBXmVaCreateManagedSeparatorGadget\fP(3)\&.