IMContext

#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 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 [Running GTK+ Applications][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 gobject.type_module.TypeModule.registerType. Note that gobject.global.typeRegisterStatic 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][gtk-query-immodules-3.0], in order for the new input method to become available to GTK+ applications.

class IMContext : ObjectWrap {

this(void* ptr, Flag!"Take" take);

static GType _getGType();

GType _gType [@property getter];

IMContext self();

static IMContextGidBuilder builder();

gtk.types.InputHints inputHints [@property getter];

gtk.types.InputHints inputHints [@property setter];

gtk.types.InputPurpose inputPurpose [@property getter];

gtk.types.InputPurpose inputPurpose [@property setter];

bool deleteSurrounding(int offset, int nChars);

bool filterKeypress(gdk.event_key.EventKey event);

void focusIn();

void focusOut();

void getPreeditString(string str, pango.attr_list.AttrList attrs, int cursorPos);

bool getSurrounding(string text, int cursorIndex);

void reset();

void setClientWindow(gdk.window.Window window);

void setCursorLocation(gdk.rectangle.Rectangle area);

void setSurrounding(string text, int cursorIndex);

void setUsePreedit(bool usePreedit);

gulong connectCommit(T callback, Flag!"After" after);

gulong connectDeleteSurrounding(T callback, Flag!"After" after);

gulong connectPreeditChanged(T callback, Flag!"After" after);

gulong connectPreeditEnd(T callback, Flag!"After" after);

gulong connectPreeditStart(T callback, Flag!"After" after);

gulong connectRetrieveSurrounding(T callback, Flag!"After" after);

}

Constructors

this this(void* ptr, Flag!"Take" take)

Members

Functions

