Package org.gnome.webkit

Class InputMethodContext

java.lang.Object

io.github.jwharm.javagi.base.ProxyInstance

org.gnome.gobject.TypeInstance

org.gnome.gobject.GObject

org.gnome.webkit.InputMethodContext

All Implemented Interfaces:

Proxy

Direct Known Subclasses:

InputMethodContext.InputMethodContextImpl

@Generated("io.github.jwharm.JavaGI")
public abstract class InputMethodContext
extends GObject

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.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	InputMethodContext.Builder<B extends InputMethodContext.Builder<B>>	Inner class implementing a builder pattern to construct a GObject with properties.
static interface	InputMethodContext.CommittedCallback	Functional interface declaration of the CommittedCallback callback.
static interface	InputMethodContext.DeleteSurroundingCallback	Functional interface declaration of the DeleteSurroundingCallback callback.
static class	InputMethodContext.InputMethodContextClass
static class	InputMethodContext.InputMethodContextImpl	The InputMethodContextImpl type represents a native instance of the abstract InputMethodContext class.
static interface	InputMethodContext.PreeditChangedCallback	Functional interface declaration of the PreeditChangedCallback callback.
static interface	InputMethodContext.PreeditFinishedCallback	Functional interface declaration of the PreeditFinishedCallback callback.
static interface	InputMethodContext.PreeditStartedCallback	Functional interface declaration of the PreeditStartedCallback callback.

Nested classes/interfaces inherited from class org.gnome.gobject.GObject

GObject.NotifyCallback, GObject.ObjectClass

Constructor Summary

Constructors

Constructor	Description
InputMethodContext(MemorySegment address)	Create a InputMethodContext proxy instance for the provided memory address.

Method Summary

Modifier and Type	Method	Description
protected InputMethodContext	asParent()	Returns this instance as if it were its parent type.
static InputMethodContext.Builder<? extends InputMethodContext.Builder>	builder()	A InputMethodContext.Builder object constructs a InputMethodContext with the specified properties.
protected void	committed(String text)
protected void	deleteSurrounding(int offset, int nChars)
void	emitCommitted(String text)	Emits the "committed" signal.
void	emitDeleteSurrounding(int offset, int nChars)	Emits the "delete-surrounding" signal.
void	emitPreeditChanged()	Emits the "preedit-changed" signal.
void	emitPreeditFinished()	Emits the "preedit-finished" signal.
void	emitPreeditStarted()	Emits the "preedit-started" signal.
boolean	filterKeyEvent(Event keyEvent)	Allow keyEvent to be handled by the input method.
Set<InputHints>	getInputHints()	Get the value of the WebKitInputMethodContext:input-hints property.
InputPurpose	getInputPurpose()	Get the value of the WebKitInputMethodContext:input-purpose property.
static MemoryLayout	getMemoryLayout()	The memory layout of the native struct.
void	getPreedit(@Nullable Out<String> text, @Nullable Out<List<InputMethodUnderline>> underlines, @Nullable Out<Integer> cursorOffset)	Get the pre-edit string and a list of WebKitInputMethodUnderline.
static Type	getType()	Get the GType of the InputMethodContext class
void	notifyCursorArea(int x, int y, int width, int height)	Notify this InputMethodContext that cursor area changed in input associated.
void	notifyFocusIn()	Notify this InputMethodContext that input associated has gained focus.
void	notifyFocusOut()	Notify this InputMethodContext that input associated has lost focus.
void	notifySurrounding(String text, int length, int cursorIndex, int selectionIndex)	Notify this InputMethodContext that the context surrounding the cursor has changed.
SignalConnection<InputMethodContext.CommittedCallback>	onCommitted(InputMethodContext.CommittedCallback handler)	Emitted when a complete input sequence has been entered by the user.
SignalConnection<InputMethodContext.DeleteSurroundingCallback>	onDeleteSurrounding(InputMethodContext.DeleteSurroundingCallback handler)	Emitted when the input method wants to delete the context surrounding the cursor.
SignalConnection<InputMethodContext.PreeditChangedCallback>	onPreeditChanged(InputMethodContext.PreeditChangedCallback handler)	Emitted whenever the preedit sequence currently being entered has changed.
SignalConnection<InputMethodContext.PreeditFinishedCallback>	onPreeditFinished(InputMethodContext.PreeditFinishedCallback handler)	Emitted when a preediting sequence has been completed or canceled.
SignalConnection<InputMethodContext.PreeditStartedCallback>	onPreeditStarted(InputMethodContext.PreeditStartedCallback handler)	Emitted when a new preediting sequence starts.
protected void	preeditChanged()
protected void	preeditFinished()
protected void	preeditStarted()
void	reset()	Reset the this InputMethodContext.
void	setEnablePreedit(boolean enabled)	Set whether this InputMethodContext should enable preedit to display feedback.
void	setInputHints(Set<InputHints> hints)	Set the value of the WebKitInputMethodContext:input-hints property.
void	setInputHints(InputHints... hints)	Set the value of the WebKitInputMethodContext:input-hints property.
void	setInputPurpose(InputPurpose purpose)	Set the value of the WebKitInputMethodContext:input-purpose property.

