XmSeparator(3X) UNIX System V 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 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 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 or XmSHADOW_ETCHED_OUT.
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
10/89 Page 1
XmSeparator(3X) UNIX System V XmSeparator(3X)
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 | Dimension | 0 | CSG |
|_________________|__________________|_______________|____________________|________|
| XmNorientation | XmCOrientation | unsigned char| XmHORIZONTAL | CSG |
|_________________|__________________|_______________|____________________|________|
| XmNseparatorType| XmCSeparatorType| unsigned char| XmSHADOW_ETCHED_IN| CSG |
|_________________|__________________|_______________|____________________|________|
XmNmargin
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.
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.
⊕ XmSINGLE_LINE - single line.
⊕ XmDOUBLE_LINE - double line.
⊕ XmSINGLE_DASHED_LINE - single-dashed line.
⊕ XmDOUBLE_DASHED_LINE - double-dashed line.
⊕ XmNO_LINE - no line.
Page 2 10/89
XmSeparator(3X) UNIX System V XmSeparator(3X)
⊕ XmSHADOW_ETCHED_IN - 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.
⊕ XmSHADOW_ETCHED_OUT - 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 each resource, refer to the
man page for that superclass.
__________________________________________________________________________________________________
XmPrimitive Resource Set
__________________________________________________________________________________________________
Name Class Type Default Access
__________________________________________________________________________________________________
__________________________________________________________________________________________________
XmNbottomShadowColor XmCBottomShadowColor Pixel dynamic CSG
__________________________________________________________________________________________________
XmNbottomShadowPixmap XmCBottomShadowPixmap Pixmap XmUNSPECIFIED_PIXMAP CSG
__________________________________________________________________________________________________
XmNforeground XmCForeground Pixel dynamic CSG
__________________________________________________________________________________________________
XmNhelpCallback XmCCallback XtCallbackList NULL C
__________________________________________________________________________________________________
XmNhighlightColor XmCHighlightColor Pixel dynamic CSG
__________________________________________________________________________________________________
XmNhighlightOnEnter XmCHighlightOnEnter Boolean False CSG
__________________________________________________________________________________________________
XmNhighlightPixmap XmCHighlightPixmap Pixmap dynamic CSG
__________________________________________________________________________________________________
XmNhighlightThickness XmCHighlightThickness Dimension 0 CSG
__________________________________________________________________________________________________
XmNnavigationType XmCNavigationType XmNavigationType XmNONE G
__________________________________________________________________________________________________
XmNshadowThickness XmCShadowThickness Dimension 2 CSG
__________________________________________________________________________________________________
XmNtopShadowColor XmCTopShadowColor Pixel dynamic CSG
__________________________________________________________________________________________________
XmNtopShadowPixmap XmCTopShadowPixmap Pixmap dynamic CSG
10/89 Page 3
XmSeparator(3X) UNIX System V XmSeparator(3X)
|_____________________|_______________________|__________________|______________________|________|
|XmNtraversalOn | XmCTraversalOn | Boolean | False | G |
|_____________________|_______________________|__________________|______________________|________|
|XmNunitType | XmCUnitType | unsigned char | dynamic | CSG |
|_____________________|_______________________|__________________|______________________|________|
|XmNuserData | XmCUserData | Pointer | NULL | CSG |
|_____________________|_______________________|__________________|______________________|________|
________________________________________________________________________________________________________________
Core Resource Set
________________________________________________________________________________________________________________
Name Class Type Default Access
________________________________________________________________________________________________________________
________________________________________________________________________________________________________________
XmNaccelerators XmCAccelerators XtAccelerators dynamic CSG
________________________________________________________________________________________________________________
XmNancestorSensitive XmCSensitive Boolean dynamic G
________________________________________________________________________________________________________________
XmNbackground XmCBackground Pixel dynamic CSG
________________________________________________________________________________________________________________
XmNbackgroundPixmap XmCPixmap Pixmap XmUNSPECIFIED_PIXMAP CSG
________________________________________________________________________________________________________________
XmNborderColor XmCBorderColor Pixel XtDefaultForeground CSG
________________________________________________________________________________________________________________
XmNborderPixmap XmCPixmap Pixmap XmUNSPECIFIED_PIXMAP CSG
________________________________________________________________________________________________________________
XmNborderWidth XmCBorderWidth Dimension 0 CSG
________________________________________________________________________________________________________________
XmNcolormap XmCColormap Colormap dynamic CG
________________________________________________________________________________________________________________
XmNdepth XmCDepth int dynamic CG
________________________________________________________________________________________________________________
XmNdestroyCallback XmCCallback XtCallbackList NULL C
________________________________________________________________________________________________________________
XmNheight XmCHeight Dimension dynamic CSG
________________________________________________________________________________________________________________
XmNinitialResourcesPersistent XmCInitialResourcesPersistent Boolean True C
________________________________________________________________________________________________________________
XmNmappedWhenManaged XmCMappedWhenManaged Boolean True CSG
________________________________________________________________________________________________________________
XmNscreen XmCScreen Screen * dynamic CG
________________________________________________________________________________________________________________
XmNsensitive XmCSensitive Boolean True CSG
________________________________________________________________________________________________________________
XmNtranslations XmCTranslations XtTranslations dynamic CSG
________________________________________________________________________________________________________________
XmNwidth XmCWidth Dimension dynamic CSG
________________________________________________________________________________________________________________
XmNx XmCPosition Position 0 CSG
________________________________________________________________________________________________________________
XmNy XmCPosition Position 0 CSG
________________________________________________________________________________________________________________
Page 4 10/89
XmSeparator(3X) UNIX System V XmSeparator(3X)
| | | | | |
| | | | | |
| Translations | | | | |
| There are no translations
| for XmSeparator. | | | |
| | | | | |
R
|ELATED INFORMATION | | | | |
| Core(3X), XmCreateSeparat
|or(3X), and XmPrimitive(3X). | | | |
| | | | | |
| | | |
10/89 Page 5