gboolean gtk_im_context_get_surrounding ( GtkIMContext* context, char** text, int* 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
Note that there is no obligation for a widget to respond to the
::retrieve-surrounding signal, so input methods must be prepared to
function without context.
Location to store a UTF-8 encoded string of text holding context around the insertion point. If the function returns
TRUE, then you must free the result stored in this location with g_free().
The argument will be set by the function. The instance takes ownership of the data, and is responsible for freeing it. The value is a NUL terminated UTF-8 string.
Location to store byte index of the insertion cursor within
The argument will be set by the function.