home *** CD-ROM | disk | FTP | other *** search
/ Geek Gadgets 1 / ADE-1.bin / ade-bin / x11r6.1 / man / cat3 / xwclookupstring.0 < prev    next >
Encoding:
Text File  |  1996-10-17  |  6.2 KB  |  199 lines
  1.  
  2.  
  3.  
  4. XmbLookupString(3X11)      XLIB FUNCTIONS    XmbLookupString(3X11)
  5.  
  6.  
  7. NNAAMMEE
  8.        XmbLookupString, XwcLookupString - obtain composed input
  9.        from an input method
  10.  
  11. SSYYNNTTAAXX
  12.        int XmbLookupString(_i_c, _e_v_e_n_t, _b_u_f_f_e_r___r_e_t_u_r_n,
  13.        _b_y_t_e_s___b_u_f_f_e_r, _k_e_y_s_y_m___r_e_t_u_r_n, _s_t_a_t_u_s___r_e_t_u_r_n)
  14.          XIC _i_c;
  15.          XKeyPressedEvent *_e_v_e_n_t;
  16.          char *_b_u_f_f_e_r___r_e_t_u_r_n;
  17.          int _b_y_t_e_s___b_u_f_f_e_r;
  18.          KeySym *_k_e_y_s_y_m___r_e_t_u_r_n;
  19.          Status *_s_t_a_t_u_s___r_e_t_u_r_n;
  20.  
  21.        int XwcLookupString(_i_c, _e_v_e_n_t, _b_u_f_f_e_r___r_e_t_u_r_n,
  22.        _b_y_t_e_s___b_u_f_f_e_r, _k_e_y_s_y_m___r_e_t_u_r_n, _s_t_a_t_u_s___r_e_t_u_r_n)
  23.          XIC _i_c;
  24.          XKeyPressedEvent *_e_v_e_n_t;
  25.          wchar_t *_b_u_f_f_e_r___r_e_t_u_r_n;
  26.          int _w_c_h_a_r_s___b_u_f_f_e_r;
  27.          KeySym *_k_e_y_s_y_m___r_e_t_u_r_n;
  28.          Status *_s_t_a_t_u_s___r_e_t_u_r_n;
  29.  
  30. AARRGGUUMMEENNTTSS
  31.        _b_u_f_f_e_r___r_e_t_u_r_n
  32.          Returns a multibyte string or wide character
  33.          string (if any) from the input method.
  34.  
  35.        _b_y_t_e_s___b_u_f_f_e_r
  36.        _w_c_h_a_r_s___b_u_f_f_e_r
  37.          Specifies space available in the return buffer.
  38.  
  39.        _e_v_e_n_t     Specifies the key event to be used.
  40.  
  41.        _i_c     Specifies the input context.
  42.  
  43.        _k_e_y_s_y_m___r_e_t_u_r_n
  44.          Returns the KeySym computed from the event if
  45.          this argument is not NULL.
  46.  
  47.        _s_t_a_t_u_s___r_e_t_u_r_n
  48.          Returns a value indicating what kind of data is
  49.          returned.
  50.  
  51. DDEESSCCRRIIPPTTIIOONN
  52.        The _X_m_b_L_o_o_k_u_p_S_t_r_i_n_g and _X_w_c_L_o_o_k_u_p_S_t_r_i_n_g functions return
  53.        the string from the input method specified in the
  54.        buffer_return argument.    If no string is returned, the
  55.        buffer_return argument is unchanged.
  56.  
  57.        The KeySym into which the KeyCode from the event was
  58.        mapped is returned in the keysym_return argument if it is
  59.        non-NULL and the status_return argument indicates that a
  60.        KeySym was returned.  If both a string and a KeySym are
  61.  
  62.  
  63.  
  64. X Version 11           Release 6.1                1
  65.  
  66.  
  67.  
  68.  
  69.  
  70. XmbLookupString(3X11)      XLIB FUNCTIONS    XmbLookupString(3X11)
  71.  
  72.  
  73.        returned, the KeySym value does not necessarily correspond
  74.        to the string returned.
  75.  
  76.        _X_m_b_L_o_o_k_u_p_S_t_r_i_n_g returns the length of the string in bytes,
  77.        and _X_w_c_L_o_o_k_u_p_S_t_r_i_n_g returns the length of the string in
  78.        characters.  Both _X_m_b_L_o_o_k_u_p_S_t_r_i_n_g and _X_w_c_L_o_o_k_u_p_S_t_r_i_n_g
  79.        return text in the encoding of the locale bound to the
  80.        input method of the specified input context.
  81.  
  82.        Each string returned by _X_m_b_L_o_o_k_u_p_S_t_r_i_n_g and _X_w_c_L_o_o_k_u_p_-
  83.        _S_t_r_i_n_g begins in the initial state of the encoding of the
  84.        locale (if the encoding of the locale is state-dependent).
  85.  
  86.                   Note
  87.  
  88.         (R)To insure proper input processing, it is
  89.         essential that the client pass only _K_e_y_P_r_e_s_s
  90.         events to _X_m_b_L_o_o_k_u_p_S_t_r_i_n_g and _X_w_c_L_o_o_k_u_p_S_t_r_i_n_g.
  91.         Their behavior when a client passes a _K_e_y_R_e_l_e_a_s_e
  92.         event is undefined.
  93.  
  94.  
  95.        Clients should check the status_return argument before
  96.        using the other returned values.     These two functions both
  97.        return a value to status_return that indicates what has
  98.        been returned in the other arguments.  The possible values
  99.        returned are:
  100.        _X_B_u_f_f_e_r_O_v_e_r_f_l_o_w     The input string to be returned is too
  101.              large for the supplied buffer_return.    The
  102.              required size (_X_m_b_L_o_o_k_u_p_S_t_r_i_n_g in bytes;
  103.              _X_w_c_L_o_o_k_u_p_S_t_r_i_n_g in characters) is returned
  104.              as the value of the function, and the con-
  105.              tents of buffer_return and keysym_return
  106.              are not modified.  The client should recall
  107.              the function with the same event and a
  108.              buffer of adequate size to obtain the
  109.              string.
  110.        _X_L_o_o_k_u_p_N_o_n_e     No consistent input has been composed so
  111.              far.  The contents of buffer_return and
  112.              keysym_return are not modified, and the
  113.              function returns zero.
  114.        _X_L_o_o_k_u_p_C_h_a_r_s     Some input characters have been composed.
  115.              They are placed in the buffer_return argu-
  116.              ment, and the string length is returned as
  117.              the value of the function.  The string is
  118.              encoded in the locale bound to the input
  119.              context.  The content of the keysym_return
  120.              argument is not modified.
  121.        _X_L_o_o_k_u_p_K_e_y_S_y_m     A KeySym has been returned instead of a
  122.              string and is returned in keysym_return.
  123.              The content of the buffer_return argument
  124.              is not modified, and the function returns
  125.              zero.
  126.  
  127.  
  128.  
  129.  
  130. X Version 11           Release 6.1                2
  131.  
  132.  
  133.  
  134.  
  135.  
  136. XmbLookupString(3X11)      XLIB FUNCTIONS    XmbLookupString(3X11)
  137.  
  138.  
  139.        _X_L_o_o_k_u_p_B_o_t_h     Both a KeySym and a string are returned;
  140.              _X_L_o_o_k_u_p_C_h_a_r_s and _X_L_o_o_k_u_p_K_e_y_S_y_m occur simul-
  141.              taneously.
  142.  
  143.        It does not make any difference if the input context
  144.        passed as an argument to _X_m_b_L_o_o_k_u_p_S_t_r_i_n_g and _X_w_c_L_o_o_k_u_p_-
  145.        _S_t_r_i_n_g is the one currently in possession of the focus or
  146.        not.  Input may have been composed within an input context
  147.        before it lost the focus, and that input may be returned
  148.        on subsequent calls to _X_m_b_L_o_o_k_u_p_S_t_r_i_n_g or _X_w_c_L_o_o_k_u_p_S_t_r_i_n_g
  149.        even though it does not have any more keyboard focus.
  150.  
  151. SSEEEE AALLSSOO
  152.        XLookupKeysym(3X11)
  153.        _X_l_i_b _- _C _L_a_n_g_u_a_g_e _X _I_n_t_e_r_f_a_c_e
  154.  
  155.  
  156.  
  157.  
  158.  
  159.  
  160.  
  161.  
  162.  
  163.  
  164.  
  165.  
  166.  
  167.  
  168.  
  169.  
  170.  
  171.  
  172.  
  173.  
  174.  
  175.  
  176.  
  177.  
  178.  
  179.  
  180.  
  181.  
  182.  
  183.  
  184.  
  185.  
  186.  
  187.  
  188.  
  189.  
  190.  
  191.  
  192.  
  193.  
  194.  
  195.  
  196. X Version 11           Release 6.1                3
  197.  
  198.  
  199.