Memory-managed wrapper type.

Type class for types which can be safely cast to IMContext, for instance with toIMContext.

Cast to IMContext, for types for which this is known to be safe. For general casts, use castTo.

Asks the widget that the input context is attached to delete characters around the cursor position by emitting the ::delete_surrounding signal.

Note that offset and nChars are in characters not in bytes which differs from the usage other places in GtkIMContext.

In order to use this function, you should first call iMContextGetSurrounding to get the current context, and call this function immediately afterwards to make sure that you know what you are deleting. You should also account for the fact that even if the signal was handled, the input context might not have deleted all the characters that were requested to be deleted.

This function is used by an input method that wants to make substitutions in the existing text in response to new input. It is not useful for applications.

Allow an input method to forward key press and release events to another input method without necessarily having a GdkEvent available.

Allow an input method to internally handle key press and release events.

If this function returns True, then no further processing should be done for this key event.

Notify the input method that the widget to which this input context corresponds has gained focus.

The input method may, for example, change the displayed feedback to reflect this change.

Notify the input method that the widget to which this input context corresponds has lost focus.

The input method may, for example, change the displayed feedback or reset the contexts state to reflect this change.

Retrieve the current preedit string for the input context, and a list of attributes to apply to the string.

This string should be displayed inserted at the insertion point.

Retrieves context around the insertion point.

Input methods typically want context in order to constrain input text based on existing text; this is important for languages such as Thai where only some sequences of characters are allowed.

This function is implemented by emitting the IMContext::retrieveSurrounding signal on the input method; in response to this signal, a widget should provide as much context as is available, up to an entire paragraph, by calling iMContextSetSurrounding.

Note that there is no obligation for a widget to respond to the ::retrieve-surrounding signal, so input methods must be prepared to function without context.

Retrieves context around the insertion point.

Input methods typically want context in order to constrain input text based on existing text; this is important for languages such as Thai where only some sequences of characters are allowed.

This function is implemented by emitting the IMContext::retrieveSurrounding signal on the input method; in response to this signal, a widget should provide as much context as is available, up to an entire paragraph, by calling iMContextSetSurroundingWithSelection.

Note that there is no obligation for a widget to respond to the ::retrieve-surrounding signal, so input methods must be prepared to function without context.

Since: 4.2

Notify the input method that a change such as a change in cursor position has been made.

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

Set the client widget for the input context.

This is the GtkWidget holding the input focus. This widget is used in order to correctly position status windows, and may also be used for purposes internal to the input method.

Notify the input method that a change in cursor position has been made.

The location is relative to the client widget.

Sets surrounding context around the insertion point and preedit string.

This function is expected to be called in response to the IMContext::retrieveSurrounding signal, and will likely have no effect if called at other times.

Sets surrounding context around the insertion point and preedit string. This function is expected to be called in response to the signalgtk.IMContext[retrieve_surrounding] signal, and will likely have no effect if called at other times.

Since: 4.2

Sets whether the IM context should use the preedit string to display feedback.

If usePreedit is False (default is True), then the IM context may use some other method to display feedback, such as displaying it in a child of the root window.

Construct a GValueConstruct with valid value for the “input-hints” property. This is rarely needed directly, but it is used by new.

Get the value of the “input-hints” property. When overloading is enabled, this is equivalent to

get iMContext #inputHints

Set the value of the “input-hints” property. When overloading is enabled, this is equivalent to

set iMContext [ #inputHints := value ]

Construct a GValueConstruct with valid value for the “input-purpose” property. This is rarely needed directly, but it is used by new.

Get the value of the “input-purpose” property. When overloading is enabled, this is equivalent to

get iMContext #inputPurpose

Set the value of the “input-purpose” property. When overloading is enabled, this is equivalent to

set iMContext [ #inputPurpose := value ]

The commit signal is emitted when a complete input sequence has been entered by the user.

If the commit comes after a preediting sequence, the commit signal is emitted after preeditEnd.

This can be a single character immediately after a key press or the final result of preediting.

Connect a signal handler for the commit signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after iMContext #commit callback

By default the object invoking the signal is not passed to the callback. If you need to access it, you can use the implit ?self parameter. Note that this requires activating the ImplicitParams GHC extension.

Connect a signal handler for the commit signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on iMContext #commit callback

The deleteSurrounding signal is emitted when the input method needs to delete all or part of the context surrounding the cursor.

Connect a signal handler for the deleteSurrounding signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after iMContext #deleteSurrounding callback

By default the object invoking the signal is not passed to the callback. If you need to access it, you can use the implit ?self parameter. Note that this requires activating the ImplicitParams GHC extension.

Connect a signal handler for the deleteSurrounding signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on iMContext #deleteSurrounding callback

The preeditChanged signal is emitted whenever the preedit sequence currently being entered has changed.

It is also emitted at the end of a preedit sequence, in which case iMContextGetPreeditString returns the empty string.

Connect a signal handler for the preeditChanged signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after iMContext #preeditChanged callback

By default the object invoking the signal is not passed to the callback. If you need to access it, you can use the implit ?self parameter. Note that this requires activating the ImplicitParams GHC extension.

Connect a signal handler for the preeditChanged signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on iMContext #preeditChanged callback

The preeditEnd signal is emitted when a preediting sequence has been completed or canceled.

Connect a signal handler for the preeditEnd signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after iMContext #preeditEnd callback

By default the object invoking the signal is not passed to the callback. If you need to access it, you can use the implit ?self parameter. Note that this requires activating the ImplicitParams GHC extension.

Connect a signal handler for the preeditEnd signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on iMContext #preeditEnd callback

The preeditStart signal is emitted when a new preediting sequence starts.

Connect a signal handler for the preeditStart signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after iMContext #preeditStart callback

By default the object invoking the signal is not passed to the callback. If you need to access it, you can use the implit ?self parameter. Note that this requires activating the ImplicitParams GHC extension.

Connect a signal handler for the preeditStart signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on iMContext #preeditStart callback

The retrieveSurrounding signal is emitted when the input method requires the context surrounding the cursor.

The callback should set the input method surrounding context by calling the iMContextSetSurrounding method.

Connect a signal handler for the retrieveSurrounding signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after iMContext #retrieveSurrounding callback

By default the object invoking the signal is not passed to the callback. If you need to access it, you can use the implit ?self parameter. Note that this requires activating the ImplicitParams GHC extension.

Connect a signal handler for the retrieveSurrounding signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on iMContext #retrieveSurrounding callback