IMContext

gtk.imcontext.IMContext defines the interface for GTK input methods.

gtk.imcontext.IMContext is used by GTK text input widgets like gtk.text.Text to map from key events to Unicode character strings.

An input method may consume multiple key events in sequence before finally outputting 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. To do so, the gtk.imcontext.IMContext will emit signal@Gtk.IMContext::preedit-start, signal@Gtk.IMContext::preedit-changed and signal@Gtk.IMContext::preedit-end signals.

For instance, the built-in GTK input method gtk.imcontext_simple.IMContextSimple implements the input of arbitrary Unicode code points by holding down the <kbd>Control</kbd> and <kbd>Shift</kbd> keys and then typing <kbd>u</kbd> followed by the hexadecimal digits of the code point. When releasing the <kbd>Control</kbd> and <kbd>Shift</kbd> keys, preediting ends and the character is inserted as text. For example,

Ctrl+Shift+u 2 0 A C

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 provides a gio.ioextension.IOExtension for the extension point named "gtk-im-module".

To connect a widget to the users preferred input method, you should use gtk.immulticontext.IMMulticontext.

class IMContext : ObjectG {

bool activateOsk(gdk.event.Event event);

bool deleteSurrounding(int offset, int nChars);

bool filterKey(bool press, gdk.surface.Surface surface, gdk.device.Device device, uint time, uint keycode, gdk.types.ModifierType state, int group);

bool filterKeypress(gdk.event.Event event);

void focusIn();

void focusOut();

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

bool getSurrounding(string text, int cursorIndex);

bool getSurroundingWithSelection(string text, int cursorIndex, int anchorIndex);

void reset();

void setClientWidget(gtk.widget.Widget widget);

void setCursorLocation(gdk.rectangle.Rectangle area);

void setSurrounding(string text, int cursorIndex);

void setSurroundingWithSelection(string text, int cursorIndex, int anchorIndex);

void setUsePreedit(bool usePreedit);

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

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

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

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

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

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

}

Members

Functions

activateOsk bool activateOsk(gdk.event.Event event): Requests the platform to show an on-screen keyboard for user input.
connectCommit ulong connectCommit(T callback, Flag!"After" after): Connect to Commit signal.
connectDeleteSurrounding ulong connectDeleteSurrounding(T callback, Flag!"After" after): Connect to DeleteSurrounding signal.
connectPreeditChanged ulong connectPreeditChanged(T callback, Flag!"After" after): Connect to PreeditChanged signal.
connectPreeditEnd ulong connectPreeditEnd(T callback, Flag!"After" after): Connect to PreeditEnd signal.
connectPreeditStart ulong connectPreeditStart(T callback, Flag!"After" after): Connect to PreeditStart signal.
connectRetrieveSurrounding ulong 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 delete characters around the cursor position by emitting the ::delete_surrounding signal.
filterKey bool filterKey(bool press, gdk.surface.Surface surface, gdk.device.Device device, uint time, uint keycode, gdk.types.ModifierType state, int group): Allow an input method to forward key press and release events to another input method without necessarily having a gdk.event.Event available.
filterKeypress bool filterKeypress(gdk.event.Event event): Allow an input method to internally handle key press and release events.
focusIn void focusIn(): Notify the input method that the widget to which this input context corresponds has gained focus.
focusOut void focusOut(): Notify the input method that the widget to which this input context corresponds has lost focus.
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.
getSurrounding bool getSurrounding(string text, int cursorIndex): Retrieves context around the insertion point.
getSurroundingWithSelection bool getSurroundingWithSelection(string text, int cursorIndex, int anchorIndex): Retrieves context around the insertion point.
reset void reset(): Notify the input method that a change such as a change in cursor position has been made.
setClientWidget void setClientWidget(gtk.widget.Widget widget): Set the client widget for the input context.
setCursorLocation void setCursorLocation(gdk.rectangle.Rectangle area): Notify the input method that a change in cursor position has been made.
setSurrounding void setSurrounding(string text, int cursorIndex): Sets surrounding context around the insertion point and preedit string.
setSurroundingWithSelection void setSurroundingWithSelection(string text, int cursorIndex, int anchorIndex): Sets surrounding context around the insertion point and preedit string. This function is expected to be called in response to the signalGtk.IMContext::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.

Inherited Members

From ObjectG

setGObject void setGObject(void* cObj, Flag!"Take" take): Set the GObject of a D ObjectG 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.
getType GType getType(): Get the GType of an object.
gType GType gType [@property getter]: GObject GType property.
self ObjectG 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 ulong 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.ObjectG 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.ObjectG 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.ObjectG.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.ObjectG.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.ObjectG.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.ObjectG 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.ObjectG.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.ObjectG.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.ObjectG.ref_ and gobject.object.ObjectG.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 ulong connectNotify(string detail, T callback, Flag!"After" after): Connect to Notify signal.

gtk imcontext classes

IMContext