Copyright \(co 1985, 1986, 1987, 1988, 1989, 1990, 1991, 1994, 1996 X Consortium

Permission is hereby granted, free of charge, to any person obtaining
a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including
without limitation the rights to use, copy, modify, merge, publish,
distribute, sublicense, and/or sell copies of the Software, and to
permit persons to whom the Software is furnished to do so, subject to
the following conditions:

The above copyright notice and this permission notice shall be included
in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
IN NO EVENT SHALL THE X CONSORTIUM BE LIABLE FOR ANY CLAIM, DAMAGES OR
OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
OTHER DEALINGS IN THE SOFTWARE.

Except as contained in this notice, the name of the X Consortium shall
not be used in advertising or otherwise to promote the sale, use or
other dealings in this Software without prior written authorization
from the X Consortium.

Copyright \(co 1985, 1986, 1987, 1988, 1989, 1990, 1991 by
Digital Equipment Corporation

Portions Copyright \(co 1990, 1991 by
Tektronix, Inc.

Permission to use, copy, modify and distribute this documentation for
any purpose and without fee is hereby granted, provided that the above
copyright notice appears in all copies and that both that copyright notice
and this permission notice appear in all copies, and that the names of
Digital and Tektronix not be used in in advertising or publicity pertaining
to this documentation without specific, written prior permission.
Digital and Tektronix makes no representations about the suitability
of this documentation for any purpose.
It is provided "as is" without express or implied warranty.


XDrawImageString, XDrawImageString16 - draw image text

int XDrawImageString\^(\^Display *display\^, Drawable d\^, GC gc\^, int x\^, int y\^, _Xconst char *string\^, int length\^);

int XDrawImageString16\^(\^Display *display\^, Drawable d\^, GC gc\^, int x\^, int y\^, _Xconst XChar2b *string\^, int length\^);

Specifies the drawable. Specifies the connection to the X server. Specifies the GC. Specifies the number of characters in the string argument. Specifies the character string.

.ns

Specify the x and y coordinates, which are relative to the origin of the specified drawable and define the origin of the first character. The XDrawImageString16 function is similar to XDrawImageString except that it uses 2-byte or 16-bit characters. Both functions also use both the foreground and background pixels of the GC in the destination.

The effect is first to fill a destination rectangle with the background pixel defined in the GC and then to paint the text with the foreground pixel. The upper-left corner of the filled rectangle is at:

.EX [x, y - font-ascent]

The width is:

.EX overall-width

The height is:

.EX font-ascent + font-descent

The overall-width, font-ascent, and font-descent are as would be returned by XQueryTextExtents using gc and string. The function and fill-style defined in the GC are ignored for these functions. The effective function is GXcopy , and the effective fill-style is FillSolid .

For fonts defined with 2-byte matrix indexing and used with XDrawImageString , each byte is used as a byte2 with a byte1 of zero.

Both functions use these GC components: plane-mask, foreground, background, font, subwindow-mode, clip-x-origin, clip-y-origin, and clip-mask.

XDrawImageString and XDrawImageString16 can generate BadDrawable , BadGC , and BadMatch errors.

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

1i BadGC A value for a GContext argument does not name a defined GContext.

1i BadMatch An InputOnly window is used as a Drawable.

1i BadMatch Some argument or pair of arguments has the correct type and range but fails to match in some other way required by the request.

Unlike XDrawString and XDrawString16, these functions send no more than 255 characters at a time to the server. When the total number of characters to be sent is larger than 255, these functions split the string into chunks up to 255 characters. After sending each chunk, these functions query the server to determine the actual text extent. XDrawString(__libmansuffix__), XDrawText(__libmansuffix__), XLoadFont(__libmansuffix__), XTextExtents(__libmansuffix__)

\*(xL