man/XmbDrawImageString.man

   1 .\" Copyright \(co 1985, 1986, 1987, 1988, 1989, 1990, 1991, 1994, 1996 X Consortium
   2 .\" Copyright \(co 2000  The XFree86 Project, Inc.
   3 .\"
   4 .\" Permission is hereby granted, free of charge, to any person obtaining
   5 .\" a copy of this software and associated documentation files (the
   6 .\" "Software"), to deal in the Software without restriction, including
   7 .\" without limitation the rights to use, copy, modify, merge, publish,
   8 .\" distribute, sublicense, and/or sell copies of the Software, and to
   9 .\" permit persons to whom the Software is furnished to do so, subject to
  10 .\" the following conditions:
  11 .\"
  12 .\" The above copyright notice and this permission notice shall be included
  13 .\" in all copies or substantial portions of the Software.
  14 .\"
  15 .\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
  16 .\" OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  17 .\" MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
  18 .\" IN NO EVENT SHALL THE X CONSORTIUM BE LIABLE FOR ANY CLAIM, DAMAGES OR
  19 .\" OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
  20 .\" ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
  21 .\" OTHER DEALINGS IN THE SOFTWARE.
  22 .\"
  23 .\" Except as contained in this notice, the name of the X Consortium shall
  24 .\" not be used in advertising or otherwise to promote the sale, use or
  25 .\" other dealings in this Software without prior written authorization
  26 .\" from the X Consortium.
  27 .\"
  28 .\" Copyright \(co 1985, 1986, 1987, 1988, 1989, 1990, 1991 by
  29 .\" Digital Equipment Corporation
  30 .\"
  31 .\" Portions Copyright \(co 1990, 1991 by
  32 .\" Tektronix, Inc.
  33 .\"
  34 .\" Permission to use, copy, modify and distribute this documentation for
  35 .\" any purpose and without fee is hereby granted, provided that the above
  36 .\" copyright notice appears in all copies and that both that copyright notice
  37 .\" and this permission notice appear in all copies, and that the names of
  38 .\" Digital and Tektronix not be used in in advertising or publicity pertaining
  39 .\" to this documentation without specific, written prior permission.
  40 .\" Digital and Tektronix makes no representations about the suitability
  41 .\" of this documentation for any purpose.
  42 .\" It is provided ``as is'' without express or implied warranty.
  43 .\"
  44 .\"
  45 .ds xT X Toolkit Intrinsics \- C Language Interface
  46 .ds xW Athena X Widgets \- C Language X Toolkit Interface
  47 .ds xL Xlib \- C Language X Interface
  48 .ds xC Inter-Client Communication Conventions Manual
  49 .na
  50 .de Ds
  51 .nf
  52 .\\$1D \\$2 \\$1
  53 .ft 1
  54 .\".ps \\n(PS
  55 .\".if \\n(VS>=40 .vs \\n(VSu
  56 .\".if \\n(VS<=39 .vs \\n(VSp
  57 ..
  58 .de De
  59 .ce 0
  60 .if \\n(BD .DF
  61 .nr BD 0
  62 .in \\n(OIu
  63 .if \\n(TM .ls 2
  64 .sp \\n(DDu
  65 .fi
  66 ..
  67 .de FD
  68 .LP
  69 .KS
  70 .TA .5i 3i
  71 .ta .5i 3i
  72 .nf
  73 ..
  74 .de FN
  75 .fi
  76 .KE
  77 .LP
  78 ..
  79 .de IN          \" send an index entry to the stderr
  80 ..
  81 .de C{
  82 .KS
  83 .nf
  84 .D
  85 .\"
  86 .\"     choose appropriate monospace font
  87 .\"     the imagen conditional, 480,
  88 .\"     may be changed to L if LB is too
  89 .\"     heavy for your eyes...
  90 .\"
  91 .ie "\\*(.T"480" .ft L
  92 .el .ie "\\*(.T"300" .ft L
  93 .el .ie "\\*(.T"202" .ft PO
  94 .el .ie "\\*(.T"aps" .ft CW
  95 .el .ft R
  96 .ps \\n(PS
  97 .ie \\n(VS>40 .vs \\n(VSu
  98 .el .vs \\n(VSp
  99 ..
 100 .de C}
 101 .DE
 102 .R
 103 ..
 104 .de Pn
 105 .ie t \\$1\fB\^\\$2\^\fR\\$3
 106 .el \\$1\fI\^\\$2\^\fP\\$3
 107 ..
 108 .de ZN
 109 .ie t \fB\^\\$1\^\fR\\$2
 110 .el \fI\^\\$1\^\fP\\$2
 111 ..
 112 .de hN
 113 .ie t <\fB\\$1\fR>\\$2
 114 .el <\fI\\$1\fP>\\$2
 115 ..
 116 .de NT
 117 .ne 7
 118 .ds NO Note
 119 .if \\n(.$>$1 .if !'\\$2'C' .ds NO \\$2
 120 .if \\n(.$ .if !'\\$1'C' .ds NO \\$1
 121 .ie n .sp
 122 .el .sp 10p
 123 .TB
 124 .ce
 125 \\*(NO
 126 .ie n .sp
 127 .el .sp 5p
 128 .if '\\$1'C' .ce 99
 129 .if '\\$2'C' .ce 99
 130 .in +5n
 131 .ll -5n
 132 .R
 133 ..
 134 .               \" Note End -- doug kraft 3/85
 135 .de NE
 136 .ce 0
 137 .in -5n
 138 .ll +5n
 139 .ie n .sp
 140 .el .sp 10p
 141 ..
 142 .ny0
 143 .TH XmbDrawImageString __libmansuffix__ __xorgversion__ "XLIB FUNCTIONS"
 144 .SH NAME
 145 XmbDrawImageString, XwcDrawImageString, Xutf8DrawImageString \- draw image text using a single font set
 146 .SH SYNTAX
 147 .HP
 148 void XmbDrawImageString\^(\^Display *\fIdisplay\fP\^, Drawable \fId\fP\^,
 149 XFontSet \fIfont_set\fP\^, GC \fIgc\fP\^, int \fIx\fP\^, int \fIy\fP\^, char
 150 *\fIstring\fP\^, int \fInum_bytes\fP\^);
 151 .HP
 152 void XwcDrawImageString\^(\^Display *\fIdisplay\fP\^, Drawable \fId\fP\^,
 153 XFontSet \fIfont_set\fP\^, GC \fIgc\fP\^, int \fIx\fP\^, int \fIy\fP\^,
 154 wchar_t *\fIstring\fP\^, int \fInum_wchars\fP\^);
 155 .HP
 156 void Xutf8DrawImageString\^(\^Display *\fIdisplay\fP\^, Drawable \fId\fP\^,
 157 XFontSet \fIfont_set\fP\^, GC \fIgc\fP\^, int \fIx\fP\^, int \fIy\fP\^, char
 158 *\fIstring\fP\^, int \fInum_bytes\fP\^);
 159 .SH ARGUMENTS
 160 .IP \fId\fP 1i
 161 Specifies the drawable.
 162 .IP \fIdisplay\fP 1i
 163 Specifies the connection to the X server.
 164 .IP \fIfont_set\fP 1i
 165 Specifies the font set.
 166 .IP \fIgc\fP 1i
 167 Specifies the GC.
 168 .IP \fInum_bytes\fP 1i
 169 Specifies the number of bytes in the string argument.
 170 .IP \fInum_wchars\fP 1i
 171 Specifies the number of characters in the string argument.
 172 .IP \fIstring\fP 1i
 173 Specifies the character string.
 174 .ds Xy
 175 .IP \fIx\fP 1i
 176 .br
 177 .ns
 178 .IP \fIy\fP 1i
 179 Specify the x and y coordinates\*(Xy.
 180 .SH DESCRIPTION
 181 The
 182 .ZN XmbDrawImageString ,
 183 .ZN XwcDrawImageString
 184 and
 185 .ZN Xutf8DrawImageString
 186 functions fill a destination rectangle with the background pixel defined
 187 in the GC and then paint the text with the foreground pixel.
 188 The filled rectangle is the rectangle returned to overall_logical_return by
 189 .ZN XmbTextExtents ,
 190 .ZN XwcTextExtents
 191 or
 192 .ZN Xutf8TextExtents
 193 for the same text and
 194 .ZN XFontSet .
 195 .LP
 196 When the
 197 .ZN XFontSet
 198 has missing charsets, each unavailable character is drawn
 199 with the default string returned by
 200 .ZN XCreateFontSet .
 201 The behavior for an invalid codepoint is undefined.
 202 .LP
 203 The function
 204 .ZN Xutf8TextExtents
 205 is an extension introduced by The XFree86 Project, Inc. in their 4.0.2
 206 release. Its presence is
 207 indicated by the macro
 208 .ZN X_HAVE_UTF8_STRING .
 209 .SH "SEE ALSO"
 210 XDrawImageString(__libmansuffix__),
 211 XDrawString(__libmansuffix__),
 212 XDrawText(__libmansuffix__),
 213 XmbDrawString(__libmansuffix__),
 214 XmbDrawText(__libmansuffix__)
 215 .br
 216 \fI\*(xL\fP