IMContextSimple

gtk.imcontext_simple.IMContextSimple is an input method supporting table-based input methods.

Compose sequences

gtk.imcontext_simple.IMContextSimple reads compose sequences from the first of the following files that is found: ~/.config/gtk-4.0/Compose, ~/.XCompose, /usr/share/X11/locale/$locale/Compose (for locales that have a nontrivial Compose file). A subset of the file syntax described in the Compose(5) manual page is supported. Additionally, include "L" loads GTK’s built-in table of compose sequences rather than the locale-specific one from X11.

If none of these files is found, gtk.imcontext_simple.IMContextSimple uses a built-in table of compose sequences that is derived from the X11 Compose files.

Note that compose sequences typically start with the Compose_key, which is often not available as a dedicated key on keyboards. Keyboard layouts may map this keysym to other keys, such as the right Control key.

Unicode characters

gtk.imcontext_simple.IMContextSimple also supports numeric entry of Unicode characters by typing <kbd>Ctrl</kbd>-<kbd>Shift</kbd>-<kbd>u</kbd>, followed by a hexadecimal Unicode codepoint.

For example,

Ctrl-Shift-u 1 2 3 Enter

yields U+0123 LATIN SMALL LETTER G WITH CEDILLA, i.e. ģ.

Dead keys

gtk.imcontext_simple.IMContextSimple supports dead keys. For example, typing

dead_acute a

yields U+00E! LATIN SMALL LETTER_A WITH ACUTE, i.e. á. Note that this depends on the keyboard layout including dead keys.

class IMContextSimple : IMContext {

this();

void addComposeFile(string composeFile);

}

Constructors

this this(): Creates a new gtk.imcontext_simple.IMContextSimple.

Members

Functions

addComposeFile void addComposeFile(string composeFile): Adds an additional table from the X11 compose file.

Inherited Members

From IMContext

activateOsk bool activateOsk(gdk.event.Event event): Requests the platform to show an on-screen keyboard for user input.
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.
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.

gtk imcontext_simple classes

IMContextSimple