InputMethodContext

Object Hierarchy:

Description:

[ CCode ( type_id = "webkit_input_method_context_get_type ()" ) ]
[ Version ( since = "2.28" ) ]
public abstract class InputMethodContext : Object

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.

Namespace: WebKit

Package: webkit2gtk-4.1

Content:

Properties:

public InputHints input_hints { get; set; }
The InputHints of the input associated with this context.
public InputPurpose input_purpose { get; set; }
The InputPurpose of the input associated with this context.

Creation methods:

protected InputMethodContext ()

Methods:

public virtual bool filter_key_event (EventKey key_event)
Allow key_event to be handled by the input method.
public InputHints get_input_hints ()
Get the value of the input_hints property.
public InputPurpose get_input_purpose ()
Get the value of the input_purpose property.
public virtual void get_preedit (out string? text, out List<InputMethodUnderline>? underlines, out uint cursor_offset)
Get the pre-edit string and a list of WebKitInputMethodUnderline.
public virtual void notify_cursor_area (int x, int y, int width, int height)
Notify this that cursor area changed in input associated.
public virtual void notify_focus_in ()
Notify this that input associated has gained focus.
public virtual void notify_focus_out ()
Notify this that input associated has lost focus.
public virtual void notify_surrounding (string text, uint length, uint cursor_index, uint selection_index)
Notify this that the context surrounding the cursor has changed.
public virtual void reset ()
Reset the this.
public virtual void set_enable_preedit (bool enabled)
Set whether this should enable preedit to display feedback.
public void set_input_hints (InputHints hints)
Set the value of the input_hints property.
public void set_input_purpose (InputPurpose purpose)
Set the value of the input_purpose property.

Signals:

public virtual signal void committed (string text)
Emitted when a complete input sequence has been entered by the user.
public virtual signal void delete_surrounding (int offset, uint n_chars)
Emitted when the input method wants to delete the context surrounding the cursor.
public virtual signal void preedit_changed ()
Emitted whenever the preedit sequence currently being entered has changed.
public virtual signal void preedit_finished ()
Emitted when a preediting sequence has been completed or canceled.
public virtual signal void preedit_started ()
Emitted when a new preediting sequence starts.

Inherited Members:

All known members inherited from class GLib.Object