Synopsis#include <gtk/gtk.h> GtkIMContext; void gtk_im_context_set_client_window (GtkIMContext *context, GdkWindow *window); void gtk_im_context_get_preedit_string (GtkIMContext *context, gchar **str, PangoAttrList **attrs, gint *cursor_pos); gboolean gtk_im_context_filter_keypress (GtkIMContext *context, GdkEventKey *event); void gtk_im_context_focus_in (GtkIMContext *context); void gtk_im_context_focus_out (GtkIMContext *context); void gtk_im_context_reset (GtkIMContext *context); void gtk_im_context_set_cursor_location (GtkIMContext *context, const GdkRectangle *area); void gtk_im_context_set_use_preedit (GtkIMContext *context, gboolean use_preedit); void gtk_im_context_set_surrounding (GtkIMContext *context, const gchar *text, gint len, gint cursor_index); gboolean gtk_im_context_get_surrounding (GtkIMContext *context, gchar **text, gint *cursor_index); gboolean gtk_im_context_delete_surrounding (GtkIMContext *context, gint offset, gint n_chars); Signals"commit" : Run Last "delete-surrounding" : Run Last "preedit-changed" : Run Last "preedit-end" : Run Last "preedit-start" : Run Last "retrieve-surrounding" : Run Last Detailsgtk_im_context_set_client_window ()void gtk_im_context_set_client_window (GtkIMContext *context, GdkWindow *window); Set the client window for the input context; this is the GdkWindow in which the input appears. This window is used in order to correctly position status windows, and may also be used for purposes internal to the input method.
gtk_im_context_get_preedit_string ()void gtk_im_context_get_preedit_string (GtkIMContext *context, gchar **str, PangoAttrList **attrs, gint *cursor_pos); Retrieve the current preedit string for the input context, and a list of attributes to apply to the string. This string should be displayed inserted at the insertion point.
gtk_im_context_filter_keypress ()gboolean gtk_im_context_filter_keypress (GtkIMContext *context, GdkEventKey *event);
Allow an input method to internally handle key press and release
events. If this function returns
gtk_im_context_focus_in ()void gtk_im_context_focus_in (GtkIMContext *context); Notify the input method that the widget to which this input context corresponds has gained focus. The input method may, for example, change the displayed feedback to reflect this change.
gtk_im_context_focus_out ()void gtk_im_context_focus_out (GtkIMContext *context); Notify the input method that the widget to which this input context corresponds has lost focus. The input method may, for example, change the displayed feedback or reset the contexts state to reflect this change.
gtk_im_context_reset ()void gtk_im_context_reset (GtkIMContext *context); Notify the input method that a change such as a change in cursor position has been made. This will typically cause the input method to clear the preedit state.
gtk_im_context_set_cursor_location ()void gtk_im_context_set_cursor_location (GtkIMContext *context, const GdkRectangle *area); Notify the input method that a change in cursor position has been made. The location is relative to the client window.
gtk_im_context_set_use_preedit ()void gtk_im_context_set_use_preedit (GtkIMContext *context, gboolean use_preedit);
Sets whether the IM context should use the preedit string
to display feedback. If
gtk_im_context_set_surrounding ()void gtk_im_context_set_surrounding (GtkIMContext *context, const gchar *text, gint len, gint cursor_index); Sets surrounding context around the insertion point and preedit string. This function is expected to be called in response to the GtkIMContext::retrieve_surrounding signal, and will likely have no effect if called at other times.
gtk_im_context_get_surrounding ()gboolean gtk_im_context_get_surrounding (GtkIMContext *context, gchar **text, gint *cursor_index); Retrieves context around the insertion point. Input methods typically want context in order to constrain input text based on existing text; this is important for languages such as Thai where only some sequences of characters are allowed.
This function is implemented by emitting the
GtkIMContext::retrieve_surrounding signal on the input method; in
response to this signal, a widget should provide as much context as
is available, up to an entire paragraph, by calling
gtk_im_context_delete_surrounding ()gboolean gtk_im_context_delete_surrounding (GtkIMContext *context, gint offset, gint n_chars);
Asks the widget that the input context is attached to to delete
characters around the cursor position by emitting the
GtkIMContext::delete_surrounding signal. Note that
In order to use this function, you should first call
This function is used by an input method that wants to make subsitutions in the existing text in response to new input. It is not useful for applications.
Signal DetailsThe
|
|
the object which received the signal. |
|
|
|
user data set when the signal handler was connected. |
"delete-surrounding"
signalgboolean user_function (GtkIMContext *imcontext, gint arg1, gint arg2, gpointer user_data) : Run Last
|
the object which received the signal. |
|
|
|
|
|
user data set when the signal handler was connected. |
Returns : |
"preedit-changed"
signalvoid user_function (GtkIMContext *imcontext, gpointer user_data) : Run Last
|
the object which received the signal. |
|
user data set when the signal handler was connected. |
"preedit-end"
signalvoid user_function (GtkIMContext *imcontext, gpointer user_data) : Run Last
|
the object which received the signal. |
|
user data set when the signal handler was connected. |
"preedit-start"
signalvoid user_function (GtkIMContext *imcontext, gpointer user_data) : Run Last
|
the object which received the signal. |
|
user data set when the signal handler was connected. |
"retrieve-surrounding"
signalgboolean user_function (GtkIMContext *imcontext, gpointer user_data) : Run Last
|
the object which received the signal. |
|
user data set when the signal handler was connected. |
Returns : |