Methods inherited from class org.gnome.gobject.GObject

addToggleRef, addWeakPointer, bindProperty, bindProperty, bindProperty, bindPropertyFull, bindPropertyFull, bindPropertyWithClosures, bindPropertyWithClosures, compatControl, connect, connect, connect, constructed, disconnect, dispatchPropertiesChanged, dispose, dupData, dupQdata, emit, emitNotify, finalize_, forceFloating, freezeNotify, get, getData, getProperty, getProperty, getProperty, getQdata, getv, interfaceFindProperty, interfaceInstallProperty, interfaceListProperties, isFloating, newInstance, newInstance, newv, notify, notify, notifyByPspec, onNotify, ref, refSink, removeToggleRef, removeWeakPointer, replaceData, replaceQdata, runDispose, set, setData, setDataFull, setProperty, setProperty, setProperty, setQdata, setQdataFull, setv, stealData, stealQdata, takeRef, thawNotify, unref, watchClosure, weakRef, weakUnref, withProperties

Methods inherited from class org.gnome.gobject.TypeInstance

callParent, callParent, getPrivate, readGClass, writeGClass

Methods inherited from class io.github.jwharm.javagi.base.ProxyInstance

equals, handle, hashCode

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Details

InputMethodContext

public InputMethodContext(MemorySegment address)

Create a InputMethodContext proxy instance for the provided memory address.

Parameters:

address - the memory address of the native object

Method Details

getType

public static Type getType()

Get the GType of the InputMethodContext class

Returns:

the GType

getMemoryLayout

public static MemoryLayout getMemoryLayout()

The memory layout of the native struct.

Returns:

the memory layout

asParent

protected InputMethodContext asParent()

Returns this instance as if it were its parent type. This is mostly synonymous to the Java super keyword, but will set the native typeclass function pointers to the parent type. When overriding a native virtual method in Java, "chaining up" with super.methodName() doesn't work, because it invokes the overridden function pointer again. To chain up, call asParent().methodName(). This will call the native function pointer of this virtual method in the typeclass of the parent type.

Overrides:

asParent in class GObject

filterKeyEvent

public boolean filterKeyEvent(Event keyEvent)

Allow keyEvent to be handled by the input method.

If true is returned, then no further processing should be done for the key event.

Parameters:

keyEvent - the key event to filter

Returns:

true if the key event was handled, or false otherwise

getInputHints

public Set<InputHints> getInputHints()

Get the value of the WebKitInputMethodContext:input-hints property.

Returns:

the WebKitInputHints of the input associated with this InputMethodContext

getInputPurpose

public InputPurpose getInputPurpose()

Get the value of the WebKitInputMethodContext:input-purpose property.

Returns:

the WebKitInputPurpose of the input associated with this InputMethodContext

getPreedit

public void getPreedit(@Nullable
 @Nullable Out<String> text,
 @Nullable
 @Nullable Out<List<InputMethodUnderline>> underlines,
 @Nullable
 @Nullable Out<Integer> cursorOffset)

Get the pre-edit string and a list of WebKitInputMethodUnderline.

Get the current pre-edit string for the this InputMethodContext, and a list of WebKitInputMethodUnderline to apply to the string. The string will be displayed inserted at cursorOffset.

Parameters:

text - location to store the preedit string

underlines - location to store the underlines as a GList of WebKitInputMethodUnderline

cursorOffset - location to store the position of cursor in preedit string

notifyCursorArea

public void notifyCursorArea(int x,
 int y,
 int width,
 int height)

Notify this InputMethodContext that cursor area changed in input associated.

Parameters:

x - the x coordinate of cursor location

y - the y coordinate of cursor location

width - the width of cursor area

height - the height of cursor area

notifyFocusIn

public void notifyFocusIn()

Notify this InputMethodContext that input associated has gained focus.

notifyFocusOut

public void notifyFocusOut()

Notify this InputMethodContext that input associated has lost focus.

notifySurrounding

