XmSeparatorGadget(library call) XmSeparatorGadget(library call)
NAME [Toc] [Back]
XmSeparatorGadget - The SeparatorGadget widget class
SYNOPSIS [Toc] [Back]
#include <Xm/SeparatoG.h>
DESCRIPTION [Toc] [Back]
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,
XmSHADOW_ETCHED_IN_DASH, XmSHADOW_ETCHED_OUT, or
XmSHADOW_ETCHED_OUT_DASH.
SeparatorGadget does not highlight and allows no traversing. The
Gadget resource XmNtraversalOn is forced to False. SeparatorGadget
holds the XmQTmenuSavvy trait.
Classes [Toc] [Back]
SeparatorGadget inherits behavior, resources, and traits from Object,
RectObj, and XmGadget.
The class pointer is xmSeparatorGadgetClass.
The class name is XmSeparatorGadget.
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 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).
- 1 - Formatted: January 24, 2005
XmSeparatorGadget(library call) XmSeparatorGadget(library call)
___________________________________________________________________________________
| 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 [Toc] [Back]
Specifies whether SeparatorGadget is displayed 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
in XmNbottomShadowColor. For vertical orientation,
the left edge is drawn in XmNtopShadowColor and
the right edge is drawn in XmNbottomShadowColor.
- 2 - Formatted: January 24, 2005
XmSeparatorGadget(library call) XmSeparatorGadget(library call)
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]
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.
- 3 - Formatted: January 24, 2005
XmSeparatorGadget(library call) XmSeparatorGadget(library call)
__________________________________________________________________________________________________
| XmGadget Resource Set |
|Name Class Type Default Access |
|______________________|_______________________|__________________|______________________|________|
|XmNbackground | XmCBackground | Pixel | dynamic | CSG |
|______________________|_______________________|__________________|______________________|________|
|XmNbackgroundPixmap | XmCPixmap | Pixmap | XmUNSPECIFIED_PIXMAP | CSG |
|______________________|_______________________|__________________|______________________|________|
|XmNbottomShadowColor | XmCBottomShadowColor | Pixel | dynamic | CSG |
|______________________|_______________________|__________________|______________________|________|
|XmNbottomShadowPixmap | XmCBottomShadowPixmap | Pixmap | dynamic | CSG |
|______________________|_______________________|__________________|______________________|________|
|XmNhelpCallback | XmCCallback | XtCallbackList | NULL | C |
|______________________|_______________________|__________________|______________________|________|
|XmNforeground | XmCForeground | Pixel | dynamic | CSG |
|______________________|_______________________|__________________|______________________|________|
|XmNhighlightColor | XmCHighlightColor | Pixel | dynamic | CSG |
|______________________|_______________________|__________________|______________________|________|
|XmNhighlightOnEnter | XmCHighlightOnEnter | Boolean | False | CSG |
|______________________|_______________________|__________________|______________________|________|
|XmNhighlightPixmap | XmCHighlightPixmap | Pixmap | dynamic | CSG |
|______________________|_______________________|__________________|______________________|________|
|XmNhighlightThickness | XmCHighlightThickness | Dimension | 0 | CSG |
|______________________|_______________________|__________________|______________________|________|
|XmNlayoutDirection | XmNCLayoutDirection | XmDirection | dynamic | CG |
|______________________|_______________________|__________________|______________________|________|
|XmNnavigationType | XmCNavigationType | XmNavigationType | XmNONE | CSG |
|______________________|_______________________|__________________|______________________|________|
|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
XmSeparatorGadget(library call) XmSeparatorGadget(library call)
______________________________________________________________________
| RectObj Resource Set |
|Name Class Type Default Access |
|_____________________|________________|___________|_________|________|
|XmNancestorSensitive | XmCSensitive | Boolean | dynamic | G |
|_____________________|________________|___________|_________|________|
|XmNborderWidth | XmCBorderWidth | Dimension | 0 | N/A |
|_____________________|________________|___________|_________|________|
|XmNheight | XmCHeight | Dimension | dynamic | CSG |
|_____________________|________________|___________|_________|________|
|XmNsensitive | XmCSensitive | Boolean | True | CSG |
|_____________________|________________|___________|_________|________|
|XmNwidth | XmCWidth | Dimension | dynamic | CSG |
|_____________________|________________|___________|_________|________|
|XmNx | XmCPosition | Position | 0 | CSG |
|_____________________|________________|___________|_________|________|
|XmNy | XmCPosition | Position | 0 | CSG |
|_____________________|________________|___________|_________|________|
|_____________________|________________|___________|_________|________|
______________________________________________________________________
| Object Resource Set |
|Name Class Type Default Access |
|___________________|_____________|________________|_________|________|
|XmNdestroyCallback | XmCCallback | XtCallbackList | NULL | C |
|___________________|_____________|________________|_________|________|
|___________________|_____________|________________|_________|________|
Behavior [Toc] [Back]
XmSeparatorGadget has no behavior.
RELATED [Toc] [Back]
Object(3), RectObj(3), XmCreateSeparatorGadget(3), and XmGadget(3).
- 5 - Formatted: January 24, 2005 [ Back ] |
