webkit.input_method_context

Module for [InputMethodContext] class

class InputMethodContext InputMethodContextGidBuilder InputMethodContextGidBuilderImpl

Types 3

classInputMethodContext : gobject.object.ObjectWrap

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.

Methods

GType _getGType()

GType _gType() @property

InputMethodContext self()Returns `this`, for use in `with` statements.

InputMethodContextGidBuilder builder()Get builder for [webkit.inputmethodcontext.InputMethodContext] Returns: New builder object

webkit.types.InputHints inputHints() @propertyGet `inputHints` property. Returns: The #WebKitInputHints of the input associated with this context.

void inputHints(webkit.types.InputHints propval) @propertySet `inputHints` property. Params: propval = The #WebKitInputHints of the input associated with this context.

webkit.types.InputPurpose inputPurpose() @propertyGet `inputPurpose` property. Returns: The #WebKitInputPurpose of the input associated with this context.

void inputPurpose(webkit.types.InputPurpose propval) @propertySet `inputPurpose` property. Params: propval = The #WebKitInputPurpose of the input associated with this context.

bool filterKeyEvent(gdk.event.Event keyEvent)Allow key_event to be handled by the input method.

webkit.types.InputHints getInputHints()Get the value of the #WebKitInputMethodContext:input-hints property. Returns: the #WebKitInputHints of the input associated with context

webkit.types.InputPurpose getInputPurpose()Get the value of the #WebKitInputMethodContext:input-purpose property. Returns: the #WebKitInputPurpose of the input associated with context

void getPreedit(out  string text,  out  webkit.input_method_underline.InputMethodUnderline[]  underlines,  out  uint  cursorOffset)

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

void notifyCursorArea(int x, int y, int width, int height)Notify context that cursor area changed in input associated.

void notifyFocusIn()Notify context that input associated has gained focus.

void notifyFocusOut()Notify context that input associated has lost focus.

void notifySurrounding(string text, uint cursorIndex, uint selectionIndex)Notify context that the context surrounding the cursor has changed.

void reset()Reset the context.

void setEnablePreedit(bool enabled)Set whether context should enable preedit to display feedback.

void setInputHints(webkit.types.InputHints hints)Set the value of the #WebKitInputMethodContext:input-hints property.

void setInputPurpose(webkit.types.InputPurpose purpose)Set the value of the #WebKitInputMethodContext:input-purpose property.

gulong connectCommitted(T)(T callback,  Flag!"After" after =  No.After) if (isCallable!T
    &&  is(ReturnType!T ==  void)
   && (Parameters!T.length <  1 || (ParameterStorageClassTuple!T[0]  ==  ParameterStorageClass.none &&  is(Parameters!T[0]  ==  string)))
   && (Parameters!T.length <  2 || (ParameterStorageClassTuple!T[1]  ==  ParameterStorageClass.none &&  is(Parameters!T[1] :  webkit.input_method_context.InputMethodContext)))
   &&  Parameters!T.length <  3)

Connect to `Committed` signal.

gulong connectDeleteSurrounding(T)(T callback,  Flag!"After" after =  No.After) if (isCallable!T
    &&  is(ReturnType!T ==  void)
   && (Parameters!T.length <  1 || (ParameterStorageClassTuple!T[0]  ==  ParameterStorageClass.none &&  is(Parameters!T[0]  ==  int)))
   && (Parameters!T.length <  2 || (ParameterStorageClassTuple!T[1]  ==  ParameterStorageClass.none &&  is(Parameters!T[1]  ==  uint)))
   && (Parameters!T.length <  3 || (ParameterStorageClassTuple!T[2]  ==  ParameterStorageClass.none &&  is(Parameters!T[2] :  webkit.input_method_context.InputMethodContext)))
   &&  Parameters!T.length <  4)

Connect to `DeleteSurrounding` signal.

gulong connectPreeditChanged(T)(T callback,  Flag!"After" after =  No.After) if (isCallable!T
    &&  is(ReturnType!T ==  void)
   && (Parameters!T.length <  1 || (ParameterStorageClassTuple!T[0]  ==  ParameterStorageClass.none &&  is(Parameters!T[0] :  webkit.input_method_context.InputMethodContext)))
   &&  Parameters!T.length <  2)

Connect to `PreeditChanged` signal.

gulong connectPreeditFinished(T)(T callback,  Flag!"After" after =  No.After) if (isCallable!T
    &&  is(ReturnType!T ==  void)
   && (Parameters!T.length <  1 || (ParameterStorageClassTuple!T[0]  ==  ParameterStorageClass.none &&  is(Parameters!T[0] :  webkit.input_method_context.InputMethodContext)))
   &&  Parameters!T.length <  2)

Connect to `PreeditFinished` signal.

gulong connectPreeditStarted(T)(T callback,  Flag!"After" after =  No.After) if (isCallable!T
    &&  is(ReturnType!T ==  void)
   && (Parameters!T.length <  1 || (ParameterStorageClassTuple!T[0]  ==  ParameterStorageClass.none &&  is(Parameters!T[0] :  webkit.input_method_context.InputMethodContext)))
   &&  Parameters!T.length <  2)

Connect to `PreeditStarted` signal.

Constructors

this(void * ptr, Flag!"Take" take)

classInputMethodContextGidBuilderImpl(T) : gobject.object.ObjectWrapGidBuilderImpl!T

Methods

T inputHints(webkit.types.InputHints propval)Set `inputHints` property. Params: propval = The #WebKitInputHints of the input associated with this context. Returns: Builder instance for fluent chaining

T inputPurpose(webkit.types.InputPurpose propval)Set `inputPurpose` property. Params: propval = The #WebKitInputPurpose of the input associated with this context. Returns: Builder instance for fluent chaining

classInputMethodContextGidBuilder : InputMethodContextGidBuilderImpl!InputMethodContextGidBuilder

Fluent builder for [webkit.input_method_context.InputMethodContext]

Methods

InputMethodContext build()