public void notifySurrounding(String text,
 int length,
 int cursorIndex,
 int selectionIndex)

Notify this InputMethodContext that the context surrounding the cursor has changed.

If there's no selection selectionIndex is the same as cursorIndex.

Parameters:

text - text surrounding the insertion point

length - the length of text, or -1 if text is nul-terminated

cursorIndex - the byte index of the insertion cursor within text.

selectionIndex - the byte index of the selection cursor within text.

reset

public void reset()

Reset the this InputMethodContext.

This will typically cause the input to clear the preedit state.

setEnablePreedit

public void setEnablePreedit(boolean enabled)

Set whether this InputMethodContext should enable preedit to display feedback.

Parameters:

enabled - whether to enable preedit

setInputHints

public void setInputHints(Set<InputHints> hints)

Set the value of the WebKitInputMethodContext:input-hints property.

Parameters:

hints - a WebKitInputHints

setInputHints

public void setInputHints(InputHints... hints)

Set the value of the WebKitInputMethodContext:input-hints property.

Parameters:

hints - a WebKitInputHints

setInputPurpose

public void setInputPurpose(InputPurpose purpose)

Set the value of the WebKitInputMethodContext:input-purpose property.

Parameters:

purpose - a WebKitInputPurpose

committed

protected void committed(String text)

deleteSurrounding

protected void deleteSurrounding(int offset,
 int nChars)

preeditChanged

protected void preeditChanged()

preeditFinished

protected void preeditFinished()

preeditStarted

protected void preeditStarted()

onCommitted

public SignalConnection<InputMethodContext.CommittedCallback> onCommitted(InputMethodContext.CommittedCallback handler)

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.

Parameters:

handler - the signal handler

Returns:

a signal handler ID to keep track of the signal connection

See Also:

• InputMethodContext.CommittedCallback.run(java.lang.String)

emitCommitted

public void emitCommitted(String text)

Emits the "committed" signal. See onCommitted(org.gnome.webkit.InputMethodContext.CommittedCallback).

onDeleteSurrounding

public SignalConnection<InputMethodContext.DeleteSurroundingCallback> onDeleteSurrounding(InputMethodContext.DeleteSurroundingCallback handler)

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.

Parameters:

handler - the signal handler

Returns:

a signal handler ID to keep track of the signal connection

See Also:

• InputMethodContext.DeleteSurroundingCallback.run(int, int)

emitDeleteSurrounding

public void emitDeleteSurrounding(int offset,
 int nChars)

Emits the "delete-surrounding" signal. See onDeleteSurrounding(org.gnome.webkit.InputMethodContext.DeleteSurroundingCallback).

onPreeditChanged

public SignalConnection<InputMethodContext.PreeditChangedCallback> onPreeditChanged(InputMethodContext.PreeditChangedCallback handler)

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.

Parameters:

handler - the signal handler

Returns:

a signal handler ID to keep track of the signal connection

See Also:

• InputMethodContext.PreeditChangedCallback.run()

emitPreeditChanged

public void emitPreeditChanged()

Emits the "preedit-changed" signal. See onPreeditChanged(org.gnome.webkit.InputMethodContext.PreeditChangedCallback).

onPreeditFinished

public SignalConnection<InputMethodContext.PreeditFinishedCallback> onPreeditFinished(InputMethodContext.PreeditFinishedCallback handler)

Emitted when a preediting sequence has been completed or canceled.

Parameters:

handler - the signal handler

Returns:

a signal handler ID to keep track of the signal connection

See Also:

• InputMethodContext.PreeditFinishedCallback.run()

emitPreeditFinished

public void emitPreeditFinished()

Emits the "preedit-finished" signal. See onPreeditFinished(org.gnome.webkit.InputMethodContext.PreeditFinishedCallback).

onPreeditStarted

public SignalConnection<InputMethodContext.PreeditStartedCallback> onPreeditStarted(InputMethodContext.PreeditStartedCallback handler)

Emitted when a new preediting sequence starts.

Parameters:

handler - the signal handler

Returns:

a signal handler ID to keep track of the signal connection

See Also:

• InputMethodContext.PreeditStartedCallback.run()

emitPreeditStarted

public void emitPreeditStarted()

Emits the "preedit-started" signal. See onPreeditStarted(org.gnome.webkit.InputMethodContext.PreeditStartedCallback).

builder

public static InputMethodContext.Builder<? extends InputMethodContext.Builder> builder()

A InputMethodContext.Builder object constructs a InputMethodContext with the specified properties. Use the various set...() methods to set properties, and finish construction with InputMethodContext.Builder.build().