XmSeparatorGadget(3X) UNIX System V XmSeparatorGadget(3X)
NAME
XmSeparatorGadget - the SeparatorGadget widget class.
SYNOPSIS
#include <Xm/SeparatoG.h>
DESCRIPTION
SeparatorGadget separates items in a display. Several line drawing styles
are provided, as well as horizontal or vertical orientation.
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 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.
SeparatorGadget does not draw shadows around the separator. The Gadget
resource XmNshadowThickness is used for the SeparatorGadget's thickness
when XmNseparatorType is XmSHADOW_ETCHED_IN or XmSHADOW_ETCHED_OUT.
SeparatorGadget does not highlight and allows no traversing. The Gadget
resource XmNtraversalOn is forced to False.
Classes
SeparatorGadget inherits behavior and resources from Object, RectObj, and
XmGadget Classes.
The class pointer is xmSeparatorGadgetClass.
The class name is XmSeparatorGadget.
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
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).
10/89 Page 1
XmSeparatorGadget(3X) UNIX System V XmSeparatorGadget(3X)
___________________________________________________________________________________
| XmSeparatorGadget 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 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.
XmNorientation
Specifies whether SeparatorGadget is displayed 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 - 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
Page 2 10/89
XmSeparatorGadget(3X) UNIX System V XmSeparatorGadget(3X)
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
SeparatorGadget inherits behavior and resources from the following
superclasses. For a complete description of each resource, refer to the
man page for that superclass.
_____________________________________________________________________________________
| XmGadget Resource Set |
|_____________________|_______________________|__________________|_________|________|
|Name | Class | Type | Default| Access|
|_____________________|_______________________|__________________|_________|________|
|_____________________|_______________________|__________________|_________|________|
|XmNhelpCallback | XmCCallback | XtCallbackList | NULL | C |
|_____________________|_______________________|__________________|_________|________|
|XmNhighlightOnEnter | XmCHighlightOnEnter | Boolean | False | CSG |
|_____________________|_______________________|__________________|_________|________|
|XmNhighlightThickness| XmCHighlightThickness| Dimension | 0 | CSG |
|_____________________|_______________________|__________________|_________|________|
|XmNnavigationType | XmCNavigationType | XmNavigationType| XmNONE | G |
|_____________________|_______________________|__________________|_________|________|
|XmNshadowThickness | XmCShadowThickness | Dimension | 2 | CSG |
|_____________________|_______________________|__________________|_________|________|
|XmNtraversalOn | XmCTraversalOn | Boolean | False | G |
|_____________________|_______________________|__________________|_________|________|
|XmNunitType | XmCUnitType | unsigned char | dynamic| CSG |
|_____________________|_______________________|__________________|_________|________|
|XmNuserData | XmCUserData | Pointer | NULL | CSG |
|_____________________|_______________________|__________________|_________|________|
______________________________________________________________________
RectObj Resource Set
______________________________________________________________________
Name Class Type Default Access
______________________________________________________________________
______________________________________________________________________
XmNancestorSensitive XmCSensitive Boolean dynamic G
______________________________________________________________________
XmNborderWidth XmCBorderWidth Dimension 0 CSG
______________________________________________________________________
XmNheight XmCHeight Dimension dynamic CSG
______________________________________________________________________
XmNsensitive XmCSensitive Boolean True CSG
______________________________________________________________________
XmNwidth XmCWidth Dimension dynamic CSG
______________________________________________________________________
XmNx XmCPosition Position 0 CSG
______________________________________________________________________
10/89 Page 3
XmSeparatorGadget(3X) UNIX System V XmSeparatorGadget(3X)
| XmNy | XmCPosition | Position | 0 | CSG |
|_____________________|________________|___________|_________|________|
______________________________________________________________________
| Object Resource Set |
|___________________|_____________|________________|_________|________|
| Name | Class | Type | Default| Access|
|___________________|_____________|________________|_________|________|
|___________________|_____________|________________|_________|________|
| XmNdestroyCallback| XmCCallback| XtCallbackList| NULL | C |
|___________________|_____________|________________|_________|________|
Behavior
XmSeparatorGadget has no behavior.
RELATED INFORMATION
Object(3X), RectObject(3X), XmCreateSeparatorGadget(3X), and
XmGadget(3X).
Page 4 10/89