← Back to branch summary

~ubuntu-branches/ubuntu/gutsy/vnc4/gutsy

« back to all changes in this revision

Viewing changes to unix/xc/doc/man/X11/XTextExt.man

  • Committer: Bazaar Package Importer
  • Author(s): Ola Lundqvist
  • Date: 2006-05-15 20:35:17 UTC
  • mfrom: (1.1.2 upstream)
  • Revision ID: james.westby@ubuntu.com-20060515203517-l4lre1ku942mn26k
Tags: 4.1.1+X4.3.0-10
* Correction of critical security issue. Thanks to Martin Kogler
  <e9925248@student.tuwien.ac.at> that informed me about the issue,
  and provided the patch.
  This flaw was originally found by Steve Wiseman of intelliadmin.com.
* Applied patch from Javier Kohen <jkohen@users.sourceforge.net> that
  inform the user that only 8 first characters of the password will
  actually be used when typing more than 8 characters, closes:
  #355619.

Show diffs side-by-side

added added

removed removed

Lines of Context:
unix/xc/doc/man/X11/XTextExt.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
.\" $XFree86: xc/doc/man/X11/XTextExt.man,v 1.3 2001/02/09 03:47:47 tsi Exp $
 
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 XTextExtents 3X11 __xorgversion__ "XLIB FUNCTIONS"
 
144
.SH NAME
 
145
XTextExtents, XTextExtents16, XQueryTextExtents, XQueryTextExtents16 \- compute or query text extents
 
146
.SH SYNTAX
 
147
XTextExtents\^(\^\fIfont_struct\fP\^, \fIstring\fP\^, \fInchars\fP\^,
 
148
\fIdirection_return\fP, \fIfont_ascent_return\fP,
 
149
.br
 
150
              \fIfont_descent_return\fP, \fIoverall_return\fP\^)
 
151
.br
 
152
      XFontStruct *\fIfont_struct\fP\^;
 
153
.br
 
154
      char *\fIstring\fP\^;
 
155
.br
 
156
      int \fInchars\fP\^;
 
157
.br
 
158
      int *\fIdirection_return\fP\^;
 
159
.br
 
160
      int *\fIfont_ascent_return\fP, *\fIfont_descent_return\fP\^;
 
161
.br
 
162
      XCharStruct *\fIoverall_return\fP\^;
 
163
 
 
164
.LP
 
165
XTextExtents16\^(\^\fIfont_struct\fP\^, \fIstring\fP\^, \fInchars\fP\^,
 
166
\fIdirection_return\fP, \fIfont_ascent_return\fP, 
 
167
.br
 
168
                \fIfont_descent_return\fP, \fIoverall_return\fP\^)
 
169
.br
 
170
      XFontStruct *\fIfont_struct\fP\^;
 
171
.br
 
172
      XChar2b *\fIstring\fP\^;
 
173
.br
 
174
      int \fInchars\fP\^;
 
175
.br
 
176
      int *\fIdirection_return\fP\^;
 
177
.br
 
178
      int *\fIfont_ascent_return\fP, *\fIfont_descent_return\fP\^;
 
179
.br
 
180
      XCharStruct *\fIoverall_return\fP\^;
 
181
 
 
182
.LP
 
183
XQueryTextExtents\^(\^\fIdisplay\fP, \fIfont_ID\fP, \fIstring\fP,
 
184
\fInchars\fP, \fIdirection_return\fP, \fIfont_ascent_return\fP, 
 
185
.br
 
186
                    \fIfont_descent_return\fP, \fIoverall_return\fP\^)
 
187
.br
 
188
      Display *\fIdisplay\fP\^;
 
189
.br
 
190
      XID \fIfont_ID\fP\^;
 
191
.br
 
192
      char *\fIstring\fP\^;
 
193
.br
 
194
      int \fInchars\fP\^;
 
195
.br
 
196
      int *\fIdirection_return\fP\^;
 
197
.br
 
198
      int *\fIfont_ascent_return\fP, *\fIfont_descent_return\fP\^;
 
199
.br
 
200
      XCharStruct *\fIoverall_return\fP\^;
 
201
.LP
 
202
XQueryTextExtents16\^(\^\fIdisplay\fP, \fIfont_ID\fP, \fIstring\fP,
 
203
\fInchars\fP, \fIdirection_return\fP, \fIfont_ascent_return\fP, 
 
204
.br
 
205
                        \fIfont_descent_return\fP, \fIoverall_return\fP\^)
 
206
.br
 
207
      Display *\fIdisplay\fP\^;
 
208
.br
 
209
      XID \fIfont_ID\fP\^;
 
210
.br
 
211
      XChar2b *\fIstring\fP\^;
 
212
.br
 
213
      int \fInchars\fP\^;
 
214
.br
 
215
      int *\fIdirection_return\fP\^;
 
216
.br
 
217
      int *\fIfont_ascent_return\fP, *\fIfont_descent_return\fP\^;
 
218
.br
 
219
      XCharStruct *\fIoverall_return\fP\^;
 
220
.SH ARGUMENTS
 
