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() static nothrow

GType _gType() @property nothrow

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

InputMethodContextGidBuilder builder() static nothrowGet builder for [webkit.input_method_context.InputMethodContext] Returns: New builder object

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

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

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

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

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

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

webkit.types.InputPurpose getInputPurpose() nothrowGet 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)

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

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

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

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

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

void reset() nothrowReset the context.

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

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

void setInputPurpose(webkit.types.InputPurpose purpose) nothrowSet 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)

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

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

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

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

nothrowConnect to `PreeditStarted` signal.

Constructors

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

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

Fluent builder implementation template for webkit.input_method_context.InputMethodContext

Methods

T inputHints(webkit.types.InputHints propval) nothrowSet `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) nothrowSet `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() nothrowCreate object from builder. Returns: New object