Back to Seed Clases







parent-child marker Gtk.IMContext

Class Gtk.IMContext

Import line: 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
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 Defined By
Methods / Constructors
Method / Constructor Defined By
Events - usage syntax: this.signals.EVENTNAME.connect( Function )
Event Defined By
Used by These Methods / Signals / Properties
Class / Namespace Method / Signal / Properties
im_context : Gtk.IMContext read only
The GtkIMMulticontext for the WebKitWebView.
Documentation generated by Introspection Doc Generator Loosely Based on JsDoc Toolkit on Sat Apr 16 2011 17:13:00 GMT+0800 (HKT)