NAME

XOpenIM, XCloseIM, XSetIMValues, XGetIMValues, XDisplayOfIM, XLocaleOfIM, XRegisterIMInstantiateCallback, XUnregisterIMInstantiateCallback - open, close, and obtain input method information

SYNTAX

XIM XOpenIM(Display *_d_i_s_p_l_a_y, XrmDatabase _d_b, char *_r_e_s___n_a_m_e, char *_r_e_s___c_l_a_s_s); Status XCloseIM(XIM _i_m); char *XSetIMValues(XIM _i_m, ...); char *XGetIMValues(XIM _i_m, ...); Display *XDisplayOfIM(XIM _i_m); char *XLocaleOfIM(XIM _i_m); Bool XRegisterIMInstantiateCallback(Display *_d_i_s_p_l_a_y, XrmDatabase _d_b, char *_r_e_s___n_a_m_e, char *_r_e_s___c_l_a_s_s, XIDProc _c_a_l_l_b_a_c_k, XPointer _c_l_i_e_n_t___d_a_t_a); Bool XUnregisterIMInstantiateCallback(Display *_d_i_s_p_l_a_y, XrmDatabase _d_b, char *_r_e_s___n_a_m_e, char *_r_e_s___c_l_a_s_s, XIDProc _c_a_l_l_b_a_c_k, XPointer _c_l_i_e_n_t___d_a_t_a);

ARGUMENTS

_c_a_l_l_b_a_c_k Specifies a pointer to the input method instantiate callback.
_c_l_i_e_n_t___d_a_t_a Specifies the additional client data.
_d_b Specifies a pointer to the resource database.
_d_i_s_p_l_a_y Specifies the connection to the X server.
_i_m Specifies the input method.
_r_e_s___c_l_a_s_s Specifies the full class name of the application.
_r_e_s___n_a_m_e Specifies the full resource name of the application.
... Specifies the variable length argument list to set or get XIM values.

DESCRIPTION

The _X_O_p_e_n_I_M function opens an input method, matching the current locale and modifiers specification. Current locale and modifiers are bound to the input method at opening time. The locale associated with an input method cannot be changed dynamically. This implies that the 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, for any input context affiliated with a given input method will be encoded in the locale current at the time the input method is opened.

The specific input method to which this call will be routed is identified on the basis of the current locale. _X_O_p_e_n_I_M will identify a default input method corresponding to the current locale. That default can be modified using _X_S_e_t_L_o_c_a_l_e_M_o_d_i_f_i_e_r_s for the input method modifier.

The db argument is the resource database to be used by the input method for looking up resources that are private to the input method. It is not intended that this database be used to look up values that can be set as IC values in an input context. If db is NULL, no database is passed to the input method.

The res_name and res_class arguments specify the resource name and class of the application. They are intended to be used as prefixes by the input method when looking up resources that are common to all input contexts that may be created for this input method. The characters used for resource names and classes must be in the X Portable Character Set. The resources looked up are not fully specified if res_name or res_class is NULL.

The res_name and res_class arguments are not assumed to exist beyond the call to _X_O_p_e_n_I_M. The specified resource database is assumed to exist for the lifetime of the input method.

_X_O_p_e_n_I_M returns NULL if no input method could be opened.

The _X_C_l_o_s_e_I_M function closes the specified input method.

The _X_S_e_t_I_M_V_a_l_u_e_s function presents a variable argument list programming interface for setting attributes of the specified input method. It returns NULL if it succeeds; otherwise, it returns the name of the first argument that could not be set. Xlib does not attempt to set arguments from the supplied list that follow the failed argument; all arguments in the list preceding the failed argument have been set correctly.

The _X_G_e_t_I_M_V_a_l_u_e_s function presents a variable argument list programming interface for querying properties or features of the specified input method. This function returns NULL if it succeeds; otherwise, it returns the name of the first argument that could not be obtained.

Each XIM value argument (following a name) must point to a location where the XIM value is to be stored. That is, if the XIM value is of type T, the argument must be of type T*. If T itself is a pointer type, then _X_G_e_t_I_M_V_a_l_u_e_s allocates memory to store the actual data, and the client is responsible for freeing this data by calling _X_F_r_e_e with the returned pointer.

The _X_D_i_s_p_l_a_y_O_f_I_M function returns the display associated with the specified input method.

The _X_L_o_c_a_l_e_O_f_I_M function returns the locale associated with the specified input method.

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 callback to be invoked whenever a new input method becomes available for the specified display that matches the current locale and modifiers.

The function returns _T_r_u_e if it succeeds; otherwise, it returns _F_a_l_s_e.

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 input method instantiation callback previously registered. The function returns _T_r_u_e if it succeeds; otherwise, it returns _F_a_l_s_e.

SEE ALSO

XCreateIC(3X11), XSetICFocus(3X11), XSetICValues(3X11), XmbResetIC(3X11)
_X_l_i_b _- _C _L_a_n_g_u_a_g_e _X _I_n_t_e_r_f_a_c_e