XmSeparator(library call) XmSeparator(library call)
NAME [Toc] [Back]
XmSeparator - The Separator widget class
SYNOPSIS [Toc] [Back]
#include <Xm/Separator.h>
DESCRIPTION [Toc] [Back]
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 [Toc] [Back]
Separator inherits behavior, resources, and traits from Core and
XmPrimitive.
The class pointer is xmSeparatorWidgetClass.
The class name is XmSeparator.
New Resources [Toc] [Back]
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,
- 1 - Formatted: January 24, 2005
XmSeparator(library call) XmSeparator(library call)
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 [Toc] [Back]
Displays Separator vertically or horizontally. This
resource can have values of XmVERTICAL and XmHORIZONTAL.
XmNseparatorType [Toc] [Back]
Specifies the type of line drawing to be done in the
Separator widget.
XmSINGLE_LINE [Toc] [Back]
Single line
XmDOUBLE_LINE [Toc] [Back]
Double line
XmSINGLE_DASHED_LINE [Toc] [Back]
Single-dashed line
XmDOUBLE_DASHED_LINE [Toc] [Back]
Double-dashed line
XmNO_LINE No line
XmSHADOW_ETCHED_IN [Toc] [Back]
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
- 2 - Formatted: January 24, 2005
XmSeparator(library call) XmSeparator(library call)
in XmNbottomShadowColor. For vertical orientation,
the left edge is drawn in XmNtopShadowColor and
the right edge is drawn in XmNbottomShadowColor.
XmSHADOW_ETCHED_OUT [Toc] [Back]
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 [Toc] [Back]
Identical to XmSHADOW_ETCHED_IN except a series of
lines creates a dashed line.
XmSHADOW_ETCHED_OUT_DASH [Toc] [Back]
Identical to XmSHADOW_ETCHED_OUT except a series
of lines creates a dashed line.
Inherited Resources [Toc] [Back]
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.
- 3 - Formatted: January 24, 2005
XmSeparator(library call) XmSeparator(library call)
____________________________________________________________________________________________________
| 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 |
|________________________|_______________________|__________________|______________________|________|
|________________________|_______________________|__________________|______________________|________|
- 4 - Formatted: January 24, 2005
XmSeparator(library call) XmSeparator(library call)
________________________________________________________________________________________________________________
| 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 [Toc] [Back]
There are no translations for XmSeparator.
RELATED [Toc] [Back]
Core(3), XmCreateSeparator(3), and XmPrimitive(3).
- 5 - Formatted: January 24, 2005 [ Back ] |
