InputMethodContext

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.

class InputMethodContext : ObjectG {

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

static GType getGType();

GType gType [@property getter];

InputMethodContext self();

bool filterKeyEvent(gdk.event.Event keyEvent);

webkit.types.InputHints getInputHints();

webkit.types.InputPurpose getInputPurpose();

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

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

void notifyFocusIn();

void notifyFocusOut();

void notifySurrounding(string text, int length, uint cursorIndex, uint selectionIndex);

void reset();

void setEnablePreedit(bool enabled);

void setInputHints(webkit.types.InputHints hints);

void setInputPurpose(webkit.types.InputPurpose purpose);

ulong connectCommitted(T callback, Flag!"After" after);

ulong connectDeleteSurrounding(T callback, Flag!"After" after);

ulong connectPreeditChanged(T callback, Flag!"After" after);

ulong connectPreeditFinished(T callback, Flag!"After" after);

ulong connectPreeditStarted(T callback, Flag!"After" after);

}

Constructors

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

Members

Functions

connectCommitted ulong connectCommitted(T callback, Flag!"After" after): Connect to Committed signal.
connectDeleteSurrounding ulong connectDeleteSurrounding(T callback, Flag!"After" after): Connect to DeleteSurrounding signal.
connectPreeditChanged ulong connectPreeditChanged(T callback, Flag!"After" after): Connect to PreeditChanged signal.
connectPreeditFinished ulong connectPreeditFinished(T callback, Flag!"After" after): Connect to PreeditFinished signal.
connectPreeditStarted ulong connectPreeditStarted(T callback, Flag!"After" after): Connect to PreeditStarted signal.
filterKeyEvent bool filterKeyEvent(gdk.event.Event keyEvent): Allow key_event to be handled by the input method.
getInputHints webkit.types.InputHints getInputHints(): Get the value of the #WebKitInputMethodContext:input-hints property.
getInputPurpose webkit.types.InputPurpose getInputPurpose(): Get the value of the #WebKitInputMethodContext:input-purpose property.
getPreedit void getPreedit(string text, webkit.input_method_underline.InputMethodUnderline[] underlines, uint cursorOffset): Get the pre-edit string and a list of WebKitInputMethodUnderline.
notifyCursorArea void notifyCursorArea(int x, int y, int width, int height): Notify context that cursor area changed in input associated.
notifyFocusIn void notifyFocusIn(): Notify context that input associated has gained focus.
notifyFocusOut void notifyFocusOut(): Notify context that input associated has lost focus.
notifySurrounding void notifySurrounding(string text, int length, uint cursorIndex, uint selectionIndex): Notify context that the context surrounding the cursor has changed.
reset void reset(): Reset the context.
self InputMethodContext self(): Returns this, for use in with statements.
setEnablePreedit void setEnablePreedit(bool enabled): Set whether context should enable preedit to display feedback.
setInputHints void setInputHints(webkit.types.InputHints hints): Set the value of the #WebKitInputMethodContext:input-hints property.
setInputPurpose void setInputPurpose(webkit.types.InputPurpose purpose): Set the value of the #WebKitInputMethodContext:input-purpose property.

Properties

gType GType gType [@property getter]

Static functions

getGType GType getGType()

Inherited Members

From ObjectG

