XmStringDraw(3X)

XmStringDraw - A compound string function that draws a compound string in an X window

Showing IRIX 6.5.30 (default release). Added in IRIX 6.5.19.

     NAME
          XmStringDraw - A compound string function that draws a
          compound string in an X window

     SYNOPSIS
          #include <Xm/Xm.h>

          void XmStringDraw (d, w, fontlist, string, gc, x, y, width, alignment, layout_direction, clip)
               Display   * d;
               Window    w;
               XmFontListfontlist;
               XmString  string;
               GC        gc;
               Position  x;
               Position  y;
               Dimension width;
               unsigned charalignment;
               unsigned charlayout_direction;
               XRectangle* clip;

     DESCRIPTION
          XmStringDraw draws a compound string in an X Window.  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 valid for 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 either
               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.

     RELATED INFORMATION
          XmStringCreate(3X).