man/XDrawImageString.man

   1 .\" Copyright \(co 1985, 1986, 1987, 1988, 1989, 1990, 1991, 1994, 1996 X Consortium
   2 .\"
   3 .\" Permission is hereby granted, free of charge, to any person obtaining
   4 .\" a copy of this software and associated documentation files (the
   5 .\" "Software"), to deal in the Software without restriction, including
   6 .\" without limitation the rights to use, copy, modify, merge, publish,
   7 .\" distribute, sublicense, and/or sell copies of the Software, and to
   8 .\" permit persons to whom the Software is furnished to do so, subject to
   9 .\" the following conditions:
  10 .\"
  11 .\" The above copyright notice and this permission notice shall be included
  12 .\" in all copies or substantial portions of the Software.
  13 .\"
  14 .\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
  15 .\" OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  16 .\" MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
  17 .\" IN NO EVENT SHALL THE X CONSORTIUM BE LIABLE FOR ANY CLAIM, DAMAGES OR
  18 .\" OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
  19 .\" ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
  20 .\" OTHER DEALINGS IN THE SOFTWARE.
  21 .\"
  22 .\" Except as contained in this notice, the name of the X Consortium shall
  23 .\" not be used in advertising or otherwise to promote the sale, use or
  24 .\" other dealings in this Software without prior written authorization
  25 .\" from the X Consortium.
  26 .\"
  27 .\" Copyright \(co 1985, 1986, 1987, 1988, 1989, 1990, 1991 by
  28 .\" Digital Equipment Corporation
  29 .\"
  30 .\" Portions Copyright \(co 1990, 1991 by
  31 .\" Tektronix, Inc.
  32 .\"
  33 .\" Permission to use, copy, modify and distribute this documentation for
  34 .\" any purpose and without fee is hereby granted, provided that the above
  35 .\" copyright notice appears in all copies and that both that copyright notice
  36 .\" and this permission notice appear in all copies, and that the names of
  37 .\" Digital and Tektronix not be used in in advertising or publicity pertaining
  38 .\" to this documentation without specific, written prior permission.
  39 .\" Digital and Tektronix makes no representations about the suitability
  40 .\" of this documentation for any purpose.
  41 .\" It is provided ``as is'' without express or implied warranty.
  42 .\"
  43 .\"
  44 .ds xT X Toolkit Intrinsics \- C Language Interface
  45 .ds xW Athena X Widgets \- C Language X Toolkit Interface
  46 .ds xL Xlib \- C Language X Interface
  47 .ds xC Inter-Client Communication Conventions Manual
  48 .na
  49 .de Ds
  50 .nf
  51 .\\$1D \\$2 \\$1
  52 .ft 1
  53 .\".ps \\n(PS
  54 .\".if \\n(VS>=40 .vs \\n(VSu
  55 .\".if \\n(VS<=39 .vs \\n(VSp
  56 ..
  57 .de De
  58 .ce 0
  59 .if \\n(BD .DF
  60 .nr BD 0
  61 .in \\n(OIu
  62 .if \\n(TM .ls 2
  63 .sp \\n(DDu
  64 .fi
  65 ..
  66 .de FD
  67 .LP
  68 .KS
  69 .TA .5i 3i
  70 .ta .5i 3i
  71 .nf
  72 ..
  73 .de FN
  74 .fi
  75 .KE
  76 .LP
  77 ..
  78 .de IN          \" send an index entry to the stderr
  79 ..
  80 .de C{
  81 .KS
  82 .nf
  83 .D
  84 .\"
  85 .\"     choose appropriate monospace font
  86 .\"     the imagen conditional, 480,
  87 .\"     may be changed to L if LB is too
  88 .\"     heavy for your eyes...
  89 .\"
  90 .ie "\\*(.T"480" .ft L
  91 .el .ie "\\*(.T"300" .ft L
  92 .el .ie "\\*(.T"202" .ft PO
  93 .el .ie "\\*(.T"aps" .ft CW
  94 .el .ft R
  95 .ps \\n(PS
  96 .ie \\n(VS>40 .vs \\n(VSu
  97 .el .vs \\n(VSp
  98 ..
  99 .de C}
 100 .DE
 101 .R
 102 ..
 103 .de Pn
 104 .ie t \\$1\fB\^\\$2\^\fR\\$3
 105 .el \\$1\fI\^\\$2\^\fP\\$3
 106 ..
 107 .de ZN
 108 .ie t \fB\^\\$1\^\fR\\$2
 109 .el \fI\^\\$1\^\fP\\$2
 110 ..
 111 .de hN
 112 .ie t <\fB\\$1\fR>\\$2
 113 .el <\fI\\$1\fP>\\$2
 114 ..
 115 .de NT
 116 .ne 7
 117 .ds NO Note
 118 .if \\n(.$>$1 .if !'\\$2'C' .ds NO \\$2
 119 .if \\n(.$ .if !'\\$1'C' .ds NO \\$1
 120 .ie n .sp
 121 .el .sp 10p
 122 .TB
 123 .ce
 124 \\*(NO
 125 .ie n .sp
 126 .el .sp 5p
 127 .if '\\$1'C' .ce 99
 128 .if '\\$2'C' .ce 99
 129 .in +5n
 130 .ll -5n
 131 .R
 132 ..
 133 .               \" Note End -- doug kraft 3/85
 134 .de NE
 135 .ce 0
 136 .in -5n
 137 .ll +5n
 138 .ie n .sp
 139 .el .sp 10p
 140 ..
 141 .ny0
 142 .TH XDrawImageString __libmansuffix__ __xorgversion__ "XLIB FUNCTIONS"
 143 .SH NAME
 144 XDrawImageString, XDrawImageString16 \- draw image text
 145 .SH SYNTAX
 146 .HP
 147 int XDrawImageString\^(\^Display *\fIdisplay\fP\^, Drawable \fId\fP\^, GC
 148 \fIgc\fP\^, int \fIx\fP\^, int \fIy\fP\^, char *\fIstring\fP\^, int
 149 \fIlength\fP\^);
 150 .HP
 151 int XDrawImageString16\^(\^Display *\fIdisplay\fP\^, Drawable \fId\fP\^, GC
 152 \fIgc\fP\^, int \fIx\fP\^, int \fIy\fP\^, XChar2b *\fIstring\fP\^, int
 153 \fIlength\fP\^);
 154 .SH ARGUMENTS
 155 .IP \fId\fP 1i
 156 Specifies the drawable.
 157 .IP \fIdisplay\fP 1i
 158 Specifies the connection to the X server.
 159 .IP \fIgc\fP 1i
 160 Specifies the GC.
 161 .IP \fIlength\fP 1i
 162 Specifies the number of characters in the string argument.
 163 .IP \fIstring\fP 1i
 164 Specifies the character string.
 165 .ds Xy , which are relative to the origin of the specified drawable \
 166 and define the origin of the first character
 167 .IP \fIx\fP 1i
 168 .br
 169 .ns
 170 .IP \fIy\fP 1i
 171 Specify the x and y coordinates\*(Xy.
 172 .SH DESCRIPTION
 173 The
 174 .ZN XDrawImageString16
 175 function is similar to
 176 .ZN XDrawImageString
 177 except that it uses 2-byte or 16-bit characters.
 178 Both functions also use both the foreground and background pixels
 179 of the GC in the destination.
 180 .LP
 181 The effect is first to fill a
 182 destination rectangle with the background pixel defined in the GC and then
 183 to paint the text with the foreground pixel.
 184 The upper-left corner of the filled rectangle is at:
 185 .LP
 186 .Ds
 187 [x, y \- font-ascent]
 188 .De
 189 .LP
 190 The width is:
 191 .LP
 192 .Ds
 193 overall-width
 194 .De
 195 .LP
 196 The height is:
 197 .LP
 198 .Ds
 199 font-ascent + font-descent
 200 .De
 201 .LP
 202 The overall-width, font-ascent, and font-descent
 203 are as would be returned by
 204 .ZN XQueryTextExtents
 205 using gc and string.
 206 The function and fill-style defined in the GC are ignored for these functions.
 207 The effective function is
 208 .ZN GXcopy ,
 209 and the effective fill-style is
 210 .ZN FillSolid .
 211 .LP
 212 For fonts defined with 2-byte matrix indexing
 213 and used with
 214 .ZN XDrawImageString ,
 215 each byte is used as a byte2 with a byte1 of zero.
 216 .LP
 217 Both functions use these GC components:
 218 plane-mask, foreground, background, font, subwindow-mode, clip-x-origin,
 219 clip-y-origin, and clip-mask.
 220 .LP
 221 .ZN XDrawImageString
 222 and
 223 .ZN XDrawImageString16
 224 can generate
 225 .ZN BadDrawable ,
 226 .ZN BadGC ,
 227 and
 228 .ZN BadMatch
 229 errors.
 230 .SH DIAGNOSTICS
 231 .TP 1i
 232 .ZN BadDrawable
 233 A value for a Drawable argument does not name a defined Window or Pixmap.
 234 .TP 1i
 235 .ZN BadGC
 236 A value for a GContext argument does not name a defined GContext.
 237 .TP 1i
 238 .ZN BadMatch
 239 An
 240 .ZN InputOnly
 241 window is used as a Drawable.
 242 .TP 1i
 243 .ZN BadMatch
 244 Some argument or pair of arguments has the correct type and range but fails
 245 to match in some other way required by the request.
 246 .SH "SEE ALSO"
 247 XDrawString(__libmansuffix__),
 248 XDrawText(__libmansuffix__),
 249 XLoadFont(__libmansuffix__),
 250 XTextExtents(__libmansuffix__)
 251 .br
 252 \fI\*(xL\fP