setGObject void setGObject(void* cObj, Flag!"Take" take): Set the GObject of a D ObjectG wrapper.
cPtr void* cPtr(Flag!"Dup" dup): Get a pointer to the underlying C object.
ref_ void* ref_(void* gObj): Calls g_object_ref() on a GObject.
unref unref(void* gObj): Calls g_object_unref() on a GObject.
getType GType getType(): Get the GType of an object.
gType GType gType [@property getter]: GObject GType property.
self ObjectG self(): Convenience method to return this cast to a type. For use in D with statements.
getDObject T getDObject(void* cptr, Flag!"Take" take): Template to get the D object from a C GObject and cast it to the given D object type.
connectSignalClosure ulong connectSignalClosure(string signalDetail, DClosure closure, Flag!"After" after): Connect a D closure to an object signal.
setProperty void setProperty(string propertyName, T val): Template for setting a GObject property.
getProperty T getProperty(string propertyName): Template for getting a GObject property.
compatControl size_t compatControl(size_t what, void* data)
bindProperty gobject.binding.Binding bindProperty(string sourceProperty, gobject.object.ObjectG target, string targetProperty, gobject.types.BindingFlags flags): Creates a binding between source_property on source and target_property on target.
bindPropertyFull gobject.binding.Binding bindPropertyFull(string sourceProperty, gobject.object.ObjectG target, string targetProperty, gobject.types.BindingFlags flags, gobject.closure.Closure transformTo, gobject.closure.Closure transformFrom): Creates a binding between source_property on source and target_property on target, allowing you to set the transformation functions to be used by the binding.
forceFloating void forceFloating(): This function is intended for #GObject implementations to re-enforce a floating[floating-ref] object reference. Doing this is seldom required: all #GInitiallyUnowneds are created with a floating reference which usually just needs to be sunken by calling gobject.object.ObjectG.refSink.
freezeNotify void freezeNotify(): Increases the freeze count on object. If the freeze count is non-zero, the emission of "notify" signals on object is stopped. The signals are queued until the freeze count is decreased to zero. Duplicate notifications are squashed so that at most one #GObject::notify signal is emitted for each property modified while the object is frozen.
getData void* getData(string key): Gets a named field from the objects table of associations (see gobject.object.ObjectG.setData).
getProperty void getProperty(string propertyName, gobject.value.Value value): Gets a property of an object.
getQdata void* getQdata(glib.types.Quark quark): This function gets back user data pointers stored via gobject.object.ObjectG.setQdata.
getv void getv(string[] names, gobject.value.Value[] values): Gets n_properties properties for an object. Obtained properties will be set to values. All properties must be valid. Warnings will be emitted and undefined behaviour may result if invalid properties are passed in.
isFloating bool isFloating(): Checks whether object has a floating[floating-ref] reference.
notify void notify(string propertyName): Emits a "notify" signal for the property property_name on object.
notifyByPspec void notifyByPspec(gobject.param_spec.ParamSpec pspec): Emits a "notify" signal for the property specified by pspec on object.
refSink gobject.object.ObjectG refSink(): Increase the reference count of object, and possibly remove the floating[floating-ref] reference, if object has a floating reference.
runDispose void runDispose(): Releases all references to other objects. This can be used to break reference cycles.
setData void setData(string key, void* data): Each object carries around a table of associations from strings to pointers. This function lets you set an association.
setProperty void setProperty(string propertyName, gobject.value.Value value): Sets a property on an object.
stealData void* stealData(string key): Remove a specified datum from the object's data associations, without invoking the association's destroy handler.
stealQdata void* stealQdata(glib.types.Quark quark): This function gets back user data pointers stored via gobject.object.ObjectG.setQdata and removes the data from object without invoking its destroy() function (if any was set). Usually, calling this function is only required to update user data pointers with a destroy notifier, for example:
thawNotify void thawNotify(): Reverts the effect of a previous call to gobject.object.ObjectG.freezeNotify. The freeze count is decreased on object and when it reaches zero, queued "notify" signals are emitted.
watchClosure void watchClosure(gobject.closure.Closure closure): This function essentially limits the life time of the closure to the life time of the object. That is, when the object is finalized, the closure is invalidated by calling gobject.closure.Closure.invalidate on it, in order to prevent invocations of the closure with a finalized (nonexisting) object. Also, gobject.object.ObjectG.ref_ and gobject.object.ObjectG.unref are added as marshal guards to the closure, to ensure that an extra reference count is held on object during invocation of the closure. Usually, this function will be called on closures that use this object as closure data.
connectNotify ulong connectNotify(string detail, T callback, Flag!"After" after): Connect to Notify signal.

webkit input_method_context classes

InputMethodContext