webkit/org.gtkkn.bindings.webkit/InputMethodContext

InputMethodContext

abstract class InputMethodContext(val webkitInputMethodContextPointer: <Error class: unknown class><<Error class: unknown class>>)(source)

Base class for input method contexts.

WebKitInputMethodContext defines the interface to implement WebKit input methods. The input methods are used by WebKit, when editable content is focused, to map from key events to Unicode character strings.

An input method may consume multiple key events in sequence and finally output 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.

Skipped during bindings generation

parameter text: text: Out parameter is not supported

Since

2.28

Inheritors

InputMethodContextImpl

Constructors

InputMethodContext

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

Types

Companion

object Companion

InputMethodContextImpl

class InputMethodContextImpl(pointer: <Error class: unknown class><<Error class: unknown class>>) : InputMethodContext

The InputMethodContextImpl type represents a native instance of the abstract InputMethodContext class.

Properties

inputHints

open var inputHints: InputHints

The #WebKitInputHints of the input associated with this context.

inputPurpose

open var inputPurpose: InputPurpose

The #WebKitInputPurpose of the input associated with this context.

webkitInputMethodContextPointer

val webkitInputMethodContextPointer: <Error class: unknown class><<Error class: unknown class>>

Functions

emitCommitted

fun emitCommitted(text: String)

Emits the "committed" signal. See onCommitted.

emitDeleteSurrounding

fun emitDeleteSurrounding(offset: <Error class: unknown class>, nChars: <Error class: unknown class>)

Emits the "delete-surrounding" signal. See onDeleteSurrounding.

emitPreeditChanged

fun emitPreeditChanged()

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

emitPreeditFinished

fun emitPreeditFinished()

Emits the "preedit-finished" signal. See onPreeditFinished.

emitPreeditStarted

fun emitPreeditStarted()

Emits the "preedit-started" signal. See onPreeditStarted.

filterKeyEvent

open fun filterKeyEvent(keyEvent: <Error class: unknown class>): Boolean

Allow @key_event to be handled by the input method.

notifyCursorArea

open fun notifyCursorArea( x: <Error class: unknown class>, y: <Error class: unknown class>, width: <Error class: unknown class>, height: <Error class: unknown class>)

Notify @context that cursor area changed in input associated.

notifyFocusIn

open fun notifyFocusIn()

Notify @context that input associated has gained focus.

notifyFocusOut

open fun notifyFocusOut()

Notify @context that input associated has lost focus.

notifySurrounding

open fun notifySurrounding( text: String, length: <Error class: unknown class>, cursorIndex: <Error class: unknown class>, selectionIndex: <Error class: unknown class>)

Notify @context that the context surrounding the cursor has changed.

onCommitted

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

Emitted when a complete input sequence has been entered by the user. This can be a single character immediately after a key press or the final result of preediting.

onDeleteSurrounding

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

Emitted when the input method wants to delete the context surrounding the cursor. If @offset is a negative value, it means a position before the cursor.

onPreeditChanged

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

Emitted whenever the preedit sequence currently being entered has changed. It is also emitted at the end of a preedit sequence, in which case webkit_input_method_context_get_preedit() returns the empty string.

onPreeditFinished

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

Emitted when a preediting sequence has been completed or canceled.

onPreeditStarted

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

Emitted when a new preediting sequence starts.

reset

open fun reset()

Reset the @context.

setEnablePreedit

open fun setEnablePreedit(enabled: Boolean)

Set whether @context should enable preedit to display feedback.