summaryrefslogtreecommitdiff
path: root/man/XmbTextExtents.man
diff options
context:
space:
mode:
authorEgbert Eich <eich@freedesktop.org>2004-04-23 18:42:09 +0000
committerEgbert Eich <eich@freedesktop.org>2004-04-23 18:42:09 +0000
commitc6349f43193b74a3c09945f3093a871b0157ba47 (patch)
treeaea173c19da6fa57e24eb4633ff815feb7ae3fa0 /man/XmbTextExtents.man
parentc3c4ddc682950a01b80825021f3e2503ab01ea7f (diff)
downloadxorg-lib-libX11-c6349f43193b74a3c09945f3093a871b0157ba47.tar.gz
Merging XORG-CURRENT into trunk
Diffstat (limited to 'man/XmbTextExtents.man')
-rw-r--r--man/XmbTextExtents.man59
1 files changed, 30 insertions, 29 deletions
diff --git a/man/XmbTextExtents.man b/man/XmbTextExtents.man
index fe43c225..4c9ad9d3 100644
--- a/man/XmbTextExtents.man
+++ b/man/XmbTextExtents.man
@@ -1,4 +1,5 @@
.\" 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
@@ -39,6 +40,8 @@
.\" 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.
+.\"
+.\" $XFree86: xc/doc/man/X11/XmbTExt.man,v 1.4 2001/01/27 18:20:08 dawes Exp $
.\"
.ds xT X Toolkit Intrinsics \- C Language Interface
.ds xW Athena X Widgets \- C Language X Toolkit Interface
@@ -138,33 +141,22 @@
.el .sp 10p
..
.ny0
-.TH XmbTextExtents 3X11 "Release 6.6" "X Version 11" "XLIB FUNCTIONS"
+.TH XmbTextExtents 3X11 __xorgversion__ "XLIB FUNCTIONS"
.SH NAME
-XmbTextExtents, XwcTextExtents \- compute text extents
+XmbTextExtents, XwcTextExtents, Xutf8TextExtents \- compute text extents
.SH SYNTAX
-int XmbTextExtents\^(\^\fIfont_set\fP\^, \fIstring\fP\^, \fInum_bytes\fP\^, \fIoverall_ink_return\fP\^, \fIoverall_logical_return\fP\^)
-.br
- XFontSet \fIfont_set\fP\^;
-.br
- char *\fIstring\fP\^;
-.br
- int \fInum_bytes\fP\^;
-.br
- XRectangle *\fIoverall_ink_return\fP\^;
-.br
- XRectangle *\fIoverall_logical_return\fP\^;
-.LP
-int XwcTextExtents\^(\^\fIfont_set\fP\^, \fIstring\fP\^, \fInum_wchars\fP\^, \fIoverall_ink_return\fP\^, \fIoverall_logical_return\fP\^)
-.br
- XFontSet \fIfont_set\fP\^;
-.br
- wchar_t *\fIstring\fP\^;
-.br
- int \fInum_wchars\fP\^;
-.br
- XRectangle *\fIoverall_ink_return\fP\^;
-.br
- XRectangle *\fIoverall_logical_return\fP\^;
+.HP
+int XmbTextExtents\^(\^XFontSet \fIfont_set\fP\^, char *\fIstring\fP\^, int
+\fInum_bytes\fP\^, XRectangle *\fIoverall_ink_return\fP\^, XRectangle
+*\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\^);
+.HP
+int Xutf8TextExtents\^(\^XFontSet \fIfont_set\fP\^, char *\fIstring\fP\^, int
+\fInum_bytes\fP\^, XRectangle *\fIoverall_ink_return\fP\^, XRectangle
+*\fIoverall_logical_return\fP\^);
.SH ARGUMENTS
.IP \fIfont_set\fP 1i
Specifies the font set.
@@ -181,17 +173,19 @@ Returns the overall logical \*(Ov.
Specifies the character string.
.SH DESCRIPTION
The
-.ZN XmbTextExtents
-and
+.ZN XmbTextExtents ,
.ZN XwcTextExtents
+and
+.ZN 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 XmbTextEscapement ,
+.ZN XwcTextEscapement
or
-.ZN XwcTextEscapement .
+.ZN Xutf8TextEscapement .
These metrics are relative to the drawing origin of the string,
using the fonts loaded for the specified font set.
.LP
@@ -220,6 +214,13 @@ 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
+The function
+.ZN 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 .
.SH "SEE ALSO"
XmbTextEscapement(3X11),
XmbTextPerCharExtents(3X11)