XmbLookupString(XS) X Version 11 (Release 5) XmbLookupString(XS)
6 January 1993
Name
XmbLookupString - obtain composed input from an input method
Syntax
int XmbLookupString(ic, event, buffer_return, bytes_buffer, keysym_return,
status_return)
XIC ic;
XKeyPressedEvent *event;
char *buffer_return;
int bytes_buffer;
KeySym *keysym_return;
Status *status_return;
int XwcLookupString(ic, event, buffer_return, bytes_buffer, keysym_return,
status_return)
XIC ic;
XKeyPressedEvent *event;
wchar_t *buffer_return;
int wchars_buffer;
KeySym *keysym_return;
Status *status_return;
Arguments
bufferreturn Returns a multibyte string or wide character string (if
any) from the input method.
bytesbuffer
wcharsbuffer Specifies space available in return buffer.
event Specifies the key event to be used.
ic Specifies the input context.
keysymreturn Returns the KeySym computed from the event if this argu-
ment is not NULL.
statusreturn Returns a value indicating what kind of data is returned.
Description
The XmbLookupString and XwcLookupString functions return the string from
the input method specified in the bufferreturn argument. If no string
is returned, the bufferreturn argument is unchanged.
The KeySym into which the KeyCode from the event was mapped is returned
in the keysymreturn argument if it is non-NULL and the statusreturn
argument indicates that a KeySym was returned. If both a string and a
KeySym are returned, the KeySym value does not necessarily correspond to
the string returned.
Note that XmbLookupString returns the length of the string in bytes and
that XwcLookupString returns the length of the string in characters.
XmbLookupString and XwcLookupString return text in the encoding of the
locale bound to the input method of the specified input context.
Note that each string returned by XmbLookupString and XwcLookupString
begins in the initial state of the encoding of the locale (if the encod-
ing of the locale is state-dependent).
_________________________________________________________________________
NOTE In order to insure proper input processing, it is essential
that the client pass only KeyPress events to XmbLookupString and
XwcLookupString. Their behavior when a client passes a KeyRelease
event is undefined.
_________________________________________________________________________
Clients should check the statusreturn argument before using the other
returned values. These two functions both return a value to
statusreturn that indicates what has been returned in the other argu-
ments. The possible values returned are:
XBufferOverflow The input string to be returned is too large for the
supplied bufferreturn. The required size (XmbLookup-
String in bytes; XwcLookupString in characters) is
returned as the value of the function, and the contents
of bufferreturn and keysymreturn are not modified.
The client should recall the function with the same
event and a buffer of adequate size in order to obtain
the string.
XLookupNone No consistent input has been composed so far. The con-
tents of bufferreturn and keysymreturn are not modi-
fied, and the function returns zero.
XLookupChars Some input characters have been composed. They are
placed in the bufferreturn argument, and the string
length is returned as the value of the function. The
string is encoded in the locale bound to the input con-
text. The contents of the keysymreturn argument is not
modified.
XLookupKeySym A KeySym has been returned instead of a string and is
returned in keysymreturn. The contents of the
bufferreturn argument is not modified, and the function
returns zero.
XLookupBoth Both a KeySym and a string are returned; XLookupChars
and XLookupKeySym occur simultaneously.
It does not make any difference if the input context passed as an argu-
ment to XmbLookupString and XwcLookupString is the one currently in pos-
session 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 XmbLookupString or XwcLookupString, even though it
does not have any more keyboard focus.
See also
XLookupKeysym(XS)
Xlib - C Language X Interface