221
.IP \fIdirection_return\fP 1i
 
222
Returns the value of the direction hint
 
223
.Pn ( FontLeftToRight
 
224
or
 
225
.ZN FontRightToLeft ).
 
226
.IP \fIdisplay\fP 1i
 
227
Specifies the connection to the X server.
 
228
.IP \fIfont_ID\fP 1i
 
229
Specifies either the font ID or the 
 
230
.ZN GContext
 
231
ID that contains the font.
 
232
.IP \fIfont_ascent_return\fP 1i
 
233
Returns the font ascent.
 
234
.IP \fIfont_descent_return\fP 1i
 
235
Returns the font descent.
 
236
.IP \fIfont_struct\fP 1i
 
237
Specifies the 
 
238
.ZN XFontStruct 
 
239
structure.
 
240
.IP \fInchars\fP 1i
 
241
Specifies the number of characters in the character string.
 
242
.IP \fIstring\fP 1i
 
243
Specifies the character string.
 
244
.IP \fIoverall_return\fP 1i
 
245
Returns the overall size in the specified
 
246
.ZN XCharStruct 
 
247
structure.
 
248
.SH DESCRIPTION
 
249
The
 
250
.ZN XTextExtents
 
251
and
 
252
.ZN XTextExtents16
 
253
functions 
 
254
perform the size computation locally and, thereby,
 
255
avoid the round-trip overhead of
 
256
.ZN XQueryTextExtents 
 
257
and
 
258
.ZN XQueryTextExtents16 .
 
259
Both functions return an
 
260
.ZN XCharStruct
 
261
structure, whose members are set to the values as follows.
 
262
.LP
 
263
The ascent member is set to the maximum of the ascent metrics of all
 
264
characters in the string.
 
265
The descent member is set to the maximum of the descent metrics.
 
266
The width member is set to the sum of the character-width metrics of all
 
267
characters in the string.
 
268
For each character in the string,
 
269
let W be the sum of the character-width metrics of all characters preceding 
 
270
it in the string.
 
271
Let L be the left-side-bearing metric of the character plus W.
 
272
Let R be the right-side-bearing metric of the character plus W.
 
273
The lbearing member is set to the minimum L of all characters in the string.
 
274
The rbearing member is set to the maximum R.
 
275
.LP
 
276
For fonts defined with linear indexing rather than 2-byte matrix indexing,
 
277
each 
 
278
.ZN XChar2b 
 
279
structure is interpreted as a 16-bit number with byte1 as the 
 
280
most significant byte.
 
281
If the font has no defined default character,
 
282
undefined characters in the string are taken to have all zero metrics.
 
283
.LP
 
284
The
 
285
.ZN XQueryTextExtents
 
286
and
 
287
.ZN XQueryTextExtents16
 
288
functions return the bounding box of the specified 8-bit and 16-bit
 
289
character string in the specified font or the font contained in the
 
290
specified GC.
 
291
These functions query the X server and, therefore, suffer the round-trip
 
292
overhead that is avoided by
 
293
.ZN XTextExtents
 
294
and 
 
295
.ZN XTextExtents16 .
 
296
Both functions return a
 
297
.ZN XCharStruct 
 
298
structure, whose members are set to the values as follows.
 
299
.LP
 
300
The ascent member is set to the maximum of the ascent metrics 
 
301
of all characters in the string.
 
302
The descent member is set to the maximum of the descent metrics.
 
303
The width member is set to the sum of the character-width metrics 
 
304
of all characters in the string.
 
305
For each character in the string,
 
306
let W be the sum of the character-width metrics of all characters preceding
 
307
it in the string.
 
308
Let L be the left-side-bearing metric of the character plus W.
 
309
Let R be the right-side-bearing metric of the character plus W.
 
310
The lbearing member is set to the minimum L of all characters in the string.
 
311
The rbearing member is set to the maximum R.
 
312
.LP
 
313
For fonts defined with linear indexing rather than 2-byte matrix indexing,
 
314
each 
 
315
.ZN XChar2b 
 
316
structure is interpreted as a 16-bit number with byte1 as the 
 
317
most significant byte.
 
318
If the font has no defined default character,
 
319
undefined characters in the string are taken to have all zero metrics.
 
320
.LP
 
321
Characters with all zero metrics are ignored.
 
322
If the font has no defined default_char,
 
323
the undefined characters in the string are also ignored.
 
324
.LP
 
325
.ZN XQueryTextExtents
 
326
and
 
327
.ZN XQueryTextExtents16
 
328
can generate
 
329
.ZN BadFont
 
330
and
 
331
.ZN BadGC 
 
332
errors.
 
333
.SH DIAGNOSTICS
 
334
.TP 1i
 
335
.ZN BadFont
 
336
A value for a Font or GContext argument does not name a defined Font.
 
337
.TP 1i
 
338
.ZN BadGC
 
339
A value for a GContext argument does not name a defined GContext.
 
340
.SH "SEE ALSO"
 
341
XLoadFont(3X11),
 
342
XTextWidth(3X11)
 
343
.br
 
344
\fI\*(xL\fP