Museum

 XmStringDrawImage(Xm)          6 January 1993          XmStringDrawImage(Xm)


 Name

    XmStringDrawImage - a compound string function that draws a compound
    string in an X Window and creates an image

 Syntax


    #include <Xm/Xm.h>

    void XmStringDrawImage (d, w, fontlist, string, gc, x, y, width,
                            alignment, layout_direction, clip)
    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;


 Description

    XmStringDrawImage draws a compound string in an X Window and paints both
    the foreground and background bits of each character.  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 com-
    pound 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 dis-
            played compound string.

    alignment
            Specifies how the string will be aligned within the specified
            rectangle.  It is either XmALIGNMENTBEGINNING, XmALIGNMENT-
            CENTER, or XmALIGNMENTEND.

    layoutdirection
            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 com-
            pound string will be drawn.  If NULL, no clipping will be done.

 See also

    XmStringCreate(Xm)