'\" t
.\" ImMbLook.sgm /main/8 1996/09/08 20:47:50 rws $
.de P!
.fl
\!!1 setgray
.fl
\\&.\"
.fl
\!!0 setgray
.fl			\" force out current output buffer
\!!save /psv exch def currentpoint translate 0 0 moveto
\!!/showpage{}def
.fl			\" prolog
.sy sed -e 's/^/!/' \\$1\" bring in postscript file
\!!psv restore
.
.de pF
.ie     \\*(f1 .ds f1 \\n(.f
.el .ie \\*(f2 .ds f2 \\n(.f
.el .ie \\*(f3 .ds f3 \\n(.f
.el .ie \\*(f4 .ds f4 \\n(.f
.el .tm ? font overflow
.ft \\$1
..
.de fP
.ie     !\\*(f4 \{\
.	ft \\*(f4
.	ds f4\"
'	br \}
.el .ie !\\*(f3 \{\
.	ft \\*(f3
.	ds f3\"
'	br \}
.el .ie !\\*(f2 \{\
.	ft \\*(f2
.	ds f2\"
'	br \}
.el .ie !\\*(f1 \{\
.	ft \\*(f1
.	ds f1\"
'	br \}
.el .tm ? font underflow
..
.ds f1\"
.ds f2\"
.ds f3\"
.ds f4\"
.ta 8n 16n 24n 32n 40n 48n 56n 64n 72n 
.TH "XmImMbLookupString" 3
.SH "NAME"
\fBXmImMbLookupString\fP \(em An input manager function that retrieves a composed string from an input method
"XmImMbLookupString"
"input manager functions" "XmImMbLookupString"
.SH "SYNOPSIS"
.PP
.nf
#include <Xm/XmIm\&.h>
\fBint \fBXmImMbLookupString\fP\fR(
\fBWidget \fBwidget\fR\fR,
\fBXKeyPressedEvent *\fBevent\fR\fR,
\fBchar *\fBbuffer_return\fR\fR,
\fBint \fBbytes_buffer\fR\fR,
\fBKeySym *\fBkeysym_return\fR\fR,
\fBint *\fBstatus_return\fR\fR);
.fi
.SH "DESCRIPTION"
.PP
\fBXmImMbLookupString\fP returns a string composed in the
locale associated with the widget\&'s input method and a
KeySym that is currently mapped to the keycode in a KeyPress
event\&. The KeySym is obtained by using the standard
interpretation of Shift, Lock and Group modifiers as
defined in the X Protocol specification\&.
.PP
An XIM will be created, but an XIC will not be created\&. One of the functions,
\fBXmImSetValues\fP, \fBXmImVaSetValues\fP, or \fBXmImGetXIC\fP,
needs to be called to create an XIC\&.
.IP "\fIwidget\fP" 10
Specifies the ID of the widget registered with the input manager
.IP "\fIevent\fP" 10
Specifies the key press event
.IP "\fIbuffer_return\fP" 10
Specifies the buffer in which the string is returned
.IP "\fIbytes_buffer\fP" 10
Specifies the size of the buffer in bytes
.IP "\fIkeysym_return\fP" 10
Specifies a pointer to the KeySym returned if one exists
.IP "\fIstatus_return\fP" 10
Specifies the status values returned by the function\&. These status
values are the same as those for the \fBXmbLookupString\fP function\&. The
possible status values are:
.RS
.IP "\fBXBufferOverflow\fP" 10
The size of the buffer was insufficient to handle
the returned string\&. The contents of \fIbuffer_return\fP
and \fIkeysym_return\fP are not modified\&. The required
buffer size is returned as a value of the function\&. The
client should repeat the call with a larger buffer size to
receive the string\&.
.IP "\fBXLookupNone\fP" 10
No consistent input was composed\&. The contents of
\fIbuffer_return\fP and \fIkeysym_return\fP are not modified
and the function returns a value of 0\&.
.IP "\fBXLookupChars\fP" 10
Some input characters were composed and returned in
\fIbuffer_return\fP\&. The content of \fIkeysym_return\fP
is not modified\&. The function returns the length of
the string in bytes\&.
.IP "\fBXLookupKeysym\fP" 10
A keysym value was returned instead of a string\&. The content of
\fIbuffer_return\fP is not modified and the function returns
a value of 0\&.
.IP "\fBXLookupBoth\fP" 10
A keysym value and a string were returned\&. The keysym value may
not necessarily correspond to the string returned\&. The function
returns the length of the string in bytes\&.
.RE
.SH "RETURN"
.PP
Return values depend on the status returned by the function\&. Refer
to the description of status values above\&.
.SH "RELATED"
.PP
\fBXmImGetXIM\fP(3),
\fBXmImGetXIC\fP(3),
\fBXmImRegister\fP(3),
\fBXmImSetValues\fP(3),
and
\fBXmImUnregister\fP(3)\&.
.\" created by instant / docbook-to-man, Sun 22 Dec 1996, 20:24