Index for Section 3X

Alphabetical listing for X

Bottom of page

XmStringDrawImage(3X)
OSF/Motif
NAME
  XmStringDrawImage - A compound string function that draws a compound string
  in an X Window and creates an image

SYNOPSIS
  #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 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 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.

SEE ALSO
  XmStringCreate(3X)

Index for Section 3X

Alphabetical listing for X

Top of page