1XmImMbLookupString(library call)              XmImMbLookupString(library call)
2
3
4

NAME

6       XmImMbLookupString  —  An  input manager function that retrieves a com‐
7       posed string from an input method
8

SYNOPSIS

10       #include <Xm/XmIm.h>
11       int XmImMbLookupString(
12       Widget widget,
13       XKeyPressedEvent *event,
14       char *buffer_return,
15       int bytes_buffer,
16       KeySym *keysym_return,
17       int *status_return);
18

DESCRIPTION

20       XmImMbLookupString returns a string composed in the  locale  associated
21       with the widget's input method and a KeySym that is currently mapped to
22       the keycode in a KeyPress event. The KeySym is obtained  by  using  the
23       standard  interpretation  of Shift, Lock and Group modifiers as defined
24       in the X Protocol specification.
25
26       An XIM will be created, but an XIC will not  be  created.  One  of  the
27       functions,  XmImSetValues,  XmImVaSetValues, or XmImGetXIC, needs to be
28       called to create an XIC.
29
30       widget    Specifies the ID of the widget registered with the input man‐
31                 ager
32
33       event     Specifies the key press event
34
35       buffer_return
36                 Specifies the buffer in which the string is returned
37
38       bytes_buffer
39                 Specifies the size of the buffer in bytes
40
41       keysym_return
42                 Specifies a pointer to the KeySym returned if one exists
43
44       status_return
45                 Specifies  the  status values returned by the function. These
46                 status values are the same as those for  the  XmbLookupString
47                 function. The possible status values are:
48
49                 XBufferOverflow
50                           The  size  of the buffer was insufficient to handle
51                           the returned string. The contents of  buffer_return
52                           and  keysym_return  are  not modified. The required
53                           buffer size is returned as a value of the function.
54                           The  client  should  repeat  the call with a larger
55                           buffer size to receive the string.
56
57                 XLookupNone
58                           No consistent input was composed. The  contents  of
59                           buffer_return  and  keysym_return  are not modified
60                           and the function returns a value of 0.
61
62                 XLookupChars
63                           Some input characters were composed and returned in
64                           buffer_return.  The content of keysym_return is not
65                           modified. The function returns the  length  of  the
66                           string in bytes.
67
68                 XLookupKeysym
69                           A  keysym  value  was returned instead of a string.
70                           The content of buffer_return is  not  modified  and
71                           the function returns a value of 0.
72
73                 XLookupBoth
74                           A  keysym  value  and  a  string were returned. The
75                           keysym value may not necessarily correspond to  the
76                           string returned. The function returns the length of
77                           the string in bytes.
78

RETURN

80       Return values depend on the status returned by the function.  Refer  to
81       the description of status values above.
82

84       XmImGetXIM(3),  XmImGetXIC(3),  XmImRegister(3),  XmImSetValues(3), and
85       XmImUnregister(3).
86
87
88
89                                              XmImMbLookupString(library call)
Impressum