diff options
author | marha <marha@users.sourceforge.net> | 2012-08-27 08:17:50 +0200 |
---|---|---|
committer | marha <marha@users.sourceforge.net> | 2012-08-27 08:17:50 +0200 |
commit | b3462c12542a69eeaa3fe90fddfbb15d30c18158 (patch) | |
tree | 294230cca0e59ee250cd70060ba3f8c3742b4023 /libX11/man/XmbTextPerCharExtents.man | |
parent | e91ed68959d63f79e3b4973bc80c7ebcd07ed021 (diff) | |
download | vcxsrv-b3462c12542a69eeaa3fe90fddfbb15d30c18158.tar.gz vcxsrv-b3462c12542a69eeaa3fe90fddfbb15d30c18158.tar.bz2 vcxsrv-b3462c12542a69eeaa3fe90fddfbb15d30c18158.zip |
xwininfo fontconfig libX11 libXau libXext libxcb mesa pixman
xkeyboard-config git update 27 Aug 2012
Diffstat (limited to 'libX11/man/XmbTextPerCharExtents.man')
-rw-r--r-- | libX11/man/XmbTextPerCharExtents.man | 451 |
1 files changed, 195 insertions, 256 deletions
diff --git a/libX11/man/XmbTextPerCharExtents.man b/libX11/man/XmbTextPerCharExtents.man index 7d96a2399..eceaf6aed 100644 --- a/libX11/man/XmbTextPerCharExtents.man +++ b/libX11/man/XmbTextPerCharExtents.man @@ -1,256 +1,195 @@ -.\" Copyright \(co 1985, 1986, 1987, 1988, 1989, 1990, 1991, 1994, 1996 X Consortium
-.\" Copyright \(co 2000 The XFree86 Project, Inc.
-.\"
-.\" 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.
-.\"
-.\"
-.ds xT X Toolkit Intrinsics \- C Language Interface
-.ds xW Athena X Widgets \- C Language X Toolkit Interface
-.ds xL Xlib \- C Language X Interface
-.ds xC Inter-Client Communication Conventions Manual
-.na
-.de Ds
-.nf
-.\\$1D \\$2 \\$1
-.ft 1
-.\".ps \\n(PS
-.\".if \\n(VS>=40 .vs \\n(VSu
-.\".if \\n(VS<=39 .vs \\n(VSp
-..
-.de De
-.ce 0
-.if \\n(BD .DF
-.nr BD 0
-.in \\n(OIu
-.if \\n(TM .ls 2
-.sp \\n(DDu
-.fi
-..
-.de FD
-.LP
-.KS
-.TA .5i 3i
-.ta .5i 3i
-.nf
-..
-.de FN
-.fi
-.KE
-.LP
-..
-.de IN \" send an index entry to the stderr
-..
-.de C{
-.KS
-.nf
-.D
-.\"
-.\" choose appropriate monospace font
-.\" the imagen conditional, 480,
-.\" may be changed to L if LB is too
-.\" heavy for your eyes...
-.\"
-.ie "\\*(.T"480" .ft L
-.el .ie "\\*(.T"300" .ft L
-.el .ie "\\*(.T"202" .ft PO
-.el .ie "\\*(.T"aps" .ft CW
-.el .ft R
-.ps \\n(PS
-.ie \\n(VS>40 .vs \\n(VSu
-.el .vs \\n(VSp
-..
-.de C}
-.DE
-.R
-..
-.de Pn
-.ie t \\$1\fB\^\\$2\^\fR\\$3
-.el \\$1\fI\^\\$2\^\fP\\$3
-..
-.de ZN
-.ie t \fB\^\\$1\^\fR\\$2
-.el \fI\^\\$1\^\fP\\$2
-..
-.de hN
-.ie t <\fB\\$1\fR>\\$2
-.el <\fI\\$1\fP>\\$2
-..
-.de NT
-.ne 7
-.ds NO Note
-.if \\n(.$>$1 .if !'\\$2'C' .ds NO \\$2
-.if \\n(.$ .if !'\\$1'C' .ds NO \\$1
-.ie n .sp
-.el .sp 10p
-.TB
-.ce
-\\*(NO
-.ie n .sp
-.el .sp 5p
-.if '\\$1'C' .ce 99
-.if '\\$2'C' .ce 99
-.in +5n
-.ll -5n
-.R
-..
-. \" Note End -- doug kraft 3/85
-.de NE
-.ce 0
-.in -5n
-.ll +5n
-.ie n .sp
-.el .sp 10p
-..
-.ny0
-.TH XmbTextPerCharExtents __libmansuffix__ __xorgversion__ "XLIB FUNCTIONS"
-.SH NAME
-XmbTextPerCharExtents, XwcTextPerCharExtents, Xutf8TextPerCharExtents \- obtain per-character information for a text string
-.SH SYNTAX
-.HP
-Status XmbTextPerCharExtents\^(\^XFontSet \fIfont_set\fP\^, char
-*\fIstring\fP\^, int \fInum_bytes\fP\^, XRectangle *\fIink_array_return\fP\^,
-XRectangle *\fIlogical_array_return\fP\^, int \fIarray_size\fP\^, int
-*\fInum_chars_return\fP\^, XRectangle *\fIoverall_ink_return\fP\^, XRectangle
-*\fIoverall_logical_return\fP\^);
-.HP
-Status XwcTextPerCharExtents\^(\^XFontSet \fIfont_set\fP\^, wchar_t
-*\fIstring\fP\^, int \fInum_wchars\fP\^, XRectangle
-*\fIink_array_return\fP\^, XRectangle *\fIlogical_array_return\fP, int
-\fIarray_size\fP\^, int *\fInum_chars_return\fP\^, XRectangle
-*\fIoverall_ink_return\fP\^, XRectangle *\fIoverall_logical_return\fP\^);
-.HP
-Status Xutf8TextPerCharExtents\^(\^XFontSet \fIfont_set\fP\^, char
-*\fIstring\fP\^, int \fInum_bytes\fP\^, XRectangle *\fIink_array_return\fP\^,
-XRectangle *\fIlogical_array_return\fP\^, int \fIarray_size\fP\^, int
-*\fInum_chars_return\fP\^, XRectangle *\fIoverall_ink_return\fP\^, XRectangle
-*\fIoverall_logical_return\fP\^);
-.SH ARGUMENTS
-.IP \fIarray_size\fP 1i
-Specifies the size of ink_array_return and logical_array_return.
-The caller must pass in arrays of this size.
-.IP \fIfont_set\fP 1i
-Specifies the font set.
-.IP \fIink_array_return\fP 1i
-Returns the ink dimensions for each character.
-.IP \fIlogical_array_return\fP 1i
-Returns the logical dimensions for each character.
-.IP \fInum_bytes\fP 1i
-Specifies the number of bytes in the string argument.
-.IP \fInum_chars_return\fP 1i
-Returns the number of characters in the string argument.
-.IP \fInum_wchars\fP 1i
-Specifies the number of characters in the string argument.
-.ds Ov extents of the entire string
-.IP \fIoverall_ink_return\fP 1i
-Returns the overall ink \*(Ov.
-.IP \fIoverall_logical_return\fP 1i
-Returns the overall logical \*(Ov.
-.IP \fIstring\fP 1i
-Specifies the character string.
-.SH DESCRIPTION
-The
-.ZN XmbTextPerCharExtents ,
-.ZN XwcTextPerCharExtents
-and
-.ZN Xutf8TextPerCharExtents
-functions return the text dimensions of each character of the specified text,
-using the fonts loaded for the specified font set.
-Each successive element of ink_array_return and logical_array_return
-is set to the successive character's drawn metrics,
-relative to the drawing origin of the string and one
-rectangle
-for each character in the supplied text string.
-The number of elements of ink_array_return and logical_array_return
-that have been set is returned to num_chars_return.
-.LP
-Each element of ink_array_return is set to the bounding box
-of the corresponding character's drawn foreground color.
-Each element of logical_array_return is set to the bounding box
-that provides minimum spacing to other graphical features
-for the corresponding character.
-Other graphical features should not intersect any of the
-logical_array_return rectangles.
-.LP
-Note that an
-.ZN XRectangle
-represents the effective drawing dimensions of the character,
-regardless of the number of font glyphs that are used to draw
-the character or the direction in which the character is drawn.
-If multiple characters map to a single character glyph,
-the dimensions of all the
-.ZN XRectangles
-of those characters are the same.
-.LP
-When the
-.ZN XFontSet
-has missing charsets, metrics for each unavailable
-character are taken from the default string returned by
-.ZN XCreateFontSet
-so that the metrics represent the text as it will actually be drawn.
-The behavior for an invalid codepoint is undefined.
-.LP
-If the array_size is too small for the number of characters in the
-supplied text, the functions return zero
-and num_chars_return is set to the number of rectangles required.
-Otherwise, the functions return a nonzero value.
-.LP
-If the overall_ink_return or overall_logical_return argument is non-NULL,
-.ZN XmbTextPerCharExtents ,
-.ZN XwcTextPerCharExtents
-and
-.ZN Xutf8TextPerCharExtents
-return the maximum extent of the string's metrics to overall_ink_return
-or overall_logical_return, as returned by
-.ZN XmbTextExtents ,
-.ZN XwcTextExtents
-or
-.ZN Xutf8TextExtents .
-.LP
-The function
-.ZN Xutf8TextPerCharExtents
-is an extension introduced by The XFree86 Project, Inc. in their 4.0.2
-release. Its presence is
-indicated by the macro
-.ZN X_HAVE_UTF8_STRING .
-.SH "SEE ALSO"
-XmbTextEscapement(__libmansuffix__),
-XmbTextExtents(__libmansuffix__)
-\fI\*(xL\fP
+.\" Copyright \(co 1985, 1986, 1987, 1988, 1989, 1990, 1991, 1994, 1996 X Consortium +.\" Copyright \(co 2000 The XFree86 Project, Inc. +.\" +.\" 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. +.\" +.\" +.ds xT X Toolkit Intrinsics \- C Language Interface +.ds xW Athena X Widgets \- C Language X Toolkit Interface +.ds xL Xlib \- C Language X Interface +.ds xC Inter-Client Communication Conventions Manual +.na +.de Ds +.nf +.\\$1D \\$2 \\$1 +.ft CW +.\".ps \\n(PS +.\".if \\n(VS>=40 .vs \\n(VSu +.\".if \\n(VS<=39 .vs \\n(VSp +.. +.de De +.ce 0 +.if \\n(BD .DF +.nr BD 0 +.in \\n(OIu +.if \\n(TM .ls 2 +.sp \\n(DDu +.fi +.. +.de IN \" send an index entry to the stderr +.. +.de Pn +.ie t \\$1\fB\^\\$2\^\fR\\$3 +.el \\$1\fI\^\\$2\^\fP\\$3 +.. +.de ZN +.ie t \fB\^\\$1\^\fR\\$2 +.el \fI\^\\$1\^\fP\\$2 +.. +.de hN +.ie t <\fB\\$1\fR>\\$2 +.el <\fI\\$1\fP>\\$2 +.. +.ny0 +.TH XmbTextPerCharExtents __libmansuffix__ __xorgversion__ "XLIB FUNCTIONS" +.SH NAME +XmbTextPerCharExtents, XwcTextPerCharExtents, Xutf8TextPerCharExtents \- obtain per-character information for a text string +.SH SYNTAX +.HP +Status XmbTextPerCharExtents\^(\^XFontSet \fIfont_set\fP\^, char +*\fIstring\fP\^, int \fInum_bytes\fP\^, XRectangle *\fIink_array_return\fP\^, +XRectangle *\fIlogical_array_return\fP\^, int \fIarray_size\fP\^, int +*\fInum_chars_return\fP\^, XRectangle *\fIoverall_ink_return\fP\^, XRectangle +*\fIoverall_logical_return\fP\^); +.HP +Status XwcTextPerCharExtents\^(\^XFontSet \fIfont_set\fP\^, wchar_t +*\fIstring\fP\^, int \fInum_wchars\fP\^, XRectangle +*\fIink_array_return\fP\^, XRectangle *\fIlogical_array_return\fP, int +\fIarray_size\fP\^, int *\fInum_chars_return\fP\^, XRectangle +*\fIoverall_ink_return\fP\^, XRectangle *\fIoverall_logical_return\fP\^); +.HP +Status Xutf8TextPerCharExtents\^(\^XFontSet \fIfont_set\fP\^, char +*\fIstring\fP\^, int \fInum_bytes\fP\^, XRectangle *\fIink_array_return\fP\^, +XRectangle *\fIlogical_array_return\fP\^, int \fIarray_size\fP\^, int +*\fInum_chars_return\fP\^, XRectangle *\fIoverall_ink_return\fP\^, XRectangle +*\fIoverall_logical_return\fP\^); +.SH ARGUMENTS +.IP \fIarray_size\fP 1i +Specifies the size of ink_array_return and logical_array_return. +The caller must pass in arrays of this size. +.IP \fIfont_set\fP 1i +Specifies the font set. +.IP \fIink_array_return\fP 1i +Returns the ink dimensions for each character. +.IP \fIlogical_array_return\fP 1i +Returns the logical dimensions for each character. +.IP \fInum_bytes\fP 1i +Specifies the number of bytes in the string argument. +.IP \fInum_chars_return\fP 1i +Returns the number of characters in the string argument. +.IP \fInum_wchars\fP 1i +Specifies the number of characters in the string argument. +.ds Ov extents of the entire string +.IP \fIoverall_ink_return\fP 1i +Returns the overall ink \*(Ov. +.IP \fIoverall_logical_return\fP 1i +Returns the overall logical \*(Ov. +.IP \fIstring\fP 1i +Specifies the character string. +.SH DESCRIPTION +The +.ZN XmbTextPerCharExtents , +.ZN XwcTextPerCharExtents +and +.ZN Xutf8TextPerCharExtents +functions return the text dimensions of each character of the specified text, +using the fonts loaded for the specified font set. +Each successive element of ink_array_return and logical_array_return +is set to the successive character's drawn metrics, +relative to the drawing origin of the string and one +rectangle +for each character in the supplied text string. +The number of elements of ink_array_return and logical_array_return +that have been set is returned to num_chars_return. +.LP +Each element of ink_array_return is set to the bounding box +of the corresponding character's drawn foreground color. +Each element of logical_array_return is set to the bounding box +that provides minimum spacing to other graphical features +for the corresponding character. +Other graphical features should not intersect any of the +logical_array_return rectangles. +.LP +Note that an +.ZN XRectangle +represents the effective drawing dimensions of the character, +regardless of the number of font glyphs that are used to draw +the character or the direction in which the character is drawn. +If multiple characters map to a single character glyph, +the dimensions of all the +.ZN XRectangles +of those characters are the same. +.LP +When the +.ZN XFontSet +has missing charsets, metrics for each unavailable +character are taken from the default string returned by +.ZN XCreateFontSet +so that the metrics represent the text as it will actually be drawn. +The behavior for an invalid codepoint is undefined. +.LP +If the array_size is too small for the number of characters in the +supplied text, the functions return zero +and num_chars_return is set to the number of rectangles required. +Otherwise, the functions return a nonzero value. +.LP +If the overall_ink_return or overall_logical_return argument is non-NULL, +.ZN XmbTextPerCharExtents , +.ZN XwcTextPerCharExtents +and +.ZN Xutf8TextPerCharExtents +return the maximum extent of the string's metrics to overall_ink_return +or overall_logical_return, as returned by +.ZN XmbTextExtents , +.ZN XwcTextExtents +or +.ZN Xutf8TextExtents . +.LP +The function +.ZN Xutf8TextPerCharExtents +is an extension introduced by The XFree86 Project, Inc. in their 4.0.2 +release. Its presence is +indicated by the macro +.ZN X_HAVE_UTF8_STRING . +.SH "SEE ALSO" +XmbTextEscapement(__libmansuffix__), +XmbTextExtents(__libmansuffix__) +\fI\*(xL\fP |