gtk4/org.gtkkn.bindings.gtk/ImContext/ImContextImpl

ImContextImpl

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

The ImContextImpl type represents a native instance of the abstract ImContext class.

Constructors

ImContextImpl

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

Creates a new instance of ImContext for the provided CPointer.

Properties

gtkImContextPointer

val gtkImContextPointer: <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.

deleteSurrounding

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.

emitCommit

fun emitCommit(str: String)

Emits the "commit" signal. See onCommit.

emitPreeditChanged

fun emitPreeditChanged()

Emits the "preedit-changed" signal. See onPreeditChanged.

emitPreeditEnd

fun emitPreeditEnd()

Emits the "preedit-end" signal. See onPreeditEnd.

emitPreeditStart

fun emitPreeditStart()

Emits the "preedit-start" signal. See onPreeditStart.

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

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.

onCommit

fun onCommit(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.

onDeleteSurrounding

fun onDeleteSurrounding(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.

onPreeditChanged

fun onPreeditChanged(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.

onPreeditEnd

fun onPreeditEnd(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.

onPreeditStart

fun onPreeditStart(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.

onRetrieveSurrounding

fun onRetrieveSurrounding(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.

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: <Error class: unknown class>, cursorIndex: <Error class: unknown class>)

Sets surrounding context around the insertion point and preedit string.

setSurroundingWithSelection

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.

setUsePreedit

open fun setUsePreedit(usePreedit: Boolean)

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