IMContextSimple

GtkIMContextSimple is a simple input method context supporting table-based input methods. It has a built-in table of compose sequences that is derived from the X11 Compose files.

GtkIMContextSimple reads additional compose sequences from the first of the following files that is found: ~/.config/gtk-3.0/Compose, ~/.XCompose, /usr/share/X11/locale/$locale/Compose (for locales that have a nontrivial Compose file). The syntax of these files is described in the Compose(5) manual page.

Unicode characters

GtkIMContextSimple also supports numeric entry of Unicode characters by typing Ctrl-Shift-u, 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. ģ.

class IMContextSimple : IMContext {

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

static GType _getGType();

GType _gType [@property getter];

IMContextSimple self();

static IMContextSimpleGidBuilder builder();

this();

void addComposeFile(string composeFile);

}

Constructors

this this(void* ptr, Flag!"Take" take)
this this(): Creates a new #GtkIMContextSimple.

Members

Functions

addComposeFile void addComposeFile(string composeFile): Adds an additional table from the X11 compose file.
self IMContextSimple self(): Returns this, for use in with statements.

Properties

_gType GType _gType [@property getter]

Static functions

_getGType GType _getGType()
builder IMContextSimpleGidBuilder builder(): Get builder for gtk.imcontext_simple.IMContextSimple

Inherited Members

From IMContext

_getGType GType _getGType()
_gType GType _gType [@property getter]
self IMContext self(): Returns this, for use in with statements.
builder IMContextGidBuilder builder(): Get builder for gtk.imcontext.IMContext
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]
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.
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.
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.

gtk imcontext_simple classes