XmStringDrawUnderline

NAME

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

SYNOPSIS

#include <Xm/Xm.h>
void XmStringDrawUnderline (d, w, fontlist, string, gc, x, y, width, alignment, layout_direction, clip, underline)
      Display        * d;
      Window         w;
      XmFontList     fontlist;
      XmString       string;
      GC             gc;
      Position       x;
      Position       y;
      Dimension      width;
      unsigned char  alignment;
      unsigned char  layout_direction;
      XRectangle     * clip;
      XmString       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.

If a compound string segment uses a font list entry that defines 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.

d: Specifies the display.
w: Specifies the window.
fontlist: Specifies the font list.
string: Specifies the string.
gc: Specifies the graphics context to use.
x: Specifies a coordinate of the rectangle that will contain the displayed compound string.
y: Specifies a coordinate of the rectangle that will contain the displayed compound string.
width: Specifies the width of the rectangle that will contain the displayed compound string.
alignment: Specifies how the string will be aligned within the specified rectangle. It is one of XmALIGNMENT_BEGINNING, XmALIGNMENT_CENTER, or XmALIGNMENT_END.
layout_direction: Controls the direction in which the segments of the compound string will be laid out. It also determines the meaning of the alignment parameter.
clip: Allows the application to restrict the area into which the compound string will be drawn. If NULL, no clipping will be done.
underline: Specifies the substring to be underlined.

RELATED INFORMATION

XmStringCreate(3X).