gtkIMContextGetSurrounding {RGtk2}R Documentation

gtkIMContextGetSurrounding

Description

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.

Usage

gtkIMContextGetSurrounding(object)

Arguments

object [GtkIMContext] a GtkIMContext

Details

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 gtkIMContextSetSurrounding. 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.

Value

A list containing the following elements:

retval [logical] TRUE if surrounding text was provided; in this case you must free the result stored in *text.
text [character] 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 gFree().
cursor.index [integer] location to store byte index of the insertion cursor within text.

Author(s)

Derived by RGtkGen from GTK+ documentation


[Package RGtk2 version 2.12.5-3 Index]