gtk4/org.gtkkn.bindings.gtk/IMMulticontext

IMMulticontext

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

GtkIMMulticontext is an input method context supporting multiple, switchable input methods.

Text widgets such as GtkText or GtkTextView use a GtkIMMultiContext to implement their im-module property for switching between different input methods.

Constructors

IMMulticontext

constructor()

Creates a new GtkIMMulticontext.

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

gtkIMMulticontextPointer

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

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.

getContextId

open fun getContextId(): String

Gets the id of the currently active delegate of the @context.

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.

setContextId

open fun setContextId(contextId: String? = null)

Sets the context id for @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.