connectCommit gulong connectCommit(T callback, Flag!"After" after): Connect to Commit signal.
connectDeleteSurrounding gulong connectDeleteSurrounding(T callback, Flag!"After" after): Connect to DeleteSurrounding signal.
connectPreeditChanged gulong connectPreeditChanged(T callback, Flag!"After" after): Connect to PreeditChanged signal.
connectPreeditEnd gulong connectPreeditEnd(T callback, Flag!"After" after): Connect to PreeditEnd signal.
connectPreeditStart gulong connectPreeditStart(T callback, Flag!"After" after): Connect to PreeditStart signal.
connectRetrieveSurrounding gulong connectRetrieveSurrounding(T callback, Flag!"After" after): Connect to RetrieveSurrounding signal.
deleteSurrounding bool deleteSurrounding(int offset, int nChars): 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.
filterKeypress bool filterKeypress(gdk.event_key.EventKey event): 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.
focusIn void focusIn(): 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.
focusOut void focusOut(): 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.
getPreeditString void getPreeditString(string str, pango.attr_list.AttrList attrs, int cursorPos): 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.
getSurrounding bool getSurrounding(string text, int cursorIndex): 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.
reset void reset(): 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.
self IMContext self(): Returns this, for use in with statements.
setClientWindow void setClientWindow(gdk.window.Window 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.
setCursorLocation void setCursorLocation(gdk.rectangle.Rectangle area): Notify the input method that a change in cursor position has been made. The location is relative to the client window.
setSurrounding void setSurrounding(string text, int cursorIndex): 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.
setUsePreedit void setUsePreedit(bool usePreedit): 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.

Properties

_gType GType _gType [@property getter]
inputHints gtk.types.InputHints inputHints [@property getter]
inputHints gtk.types.InputHints inputHints [@property setter]
inputPurpose gtk.types.InputPurpose inputPurpose [@property getter]
inputPurpose gtk.types.InputPurpose inputPurpose [@property setter]

Static functions

_getGType GType _getGType()
builder IMContextGidBuilder builder(): Get builder for gtk.imcontext.IMContext

Inherited Members

From ObjectWrap

_setGObject void _setGObject(void* cObj, Flag!"Take" take): Set the GObject of a D ObjectWrap wrapper.
_cPtr void* _cPtr(Flag!"Dup" dup): Get a pointer to the underlying C object.
_ref void* _ref(void* gObj): Calls g_object_ref() on a GObject.
_unref _unref(void* gObj): Calls g_object_unref() on a GObject.
_getGType GType _getGType(): Get the GType of an object.
_gType GType _gType [@property getter]: GObject GType property.
self ObjectWrap self(): Convenience method to return this cast to a type. For use in D with statements.
_getDObject T _getDObject(void* cptr, Flag!"Take" take): Template to get the D object from a C GObject and cast it to the given D object type.
connectSignalClosure gulong connectSignalClosure(string signalDetail, DClosure closure, Flag!"After" after): Connect a D closure to an object signal.
setProperty void setProperty(string propertyName, T val): Template for setting a GObject property.
getProperty T getProperty(string propertyName): Template for getting a GObject property.
compatControl size_t compatControl(size_t what, void* data)
bindProperty gobject.binding.Binding bindProperty(string sourceProperty, gobject.object.ObjectWrap target, string targetProperty, gobject.types.BindingFlags flags): Creates a binding between source_property on source and target_property on target.
bindPropertyFull gobject.binding.Binding bindPropertyFull(string sourceProperty, gobject.object.ObjectWrap target, string targetProperty, gobject.types.BindingFlags flags, gobject.closure.Closure transformTo, gobject.closure.Closure transformFrom): Creates a binding between source_property on source and target_property on target, allowing you to set the transformation functions to be used by the binding.
forceFloating void forceFloating(): This function is intended for #GObject implementations to re-enforce a floating[floating-ref] object reference. Doing this is seldom required: all #GInitiallyUnowneds are created with a floating reference which usually just needs to be sunken by calling gobject.object.ObjectWrap.refSink.
freezeNotify void freezeNotify(): Increases the freeze count on object. If the freeze count is non-zero, the emission of "notify" signals on object is stopped. The signals are queued until the freeze count is decreased to zero. Duplicate notifications are squashed so that at most one #GObject::notify signal is emitted for each property modified while the object is frozen.
getData void* getData(string key): Gets a named field from the objects table of associations (see gobject.object.ObjectWrap.setData).
getProperty void getProperty(string propertyName, gobject.value.Value value): Gets a property of an object.
getQdata void* getQdata(glib.types.Quark quark): This function gets back user data pointers stored via gobject.object.ObjectWrap.setQdata.
getv void getv(string[] names, gobject.value.Value[] values): Gets n_properties properties for an object. Obtained properties will be set to values. All properties must be valid. Warnings will be emitted and undefined behaviour may result if invalid properties are passed in.
isFloating bool isFloating(): Checks whether object has a floating[floating-ref] reference.
notify void notify(string propertyName): Emits a "notify" signal for the property property_name on object.
notifyByPspec void notifyByPspec(gobject.param_spec.ParamSpec pspec): Emits a "notify" signal for the property specified by pspec on object.
refSink gobject.object.ObjectWrap refSink(): Increase the reference count of object, and possibly remove the floating[floating-ref] reference, if object has a floating reference.
runDispose void runDispose(): Releases all references to other objects. This can be used to break reference cycles.
setData void setData(string key, void* data): Each object carries around a table of associations from strings to pointers. This function lets you set an association.
setProperty void setProperty(string propertyName, gobject.value.Value value): Sets a property on an object.
stealData void* stealData(string key): Remove a specified datum from the object's data associations, without invoking the association's destroy handler.
stealQdata void* stealQdata(glib.types.Quark quark): This function gets back user data pointers stored via gobject.object.ObjectWrap.setQdata and removes the data from object without invoking its destroy() function (if any was set). Usually, calling this function is only required to update user data pointers with a destroy notifier, for example:
thawNotify void thawNotify(): Reverts the effect of a previous call to gobject.object.ObjectWrap.freezeNotify. The freeze count is decreased on object and when it reaches zero, queued "notify" signals are emitted.
watchClosure void watchClosure(gobject.closure.Closure closure): This function essentially limits the life time of the closure to the life time of the object. That is, when the object is finalized, the closure is invalidated by calling gobject.closure.Closure.invalidate on it, in order to prevent invocations of the closure with a finalized (nonexisting) object. Also, gobject.object.ObjectWrap.ref_ and gobject.object.ObjectWrap.unref are added as marshal guards to the closure, to ensure that an extra reference count is held on object during invocation of the closure. Usually, this function will be called on closures that use this object as closure data.
connectNotify gulong connectNotify(string detail, T callback, Flag!"After" after): Connect to Notify signal.

gtk imcontext classes