Manual pages › X Window and screen libraries (3X)

XDrText(3X)

draw polytext text

From the original Amiga UNIX 2.1 manual. Some things it mentions may not be in this release.

NAME

XDrawText, XDrawText16 - draw polytext text

SYNTAX

XDrawText(display, d, gc, x, y, items, nitems)
      Display *display;
      Drawable d;
      GC gc;
      int x, y;
      XTextItem *items;
      int nitems;

XDrawText16(display, d, gc, x, y, items, nitems)
      Display *display;
      Drawable d;
      GC gc;
      int x, y;
      XTextItem16 *items;
      int nitems;

ARGUMENTS

d         Specifies the drawable.

display   Specifies the connection to the XWIN server.

gc        Specifies the GC.

items     Specifies a pointer to an array of text items.

nitems    Specifies the number of text items in the array.
x
y         Specify the x and y coordinates, which are rela-
          tive to the origin of the specified drawable and
          define the origin of the first character.

DESCRIPTION

The XDrawText16 function is similar to XDrawText except that it uses 2-byte or 16-bit characters. Both functions allow complex spacing and font shifts between counted strings.

     Each text item is processed in turn.  A font member other
     than None in an item causes the font to be stored in the GC
     and used for subsequent text. A text element delta specifies
     an additional change in the position along the x axis before
     the string is drawn. The delta is always added to the char-
     acter origin and is not dependent on any characteristics of
     the font.  Each character image, as defined by the font in
     the GC, is treated as an additional mask for a fill opera-
     tion on the drawable.  The drawable is modified only where
     the font character has a bit set to 1.  If a text item gen-
     erates a BadFont error, the previous text items may have

XWIN 3.0               Last change: 9/1/88                 .ie t

been drawn.

For fonts defined with linear indexing rather than 2-byte
matrix indexing, each XChar2b structure is interpreted as a
16-bit number with byte1 as the most-significant byte.

Both functions use these GC components:  function, plane-
mask, fill-style, font, subwindow-mode, clip-x-origin,
clip-y-origin, and clip-mask.  They also use these GC mode-
dependent components: foreground, background, tile, stipple,
tile-stipple-x-origin, and tile-stipple-y-origin.

XDrawText and XDrawText16 can generate BadDrawable, BadFont,
BadGC, and BadMatch errors.

DIAGNOSTICS

BadDrawable
          A value for a Drawable argument does not name a
          defined Window or Pixmap.

BadFont A value for a Font or GContext argument does not name a defined Font.