Back to Seed Clases

Gtk

Classes

Interfaces

Structs

Unions

Enums

GObject.Object
parent-child marker Gtk.IMContext

Class Gtk.IMContext

Import line:	Gtk = imports.gi.Gtk;
GIR File:	Gtk-3.0.gir
C documentation:	GtkIMContext
Class :	IMContext
Extends:	GObject.Object

GtkIMContext defines the interface for GTK+ input methods. An input method
is used by GTK+ text input widgets like GtkEntry to map from key events to
Unicode character strings.
The user may change the current input method via a context menu, unless the
GtkSettings:gtk-show-input-method-menu GtkSettings property is set to FALSE.
The default input method can be set programmatically via the
GtkSettings:gtk-im-module GtkSettings property. Alternatively, you may set
the GTK_IM_MODULE environment variable as documented in gtk-running.
The GtkEntry GtkEntry:im-module and GtkTextView GtkTextView:im-module
properties may also be used to set input methods for specific widget
instances. For instance, a certain entry widget might be expected to contain
certain characters which would be easier to input with a certain input
method.
An input method may consume multiple key events in sequence and finally
output the composed result. This is called preediting, and an input method
may provide feedback about this process by displaying the intermediate
composition states as preedit text. For instance, the default GTK+ input
method implements the input of arbitrary Unicode code points by holding down
the Control and Shift keys and then typing "U" followed by the hexadecimal
digits of the code point. When releasing the Control and Shift keys,
preediting ends and the character is inserted as text. Ctrl+Shift+u20AC for
example results in the € sign.
Additional input methods can be made available for use by GTK+ widgets as
loadable modules. An input method module is a small shared library which
implements a subclass of GtkIMContext or GtkIMContextSimple and exports
these four functions:

void im_module_init(GTypeModule *module);

This function should register the GType of the GtkIMContext subclass which
implements the input method by means of g_type_module_register_type(). Note
that g_type_register_static() cannot be used as the type needs to be
registered dynamically.

void im_module_exit(void);

Here goes any cleanup code your input method might require on module unload.

void im_module_list(const GtkIMContextInfo ***contexts, int *n_contexts)
{
*contexts = info_list;
*n_contexts = G_N_ELEMENTS (info_list);
}

This function returns the list of input methods provided by the module. The
example implementation above shows a common solution and simply returns a
pointer to statically defined array of GtkIMContextInfo items for each
provided input method.

GtkIMContext * im_module_create(const gchar *context_id);

This function should return a pointer to a newly created instance of the
GtkIMContext subclass identified by context_id. The context ID is the same
as specified in the GtkIMContextInfo array returned by im_module_list().
After a new loadable input method module has been installed on the system,
the configuration file gtk.immodules needs to be
regenerated by gtk-query-immodules-3.0,
in order for the new input method to become available to GTK+ applications.

Properties
Properties		Defined By
	parent_instance : GObject.Object read only	Gtk.IMContext

