diff options
Diffstat (limited to 'man/XmbLookupString.man')
| -rw-r--r-- | man/XmbLookupString.man | 70 |
1 files changed, 51 insertions, 19 deletions
diff --git a/man/XmbLookupString.man b/man/XmbLookupString.man index 48085d08..13beedda 100644 --- a/man/XmbLookupString.man +++ b/man/XmbLookupString.man @@ -1,5 +1,6 @@ '\" t .\" 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 @@ -40,6 +41,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/XmbLStr.man,v 1.3 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 @@ -140,9 +143,9 @@ .. .ny0 '\" t -.TH XmbLookupString 3X11 "Release 6.6" "X Version 11" "XLIB FUNCTIONS" +.TH XmbLookupString 3X11 __xorgversion__ "XLIB FUNCTIONS" .SH NAME -XmbLookupString, XwcLookupString \- obtain composed input from an input method +XmbLookupString, XwcLookupString, Xutf8LookupString \- obtain composed input from an input method .SH SYNTAX int XmbLookupString\^(\^\fIic\fP\^, \fIevent\fP\^, \fIbuffer_return\fP\^, \fIbytes_buffer\fP\^, \fIkeysym_return\fP\^, \fIstatus_return\fP\^) .br @@ -171,6 +174,20 @@ int XwcLookupString\^(\^\fIic\fP\^, \fIevent\fP\^, \fIbuffer_return\fP\^, \fIbyt KeySym *\fIkeysym_return\fP\^; .br Status *\fIstatus_return\fP\^; +.LP +int Xutf8LookupString\^(\^\fIic\fP\^, \fIevent\fP\^, \fIbuffer_return\fP\^, \fIbytes_buffer\fP\^, \fIkeysym_return\fP\^, \fIstatus_return\fP\^) +.br + XIC \fIic\fP\^; +.br + XKeyPressedEvent *\fIevent\fP; +.br + char *\fIbuffer_return\fP\^; +.br + int \fIbytes_buffer\fP\^; +.br + KeySym *\fIkeysym_return\fP\^; +.br + Status *\fIstatus_return\fP\^; .SH ARGUMENTS .IP \fIbuffer_return\fP 1i Returns a multibyte string or wide character string (if any) @@ -191,9 +208,10 @@ Returns the KeySym computed from the event if this argument is not NULL. Returns a value indicating what kind of data is returned. .SH DESCRIPTION The -.ZN XmbLookupString -and +.ZN XmbLookupString , .ZN XwcLookupString +and +.ZN Xutf8LookupString functions return the string from the input method specified in the buffer_return argument. If no string is returned, @@ -206,7 +224,9 @@ If both a string and a KeySym are returned, the KeySym value does not necessarily correspond to the string returned. .LP .ZN XmbLookupString -returns the length of the string in bytes, and +and +.ZN Xutf8LookupString +return the length of the string in bytes, and .ZN XwcLookupString returns the length of the string in characters. Both @@ -214,7 +234,9 @@ Both and .ZN XwcLookupString return text in the encoding of the locale bound to the input method -of the specified input context. +of the specified input context, and +.ZN Xutf8LookupString +returns text in UTF-8 encoding. .LP Each string returned by .ZN XmbLookupString @@ -223,13 +245,14 @@ and begins in the initial state of the encoding of the locale (if the encoding of the locale is state-dependent). .NT -To insure proper input processing, +To ensure proper input processing, it is essential that the client pass only .ZN KeyPress events to -.ZN XmbLookupString +.ZN XmbLookupString , +.ZN XwcLookupString and -.ZN XwcLookupString . +.ZN Xutf8LookupString . Their behavior when a client passes a .ZN KeyRelease event is undefined. @@ -237,7 +260,7 @@ event is undefined. .LP Clients should check the status_return argument before using the other returned values. -These two functions both return a value to status_return +These three functions each return a value to status_return that indicates what has been returned in the other arguments. The possible values returned are: .TS @@ -246,9 +269,10 @@ T{ .ZN XBufferOverflow T} T{ The input string to be returned is too large for the supplied buffer_return. -The required size -.Pn ( XmbLookupString -in bytes; +The required size (for +.ZN XmbLookupString , +.ZN Xutf8LookupString +in bytes; for .ZN XwcLookupString in characters) is returned as the value of the function, and the contents of buffer_return and keysym_return are not modified. @@ -266,9 +290,9 @@ T{ .ZN XLookupChars T} T{ Some input characters have been composed. -They are placed in the buffer_return argument, +They are placed in the buffer_return argument, using the encoding +described above, and the string length is returned as the value of the function. -The string is encoded in the locale bound to the input context. The content of the keysym_return argument is not modified. T} T{ @@ -291,16 +315,24 @@ T} .TE .LP It does not make any difference if the input context passed as an argument to -.ZN XmbLookupString -and +.ZN XmbLookupString , .ZN XwcLookupString +and +.ZN Xutf8LookupString is the one currently in possession of the focus or not. Input may have been composed within an input context before it lost the focus, and that input may be returned on subsequent calls to -.ZN XmbLookupString -or +.ZN XmbLookupString , .ZN XwcLookupString +or +.ZN Xutf8LookupString even though it does not have any more keyboard focus. +.LP +The function +.ZN Xutf8LookupString +is an XFree86 extension introduced in XFree86 4.0.2. Its presence is +indicated by the macro +.ZN X_HAVE_UTF8_STRING . .SH "SEE ALSO" XLookupKeysym(3X11) .br |