ImContext

open class ImContext(pointer: <Error class: unknown class><<Error class: unknown class>>)

GtkIMContext defines the interface for GTK input methods.

GtkIMContext is used by GTK text input widgets like GtkText 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 GtkIMContext 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 class@Gtk.IMContextSimple 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. 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 GIOExtension for the extension point named "gtk-im-module".

To connect a widget to the users preferred input method, you should use class@Gtk.IMMulticontext.

Skipped during bindings generation

  • parameter str: str: Out parameter is not supported

  • parameter text: text: Out parameter is not supported

  • parameter text: text: Out parameter is not supported

  • method input-hints: Property has no getter nor setter

  • method input-purpose: Property has no getter nor setter

Inheritors

Constructors

Link copied to clipboard
constructor(pointer: <Error class: unknown class><<Error class: unknown class>>)

Types

Link copied to clipboard
object Companion

Properties

Link copied to clipboard
val gtkIMContextPointer: <Error class: unknown class><<Error class: unknown class>>

Functions

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

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

Link copied to clipboard
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.

Link copied to clipboard
fun connectDeleteSurrounding(connectFlags: <Error class: unknown class> = ConnectFlags(0u), handler: (<Error class: unknown class>, <Error class: unknown class>) -> 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.

Link copied to clipboard
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.

Link copied to clipboard
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.

Link copied to clipboard
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.

Link copied to clipboard
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.

Link copied to clipboard
open fun deleteSurrounding(offset: <Error class: unknown class>, nChars: <Error class: unknown class>): Boolean

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

Link copied to clipboard
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: <Error class: unknown class>): Boolean

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

Link copied to clipboard
open fun filterKeypress(event: <Error class: unknown class>): Boolean

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

Link copied to clipboard
open fun focusIn()

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

Link copied to clipboard
open fun focusOut()

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

Link copied to clipboard
open fun reset()

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

Link copied to clipboard
open fun setClientWidget(widget: Widget? = null)

Set the client widget for the input context.

Link copied to clipboard
open fun setCursorLocation(area: <Error class: unknown class>)

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

Link copied to clipboard
open fun setSurrounding(text: String, len: <Error class: unknown class>, cursorIndex: <Error class: unknown class>)

Sets surrounding context around the insertion point and preedit string.

Link copied to clipboard
open fun setSurroundingWithSelection(text: String, len: <Error class: unknown class>, cursorIndex: <Error class: unknown class>, anchorIndex: <Error class: unknown class>)

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.

Link copied to clipboard
open fun setUsePreedit(usePreedit: Boolean)

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