home *** CD-ROM | disk | FTP | other *** search
/ Geek Gadgets 1 / ADE-1.bin / ade-bin / x11r6.1 / man / cat3 / xopenim.0 < prev    next >
Encoding:
Text File  |  1996-10-17  |  7.1 KB  |  199 lines
  1.  
  2.  
  3.  
  4. XOpenIM(3X11)          XLIB FUNCTIONS        XOpenIM(3X11)
  5.  
  6.  
  7. NNAAMMEE
  8.        XOpenIM, XCloseIM, XSetIMValues, XGetIMValues, XDisplay-
  9.        OfIM, XLocaleOfIM, XRegisterIMInstantiateCallback, XUnreg-
  10.        isterIMInstantiateCallback - open, close, and otain input
  11.        method information
  12.  
  13. SSYYNNTTAAXX
  14.        XIM XOpenIM(_d_i_s_p_l_a_y, _d_b, _r_e_s___n_a_m_e, _r_e_s___c_l_a_s_s)
  15.          Display *_d_i_s_p_l_a_y;
  16.          XrmDatabase _d_b;
  17.          char *_r_e_s___n_a_m_e;
  18.          char *_r_e_s___c_l_a_s_s;
  19.  
  20.        Status XCloseIM(_i_m)
  21.          XIM _i_m;
  22.  
  23.        char * XSetIMValues(_i_m, ...)
  24.          XIM _i_m;
  25.  
  26.        char * XGetIMValues(_i_m, ...)
  27.          XIM _i_m;
  28.  
  29.        Display * XDisplayOfIM(_i_m)
  30.         XIM _i_m;
  31.  
  32.        char * XLocaleOfIM(_i_m)
  33.          XIM _i_m;
  34.  
  35.        Bool XRegisterIMInstantiateCallback(_d_i_s_p_l_a_y, _d_b, _r_e_s___n_a_m_e,
  36.        _r_e_s___c_l_a_s_s, _c_a_l_l_b_a_c_k, _c_l_i_e_n_t___d_a_t_a)
  37.          Display *_d_i_s_p_l_a_y;
  38.          XrmDatabase _d_b;
  39.          char *_r_e_s___n_a_m_e;
  40.          char *_r_e_s___c_l_a_s_s;
  41.          XIMProc  _c_a_l_l_b_a_c_k;
  42.          XPointer *_c_l_i_e_n_t___d_a_t_a;
  43.  
  44.        Bool XUnregisterIMInstantiateCallback(_d_i_s_p_l_a_y, _d_b,
  45.        _r_e_s___n_a_m_e, _r_e_s___c_l_a_s_s, _c_a_l_l_b_a_c_k, _c_l_i_e_n_t___d_a_t_a)
  46.          Display *_d_i_s_p_l_a_y;
  47.          XrmDatabase _d_b;
  48.          char *_r_e_s___n_a_m_e;
  49.          char *_r_e_s___c_l_a_s_s;
  50.          XIMProc  _c_a_l_l_b_a_c_k;
  51.          XPointer *_c_l_i_e_n_t___d_a_t_a;
  52.  
  53.  
  54. AARRGGUUMMEENNTTSS
  55.        _c_a_l_l_b_a_c_k     Specifies a pointer to the input method instan-
  56.          tiate callback.
  57.  
  58.        _c_l_i_e_n_t___d_a_t_a
  59.          Specifies the additional client data.
  60.  
  61.  
  62.  
  63.  
  64. X Version 11           Release 6.1                1
  65.  
  66.  
  67.  
  68.  
  69.  
  70. XOpenIM(3X11)          XLIB FUNCTIONS        XOpenIM(3X11)
  71.  
  72.  
  73.        _d_b     Specifies a pointer to the resource database.
  74.  
  75.        _d_i_s_p_l_a_y     Specifies the connection to the X server.
  76.  
  77.        _i_m     Specifies the input method.
  78.  
  79.        _r_e_s___c_l_a_s_s Specifies the full class name of the applica-
  80.          tion.
  81.  
  82.        _r_e_s___n_a_m_e     Specifies the full resource name of the applica-
  83.          tion.
  84.  
  85.        ...     Specifies the variable length argument list to
  86.          set or get XIM values.
  87.  
  88. DDEESSCCRRIIPPTTIIOONN
  89.        The _X_O_p_e_n_I_M function opens an input method, matching the
  90.        current locale and modifiers specification.  Current
  91.        locale and modifiers are bound to the input method at
  92.        opening time.  The locale associated with an input method
  93.        cannot be changed dynamically.  This implies that the
  94.        strings returned by _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,
  95.        for any input context affiliated with a given input method
  96.        will be encoded in the locale current at the time the
  97.        input method is opened.
  98.  
  99.        The specific input method to which this call will be
  100.        routed is identified on the basis of the current locale.
  101.        _X_O_p_e_n_I_M will identify a default input method corresponding
  102.        to the current locale.  That default can be modified using
  103.        _X_S_e_t_L_o_c_a_l_e_M_o_d_i_f_i_e_r_s for the input method modifier.
  104.  
  105.        The db argument is the resource database to be used by the
  106.        input method for looking up resources that are private to
  107.        the input method.  It is not intended that this database
  108.        be used to look up values that can be set as IC values in
  109.        an input context.  If db is NULL, no database is passed to
  110.        the input method.
  111.  
  112.        The res_name and res_class arguments specify the resource
  113.        name and class of the application.  They are intended to
  114.        be used as prefixes by the input method when looking up
  115.        resources that are common to all input contexts that may
  116.        be created for this input method.  The characters used for
  117.        resource names and classes must be in the X Portable Char-
  118.        acter Set.  The resources looked up are not fully speci-
  119.        fied if res_name or res_class is NULL.
  120.  
  121.        The res_name and res_class arguments are not assumed to
  122.        exist beyond the call to _X_O_p_e_n_I_M.  The specified resource
  123.        database is assumed to exist for the lifetime of the input
  124.        method.
  125.  
  126.        _X_O_p_e_n_I_M returns NULL if no input method could be opened.
  127.  
  128.  
  129.  
  130. X Version 11           Release 6.1                2
  131.  
  132.  
  133.  
  134.  
  135.  
  136. XOpenIM(3X11)          XLIB FUNCTIONS        XOpenIM(3X11)
  137.  
  138.  
  139.        The _X_C_l_o_s_e_I_M function closes the specified input method.
  140.  
  141.        The _X_S_e_t_I_M_V_a_l_u_e_s function presents a variable argument
  142.        list programming interface for setting attributes of the
  143.        specified input method.    It returns NULL if it succeeds;
  144.        otherwise, it returns the name of the first argument that
  145.        could not be set.  Xlib does not attempt to set arguments
  146.        from the supplied list that follow the failed argument;
  147.        all arguments in the list preceding the failed argument
  148.        have been set correctly.
  149.  
  150.        The _X_G_e_t_I_M_V_a_l_u_e_s function presents a variable argument
  151.        list programming interface for querying properties or fea-
  152.        tures of the specified input method.  This function
  153.        returns NULL if it succeeds; otherwise, it returns the
  154.        name of the first argument that could not be obtained.
  155.  
  156.        Each XIM value argument (following a name) must point to a
  157.        location where the XIM value is to be stored.  That is, if
  158.        the XIM value is of type T, the argument must be of type
  159.        T*.  If T itself is a pointer type, then _X_G_e_t_I_M_V_a_l_u_e_s
  160.        allocates memory to store the actual data, and the client
  161.        is responsible for freeing this data by calling _X_F_r_e_e with
  162.        the returned pointer.
  163.  
  164.        The _X_D_i_s_p_l_a_y_O_f_I_M function returns the display associated
  165.        with the specified input method.
  166.  
  167.        The _X_L_o_c_a_l_e_O_f_I_M function returns the locale associated
  168.        with the specified input method.
  169.  
  170.        The _X_R_e_g_i_s_t_e_r_I_M_I_n_s_t_a_n_t_i_a_t_e_C_a_l_l_b_a_c_k function registers a
  171.        callback to be invoked whenever a new input method becomes
  172.        available for the specified display that matches the cur-
  173.        rent locale and modifiers.
  174.  
  175.        The function returns _T_r_u_e
  176.     if it succeeds; otherwise, it returns _F_a_l_s_e.
  177.  
  178.        The _X_U_n_r_e_g_i_s_t_e_r_I_M_I_n_s_t_a_n_t_i_a_t_e_C_a_l_l_b_a_c_k function removes an
  179.        input method instantiation callback previously registered.
  180.        The function returns _T_r_u_e if it succeeds; otherwise, it
  181.        returns _F_a_l_s_e.
  182.  
  183. SSEEEE AALLSSOO
  184.        XCreateIC(3X11), XSetICFocus(3X11), XSetICValues(3X11),
  185.        XmbResetIC(3X11)
  186.        _X_l_i_b _- _C _L_a_n_g_u_a_g_e _X _I_n_t_e_r_f_a_c_e
  187.  
  188.  
  189.  
  190.  
  191.  
  192.  
  193.  
  194.  
  195.  
  196. X Version 11           Release 6.1                3
  197.  
  198.  
  199.