Methods / Constructors
Method / Constructor		Defined By
	new Gtk.IMContext (Object *properties) Create a new Gtk.IMContext Create a new Gtk.IMContext Parameters: Object properties*
	delete_surrounding (gint32 *offset, gint32 n_chars) : gboolean Asks the widget that the input context is attached to to delete characters around the cursor position by emitting the GtkIMContext::delete_surrounding signal. 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 offset* and n_chars are in characters not in bytes which differs from the usage other places in GtkIMContext. In order to use this function, you should first call gtk_im_context_get_surrounding() to get the current context, and call this function immediately afterwards to make sure that you know what you are deleting. You should also account for the fact that even if the signal was handled, the input context might not have deleted all the characters that were requested to be deleted. 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. Parameters: gint32 offset Required (not null) offset from cursor position in chars; a negative value means start before the cursor. gint32 n_chars Required (not null) number of characters to delete. Returns: gboolean TRUE if the signal was handled.	Gtk.IMContext
	filter_keypress (EventKey *event) : gboolean Allow an input method to internally handle key press and release events. Allow an input method to internally handle key press and release events. If this function returns TRUE, then no further processing should be done for this key event. Parameters: Gdk.EventKey event* Required (not null) the key event Returns: gboolean TRUE if the input method handled the key event.	Gtk.IMContext
	focus_in () : none Notify the input method that the widget to which this input context corresponds has gained focus. 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. Returns: none	Gtk.IMContext
	focus_out () : none Notify the input method that the widget to which this input context corresponds has lost focus. 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. Returns: none	Gtk.IMContext
	get_preedit_string () : Object Retrieve the current preedit string for the input context, and a list of attributes to apply to the string. 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. Returns: str: String attrs: Pango.AttrList cursor_pos: gint32	Gtk.IMContext
	get_surrounding (Object *out_values, gint32 cursor_index) : gboolean Retrieves context around the insertion point. 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_set_surrounding(). 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. you must free the result stored in text. Parameters: Object out_values String text gint32 cursor_index Required (not null) (out) location to store byte index of the insertion cursor within text. Returns: gboolean TRUE if surrounding text was provided; in this case	Gtk.IMContext
	reset () : none Notify the input method that a change such as a change in cursor position has been made. 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. Returns: none	Gtk.IMContext
	set_client_window (Window *window) : none Set the client window for the input context; this is the GdkWindow* in which the input appears. 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. Parameters: Gdk.Window window the client window. This may be NULL to indicate that the previous client window no longer exists. Returns: none	Gtk.IMContext
	set_cursor_location (RectangleInt *area) : none Notify the input method that a change in cursor position has been made. Notify the input method that a change in cursor position has been made. The location is relative to the client window. Parameters: cairo.RectangleInt area* Required (not null) new location Returns: none	Gtk.IMContext
	set_surrounding (String *text, gint32 len, gint32 cursor_index) : none Sets surrounding context around the insertion point and preedit string. 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. Parameters: String text* Required (not null) text surrounding the insertion point, as UTF-8. the preedit string should not be included within gint32 len Required (not null) the length of text, or -1 if text is nul-terminated gint32 cursor_index Required (not null) the byte index of the insertion cursor within text. Returns: none	Gtk.IMContext
	set_use_preedit (gboolean *use_preedit) : none Sets whether the IM context should use the preedit string to display feedback. Sets whether the IM context should use the preedit string to display feedback. If use_preedit* is FALSE (default is TRUE), then the IM context may use some other method to display feedback, such as displaying it in a child of the root window. Parameters: gboolean use_preedit Required (not null) whether the IM context should use the preedit string. Returns: none	Gtk.IMContext

Events - usage syntax: this.signals.EVENTNAME.connect( Function )
Event		Defined By
	commit (IMContext *self, String str) : none The ::commit signal is emitted when a complete input sequence has been entered by the user. The ::commit signal is emitted when a complete input sequence has been entered by the user. This can be a single character immediately after a key press or the final result of preediting. Parameters: Gtk.IMContext self* String str Returns: {none}	Gtk.IMContext
	delete_surrounding (IMContext *self, gint32 offset, gint32 n_chars) : gboolean The ::delete-surrounding signal is emitted when the input method needs to delete all or part of the context surrounding the cursor. The ::delete-surrounding signal is emitted when the input method needs to delete all or part of the context surrounding the cursor. Parameters: Gtk.IMContext self* gint32 offset gint32 n_chars Returns: {gboolean}	Gtk.IMContext
	preedit_changed (IMContext *self) : none The ::preedit-changed signal is emitted whenever the preedit sequence currently being entered has changed. The ::preedit-changed signal is emitted whenever the preedit sequence currently being entered has changed. It is also emitted at the end of a preedit sequence, in which case gtk_im_context_get_preedit_string() returns the empty string. Parameters: Gtk.IMContext self* Returns: {none}	Gtk.IMContext
	preedit_end (IMContext *self) : none The ::preedit-end signal is emitted when a preediting sequence has been completed or canceled. The ::preedit-end signal is emitted when a preediting sequence has been completed or canceled. Parameters: Gtk.IMContext self* Returns: {none}	Gtk.IMContext
	preedit_start (IMContext *self) : none The ::preedit-start signal is emitted when a new preediting sequence starts. The ::preedit-start signal is emitted when a new preediting sequence starts. Parameters: Gtk.IMContext self* Returns: {none}	Gtk.IMContext
	retrieve_surrounding (IMContext *self) : gboolean The ::retrieve-surrounding signal is emitted when the input method requires the context surrounding the cursor. The ::retrieve-surrounding signal is emitted when the input method requires the context surrounding the cursor. The callback should set the input method surrounding context by calling the gtk_im_context_set_surrounding() method. Parameters: Gtk.IMContext self* Returns: {gboolean}	Gtk.IMContext

Used by These Methods / Signals / Properties
Class / Namespace	Method / Signal / Properties
WebKit.WebView Property	im_context : Gtk.IMContext read only The GtkIMMulticontext for the WebKitWebView.