gtk4/org.gtkkn.bindings.gtk/IMContextSimple

IMContextSimple

open class IMContextSimple(pointer: <Error class: unknown class><<Error class: unknown class>>) : IMContext

GtkIMContextSimple is an input method supporting table-based input methods.

Compose sequences

GtkIMContextSimple 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, GtkIMContextSimple 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

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. ģ.

Dead keys

GtkIMContextSimple 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.

Constructors

IMContextSimple

constructor()

Creates a new GtkIMContextSimple.

constructor(pointer: <Error class: unknown class><<Error class: unknown class>>)

Types

Companion

object Companion

Properties

gtkIMContextPointer

val gtkIMContextPointer: <Error class: unknown class><<Error class: unknown class>>

gtkIMContextSimplePointer

val gtkIMContextSimplePointer: <Error class: unknown class><<Error class: unknown class>>

Functions

activateOsk

open fun activateOsk(event: <Error class: unknown class>? = null): Boolean

Requests the platform to show an on-screen keyboard for user input.

addComposeFile

open fun addComposeFile(composeFile: String)

Adds an additional table from the X11 compose file.

connectCommit

fun connectCommit(connectFlags: <Error class: unknown class> = ConnectFlags(0u), handler: (str: String) -> Unit): <Error class: unknown class>

The ::commit signal is emitted when a complete input sequence has been entered by the user.

connectDeleteSurrounding

fun connectDeleteSurrounding(connectFlags: <Error class: unknown class> = ConnectFlags(0u), handler: (offset: Int, nChars: Int) -> Boolean): <Error class: unknown class>

The ::delete-surrounding signal is emitted when the input method needs to delete all or part of the context surrounding the cursor.

connectPreeditChanged

fun connectPreeditChanged(connectFlags: <Error class: unknown class> = ConnectFlags(0u), handler: () -> Unit): <Error class: unknown class>

The ::preedit-changed signal is emitted whenever the preedit sequence currently being entered has changed.

connectPreeditEnd

fun connectPreeditEnd(connectFlags: <Error class: unknown class> = ConnectFlags(0u), handler: () -> Unit): <Error class: unknown class>

The ::preedit-end signal is emitted when a preediting sequence has been completed or canceled.

connectPreeditStart

fun connectPreeditStart(connectFlags: <Error class: unknown class> = ConnectFlags(0u), handler: () -> Unit): <Error class: unknown class>

The ::preedit-start signal is emitted when a new preediting sequence starts.

connectRetrieveSurrounding

fun connectRetrieveSurrounding(connectFlags: <Error class: unknown class> = ConnectFlags(0u), handler: () -> Boolean): <Error class: unknown class>

The ::retrieve-surrounding signal is emitted when the input method requires the context surrounding the cursor.

deleteSurrounding

open fun deleteSurrounding(offset: Int, nChars: Int): Boolean

Asks the widget that the input context is attached to delete characters around the cursor position by emitting the ::delete_surrounding signal.

filterKey

open fun filterKey(press: Boolean, surface: <Error class: unknown class>, device: <Error class: unknown class>, time: <Error class: unknown class>, keycode: <Error class: unknown class>, state: <Error class: unknown class>, group: Int): Boolean

Allow an input method to forward key press and release events to another input method without necessarily having a GdkEvent available.

filterKeypress

open fun filterKeypress(event: <Error class: unknown class>): Boolean

Allow an input method to internally handle key press and release events.

focusIn

open fun focusIn()

Notify the input method that the widget to which this input context corresponds has gained focus.

focusOut

open fun focusOut()

Notify the input method that the widget to which this input context corresponds has lost focus.

reset

open fun reset()

Notify the input method that a change such as a change in cursor position has been made.

setClientWidget

open fun setClientWidget(widget: Widget? = null)

Set the client widget for the input context.

setCursorLocation

open fun setCursorLocation(area: <Error class: unknown class>)

Notify the input method that a change in cursor position has been made.

setSurrounding

open fun setSurrounding(text: String, len: Int, cursorIndex: Int)

Sets surrounding context around the insertion point and preedit string.

setSurroundingWithSelection

open fun setSurroundingWithSelection(text: String, len: Int, cursorIndex: Int, anchorIndex: Int)

Sets surrounding context around the insertion point and preedit string. This function is expected to be called in response to the signal@Gtk.IMContext::retrieve_surrounding signal, and will likely have no effect if called at other times.

setUsePreedit

open fun setUsePreedit(usePreedit: Boolean)

Sets whether the IM context should use the preedit string to display feedback.