NAME¶
XmSeparator — The Separator widget class "XmSeparator"
"widget class" "Separator"
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,
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. Separator holds the
XmQTmenuSavvy trait.
Classes¶
Separator inherits behavior, resources, and traits from
Core and
XmPrimitive.
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
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
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
- 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 XmNshadowThickness.
For horizontal orientation, the top shadow is drawn in
XmNtopShadowColor and the bottom shadow is drawn in
XmNbottomShadowColor. 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 bottom 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 superclasses in the following
table. For a complete description of each resource, refer to the reference
page for that superclass.
XmPrimitive Resource Set |
|
|
|
|
Name |
Class |
Type |
Default |
Access |
_ |
_ |
_ |
_ |
_ |
XmNbottomShadowColor |
XmCBottomShadowColor |
Pixel |
dynamic |
CSG |
_ |
_ |
_ |
_ |
_ |
XmNbottomShadowPixmap |
XmCBottomShadowPixmap |
Pixmap |
XmUNSPECIFIED_PIXMAP |
CSG |
_ |
_ |
_ |
_ |
_ |
XmNconvertCallback |
XmCCallback |
XtCallbackList |
NULL |
C |
_ |
_ |
_ |
_ |
_ |
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 |
_ |
_ |
_ |
_ |
_ |
XmNlayoutDirection |
XmCLayoutDirection |
XmDirection |
dynamic |
CG |
_ |
_ |
_ |
_ |
_ |
XmNnavigationType |
XmCNavigationType |
XmNavigationType |
XmNONE |
CSG |
_ |
_ |
_ |
_ |
_ |
XmNpopupHandlerCallback |
XmCCallback |
XtCallbackList |
NULL |
C |
_ |
_ |
_ |
_ |
_ |
XmNshadowThickness |
XmCShadowThickness |
Dimension |
2 |
CSG |
_ |
_ |
_ |
_ |
_ |
XmNtopShadowColor |
XmCTopShadowColor |
Pixel |
dynamic |
CSG |
_ |
_ |
_ |
_ |
_ |
XmNtopShadowPixmap |
XmCTopShadowPixmap |
Pixmap |
dynamic |
CSG |
_ |
_ |
_ |
_ |
_ |
XmNtraversalOn |
XmCTraversalOn |
Boolean |
False |
G |
_ |
_ |
_ |
_ |
_ |
XmNunitType |
XmCUnitType |
unsigned char |
dynamic |
CSG |
_ |
_ |
_ |
_ |
_ |
XmNuserData |
XmCUserData |
XtPointer |
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 |
_ |
_ |
_ |
_ |
_ |
Translations¶
There are no translations for
XmSeparator.
Core(3),
XmCreateSeparator(3),
XmVaCreateSeparator(3), and
XmVaCreateManagedSeparator(3).