diff options
Diffstat (limited to 'lib/libX11/man/XmbTextExtents.man')
| -rw-r--r-- | lib/libX11/man/XmbTextExtents.man | 79 |
1 files changed, 23 insertions, 56 deletions
diff --git a/lib/libX11/man/XmbTextExtents.man b/lib/libX11/man/XmbTextExtents.man index 8ede8fc09..01ae8e581 100644 --- a/lib/libX11/man/XmbTextExtents.man +++ b/lib/libX11/man/XmbTextExtents.man @@ -39,46 +39,13 @@ .\" 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. +.\" 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 XmbTextExtents __libmansuffix__ __xorgversion__ "XLIB FUNCTIONS" .SH NAME XmbTextExtents, XwcTextExtents, Xutf8TextExtents \- compute text extents @@ -86,11 +53,11 @@ XmbTextExtents, XwcTextExtents, Xutf8TextExtents \- compute text extents .HP int XmbTextExtents\^(\^XFontSet \fIfont_set\fP\^, char *\fIstring\fP\^, int \fInum_bytes\fP\^, XRectangle *\fIoverall_ink_return\fP\^, XRectangle -*\fIoverall_logical_return\fP\^); +*\fIoverall_logical_return\fP\^); .HP int XwcTextExtents\^(\^XFontSet \fIfont_set\fP\^, wchar_t *\fIstring\fP\^, int \fInum_wchars\fP\^, XRectangle *\fIoverall_ink_return\fP\^, XRectangle -*\fIoverall_logical_return\fP\^); +*\fIoverall_logical_return\fP\^); .HP int Xutf8TextExtents\^(\^XFontSet \fIfont_set\fP\^, char *\fIstring\fP\^, int \fInum_bytes\fP\^, XRectangle *\fIoverall_ink_return\fP\^, XRectangle @@ -102,28 +69,27 @@ Specifies the font set. Specifies the number of bytes in the string argument. .IP \fInum_wchars\fP 1i Specifies the number of characters in the string argument. -.ds Ov dimensions .IP \fIoverall_ink_return\fP 1i -Returns the overall ink \*(Ov. +Returns the overall ink dimensions. .IP \fIoverall_logical_return\fP 1i -Returns the overall logical \*(Ov. +Returns the overall logical dimensions. .IP \fIstring\fP 1i Specifies the character string. .SH DESCRIPTION The -.ZN XmbTextExtents , -.ZN XwcTextExtents +.BR XmbTextExtents , +.B XwcTextExtents and -.ZN Xutf8TextExtents +.B Xutf8TextExtents functions set the components of the specified overall_ink_return and overall_logical_return arguments to the overall bounding box of the string's image and a logical bounding box for spacing purposes, respectively. -They return the value returned by -.ZN XmbTextEscapement , -.ZN XwcTextEscapement +They return the value returned by +.BR XmbTextEscapement , +.B XwcTextEscapement or -.ZN Xutf8TextEscapement . +.BR Xutf8TextEscapement . These metrics are relative to the drawing origin of the string, using the fonts loaded for the specified font set. .LP @@ -144,21 +110,22 @@ to other graphical features for the string. Other graphical features, for example, a border surrounding the text, should not intersect this rectangle. .LP -When the -.ZN XFontSet +When the +.B XFontSet has missing charsets, -metrics for each unavailable character are taken -from the default string returned by -.ZN XCreateFontSet +metrics for each unavailable character are taken +from the default string returned by +.B XCreateFontSet so that the metrics represent the text as it will actually be drawn. The behavior for an invalid codepoint is undefined. .LP The function -.ZN Xutf8TextExtents -is an extension introduced by The XFree86 Project, Inc. in their 4.0.2 -release. Its presence is +.B Xutf8TextExtents +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 . +.BR X_HAVE_UTF8_STRING . .SH "SEE ALSO" XmbTextEscapement(__libmansuffix__), XmbTextPerCharExtents(__libmansuffix__) |