XmStringDrawUnderline

A compound string function that underlines a string drawn in an X Window

Format

#include <Xm/Xm.h>
void XmStringDrawUnderline
Display *
dWindow wXmRenderTable
rendertableXmString stringGC
gcPosition xPosition
yDimension widthunsigned char
alignmentunsigned char
layout_directionXRectangle *
clipXmString underline

DESCRIPTION

XmStringDrawUnderline draws a compound string in an X Window. If the substring identified by underline can be matched in string, the substring will be underlined. Once a match has occurred, no further matches or underlining will be done. Only the first text component of underline is used for matching.

If a compound string segment uses a rendition that contains a font set, the graphic context passed to this routine will have the GC font member left in an undefined state. The underlying XmbStringDraw function called by this routine modifies the font ID field of the GC passed into it and does not attempt to restore the font ID to the incoming value. If the compound string segment is not drawn using a font set, the graphic context must contain a valid font member. Graphic contexts created by XtGetGC are not accepted by this routine; instead, use XtAllocateGC to create a graphic context.