XmeDrawSeparator(3X) UNIX System V XmeDrawSeparator(3X)
NAME
XmeDrawSeparator - Draws several different types of line-
based separators
SYNOPSIS
#include <Xm/DrawP.h>
void XmeDrawSeparator(
Display *display,
Drawable drawable,
GC top_gc,
GC bottom_gc,
GC separator_gc,
Position x,
Position y,
Dimension width,
Dimension height,
Dimension shadow_thickness,
Dimension margin,
unsigned char orientation,
unsigned char separator_type);
VERSION
This page documents Motif 2.1.
DESCRIPTION
XmeDrawSeparator draws a Motif-style, three-dimensional line
to separate various components.
display Specifies the display.
drawable Specifies the drawable on which the separator will
be rendered. Typically, the drawable will be a
widget window.
top_gc Specifies the graphics context of the top shadow
on those separators that have shadows. (The
separators have shadows when the separator_type is
XmSHADOW_ETCHED_IN, XmSHADOW_ETCHED_OUT,
XmSHADOW_ETCHED_IN_DASH, or
XmSHADOW_ETCHED_OUT_DASH.) The definition of
"top" depends on the values of both the
separator_typeand the orientation. Suppose the
separator_type is XmSHADOW_ETCHED_IN or
XmSHADOW_ETCHED_IN_DASH. If the orientation is
XmHORIZONTAL, then the top shadow is the shadow
above the separator and the bottom shadow is the
shadow below the separator. However, if the
orientation is XmVERTICAL, then the top shadow is
immediately to the left of the separator and the
bottom shadow is immediately to the right of the
separator. Now consider the results if the
separator_type is XmSHADOW_ETCHED_OUT or
Page 1 (printed 7/20/06)
XmeDrawSeparator(3X) UNIX System V XmeDrawSeparator(3X)
XmSHADOW_ETCHED_OUT_DASH. If the orientation is
XmHORIZONTAL, the top shadow is the shadow below
the separator, and the bottom shadow is the shadow
above the separator. However, if the orientation
is XmVERTICAL, then the top shadow is immediately
to the right of the separator, and the bottom
shadow is immediately to the left of the
separator.
bottom_gc Specifies the graphics context of the bottom
shadow on those separators that have shadows. (See
the description of top_gcfor more information.)
separator_gc
Specifies the graphics context of the separator
itself when the separator_type is XmSINGLE_LINE,
XmDOUBLE_LINE, XmSINGLE_DASHED_LINE, or
XmDOUBLE_DASHED_LINE.
x Specifies the x-coordinate of the start of the
bounding box, in pixels. The XmeDrawSeparator
function will draw the separator centered within
the bounding box. However, the separator's exact
position depends not only on the bounding box but
also on the margin. (See marginfor details.)
y Specifies the y-coordinate of the start of the
bounding box, in pixels. The separator will be
drawn centered within the bounding box. However,
the separator's exact position depends not only on
the bounding box but also on the margin. (See
marginfor details.)
width Specifies the width of the bounding box, in
pixels.
height Specifies the height of the bounding box, in
pixels.
shadow_thickness
Specifies the shadow thickness when
separator_typeis XmSHADOW_ETCHED_IN_DASH,
XmSHADOW_ETCHED_OUT_DASH, XmSHADOW_ETCHED_IN, or
XmSHADOW_ETCHED_OUT. The value of
shadow_thickness has no effect when the
separator_type is XmSINGLE_LINE, XmDOUBLE_LINE,
XmSINGLE_DASHED_LINE, XmDOUBLE_DASHED_LINE, or
XmNO_LINE.
margin If the orientation is XmHORIZONTAL, margin
specifies the gap between the left side of the
bounding box and the left endpoint of the
Page 2 (printed 7/20/06)
XmeDrawSeparator(3X) UNIX System V XmeDrawSeparator(3X)
separator. The margin also specifies the gap, in
pixels, between the right side of the bounding box
and the right endpoint of the separator. If the
orientation is XmVERTICAL, margin specifies the
gap between the top side of the bounding box and
the top endpoint of the separator. The margin
also specifies the gap, in pixels, between the
bottom side of the bounding box and the bottom
endpoint of the separator.
orientation
Specifies the orientation of the line, either
horizontal (specify XmHORIZONTAL) or vertical
(specify XmVERTICAL).
separator_type
Specifies the type of line and shadow to be used
as a separator. The possible values are as
follows:
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 shadow_thickness.
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 shadow_thickness.
XmSHADOW_ETCHED_IN_DASH
Identical to XmSHADOW_ETCHED_IN, except
that a series of lines creates a dashed
line.
XmSHADOW_ETCHED_OUT_DASH
Page 3 (printed 7/20/06)
XmeDrawSeparator(3X) UNIX System V XmeDrawSeparator(3X)
Identical to XmSHADOW_ETCHED_OUT, except
that a series of lines creates a dashed
line.
RELATED
XmSeparator(3).
Page 4 (printed 7/20/06)
