IMContextProtocol

public protocol IMContextProtocol : ObjectProtocol

GtkIMContext defines the interface for GTK input methods.

GtkIMContext is used by GTK text input widgets like GtkText to map from key events to Unicode character strings.

An input method may consume multiple key events in sequence before finally outputting 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. To do so, the GtkIMContext will emit [signalGtk.IMContext::preedit-start], [signalGtk.IMContext::preedit-changed] and [signalGtk.IMContext::preedit-end] signals.

For instance, the built-in GTK input method [classGtk.IMContextSimple] implements the input of arbitrary Unicode code points by holding down the <kbd>Control</kbd> and <kbd>Shift</kbd> keys and then typing <kbd>u</kbd> followed by the hexadecimal digits of the code point. When releasing the <kbd>Control</kbd> and <kbd>Shift</kbd> keys, preediting ends and the character is inserted as text. For example,

Ctrl+Shift+u 2 0 A C

results in the € sign.

Additional input methods can be made available for use by GTK widgets as loadable modules. An input method module is a small shared library which provides a GIOExtension for the extension point named “gtk-im-module”.

To connect a widget to the users preferred input method, you should use [classGtk.IMMulticontext].

The IMContextProtocol protocol exposes the methods and properties of an underlying GtkIMContext instance. The default implementation of these can be found in the protocol extension below. For a concrete class that implements these methods and properties, see IMContext. Alternatively, use IMContextRef as a lighweight, unowned reference if you already have an instance you just want to use.

Show on GitHub

ptr
Untyped pointer to the underlying GtkIMContext instance.
Declaration
Swift

var ptr: UnsafeMutableRawPointer! { get }
Show on GitHub
im_context_ptr Default implementation
Typed pointer to the underlying GtkIMContext instance.

Default Implementation

Return the stored, untyped pointer as a typed pointer to the GtkIMContext instance.
Declaration
Swift

var im_context_ptr: UnsafeMutablePointer<GtkIMContext>! { get }
Show on GitHub
init(raw:)
Required Initialiser for types conforming to IMContextProtocol
Declaration
Swift

init(raw: UnsafeMutableRawPointer)
Show on GitHub

IMContext Class


                    
                    
                    bind(property:to:_:flags:transformFrom:transformTo:)

Extension method

Bind a IMContextPropertyName source property to a given target object.

Declaration

Swift

@discardableResult
@inlinable
func bind<Q, T>(property source_property: IMContextPropertyName, to target: T, _ target_property: Q, flags f: BindingFlags = .default, transformFrom transform_from: @escaping GLibObject.ValueTransformer = { $0.transform(destValue: $1) }, transformTo transform_to: @escaping GLibObject.ValueTransformer = { $0.transform(destValue: $1) }) -> BindingRef! where Q : PropertyNameProtocol, T : ObjectProtocol

Parameters

`source_property`	the source property to bind
`target`	the target object to bind to
`target_property`	the target property to bind to
`flags`	the flags to pass to the `Binding`
`transform_from`	`ValueTransformer` to use for forward transformation
`transform_to`	`ValueTransformer` to use for backwards transformation

Return Value

binding reference or nil in case of an error

Show on GitHub


                    
                    
                    get(property:)

Extension method

Get the value of a IMContext property

Declaration

Swift

@inlinable
func get(property: IMContextPropertyName) -> GLibObject.Value

Parameters


                                property

the property to get the value for

Return Value

the value of the named property

Show on GitHub


                    
                    
                    set(property:value:)

Extension method

Set the value of a IMContext property. Note that this will only have an effect on properties that are writable and not construct-only!

Declaration

Swift

@inlinable
func set(property: IMContextPropertyName, value v: GLibObject.Value)

Parameters


                                property

the property to get the value for

Return Value

the value of the named property

Show on GitHub

IMContext signals


                    
                    
                    connect(signal:flags:handler:)

Extension method

Connect a Swift signal handler to the given, typed IMContextSignalName signal

Declaration

Swift

@discardableResult
@inlinable
func connect(signal s: IMContextSignalName, flags f: ConnectFlags = ConnectFlags(0), handler h: @escaping SignalHandler) -> Int

Parameters

`signal`	The signal to connect
`flags`	The connection flags to use
`data`	A pointer to user data to provide to the callback
`destroyData`	A `GClosureNotify` C function to destroy the data pointed to by `userData`
`handler`	The Swift signal handler (function or callback) to invoke on the given signal

Return Value

The signal handler ID (always greater than 0 for successful connections)

Show on GitHub


                    
                    
                    connect(signal:flags:data:destroyData:signalHandler:)

Extension method

Connect a C signal handler to the given, typed IMContextSignalName signal

Declaration

Swift

@discardableResult
@inlinable
func connect(signal s: IMContextSignalName, flags f: ConnectFlags = ConnectFlags(0), data userData: gpointer!, destroyData destructor: GClosureNotify? = nil, signalHandler h: @escaping GCallback) -> Int

Parameters

`signal`	The signal to connect
`flags`	The connection flags to use
`data`	A pointer to user data to provide to the callback
`destroyData`	A `GClosureNotify` C function to destroy the data pointed to by `userData`
`signalHandler`	The C function to be called on the given signal

Return Value

The signal handler ID (always greater than 0 for successful connections)

Show on GitHub


                    
                    
                    onCommit(flags:handler:)

Extension method

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 preedit-end.

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

Note

This represents the underlying commit signal

Declaration

Swift

@discardableResult
@inlinable
func onCommit(flags: ConnectFlags = ConnectFlags(0), handler: @escaping (_ unownedSelf: IMContextRef, _ str: String) -> Void) -> Int

Parameters

`flags`	Flags
`unownedSelf`	Reference to instance of self
`str`	the completed `character(s)` entered by the user
`handler`	The signal handler to call Run the given callback whenever the `commit` signal is emitted

Show on GitHub

commitSignal Extension method
Typed commit signal for using the connect(signal:) methods
Declaration
Swift

static var commitSignal: IMContextSignalName { get }
Show on GitHub


                    
                    
                    onDeleteSurrounding(flags:handler:)

Extension method

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

Note

This represents the underlying delete-surrounding signal

Declaration

Swift

@discardableResult
@inlinable
func onDeleteSurrounding(flags: ConnectFlags = ConnectFlags(0), handler: @escaping (_ unownedSelf: IMContextRef, _ offset: Int, _ nChars: Int) -> Bool) -> Int

Parameters

`flags`	Flags
`unownedSelf`	Reference to instance of self
`offset`	the character offset from the cursor position of the text to be deleted. A negative value indicates a position before the cursor.
`nChars`	the number of characters to be deleted
`handler`	`true` if the signal was handled. Run the given callback whenever the `deleteSurrounding` signal is emitted

Show on GitHub

deleteSurroundingSignal Extension method
Typed delete-surrounding signal for using the connect(signal:) methods
Declaration
Swift

static var deleteSurroundingSignal: IMContextSignalName { get }
Show on GitHub


                    
                    
                    onPreeditChanged(flags:handler:)

Extension method

The preedit-changed 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 [methodGtk.IMContext.get_preedit_string] returns the empty string.

Note

This represents the underlying preedit-changed signal

Declaration

Swift

@discardableResult
@inlinable
func onPreeditChanged(flags: ConnectFlags = ConnectFlags(0), handler: @escaping (_ unownedSelf: IMContextRef) -> Void) -> Int

Parameters

`flags`	Flags
`unownedSelf`	Reference to instance of self
`handler`	The signal handler to call Run the given callback whenever the `preeditChanged` signal is emitted

Show on GitHub

preeditChangedSignal Extension method
Typed preedit-changed signal for using the connect(signal:) methods
Declaration
Swift

static var preeditChangedSignal: IMContextSignalName { get }
Show on GitHub


                    
                    
                    onPreeditEnd(flags:handler:)

Extension method

The preedit-end signal is emitted when a preediting sequence has been completed or canceled.

Note

This represents the underlying preedit-end signal

Declaration

Swift

@discardableResult
@inlinable
func onPreeditEnd(flags: ConnectFlags = ConnectFlags(0), handler: @escaping (_ unownedSelf: IMContextRef) -> Void) -> Int

Parameters

`flags`	Flags
`unownedSelf`	Reference to instance of self
`handler`	The signal handler to call Run the given callback whenever the `preeditEnd` signal is emitted

Show on GitHub

preeditEndSignal Extension method
Typed preedit-end signal for using the connect(signal:) methods
Declaration
Swift

static var preeditEndSignal: IMContextSignalName { get }
Show on GitHub


                    
                    
                    onPreeditStart(flags:handler:)

Extension method

The preedit-start signal is emitted when a new preediting sequence starts.

Note

This represents the underlying preedit-start signal

Declaration

Swift

@discardableResult
@inlinable
func onPreeditStart(flags: ConnectFlags = ConnectFlags(0), handler: @escaping (_ unownedSelf: IMContextRef) -> Void) -> Int

Parameters

`flags`	Flags
`unownedSelf`	Reference to instance of self
`handler`	The signal handler to call Run the given callback whenever the `preeditStart` signal is emitted

Show on GitHub

preeditStartSignal Extension method
Typed preedit-start signal for using the connect(signal:) methods
Declaration
Swift

static var preeditStartSignal: IMContextSignalName { get }
Show on GitHub


                    
                    
                    onRetrieveSurrounding(flags:handler:)

Extension method

The retrieve-surrounding 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 [methodGtk.IMContext.set_surrounding] method.

Note

This represents the underlying retrieve-surrounding signal

Declaration

Swift

@discardableResult
@inlinable
func onRetrieveSurrounding(flags: ConnectFlags = ConnectFlags(0), handler: @escaping (_ unownedSelf: IMContextRef) -> Bool) -> Int

Parameters

`flags`	Flags
`unownedSelf`	Reference to instance of self
`handler`	`true` if the signal was handled. Run the given callback whenever the `retrieveSurrounding` signal is emitted

Show on GitHub

retrieveSurroundingSignal Extension method
Typed retrieve-surrounding signal for using the connect(signal:) methods
Declaration
Swift

static var retrieveSurroundingSignal: IMContextSignalName { get }
Show on GitHub


                    
                    
                    onNotifyInputHints(flags:handler:)

Extension method

The notify signal is emitted on an object when one of its properties has its value set through g_object_set_property(), g_object_set(), et al.

Note that getting this signal doesn’t itself guarantee that the value of the property has actually changed. When it is emitted is determined by the derived GObject class. If the implementor did not create the property with G_PARAM_EXPLICIT_NOTIFY, then any call to g_object_set_property() results in notify being emitted, even if the new value is the same as the old. If they did pass G_PARAM_EXPLICIT_NOTIFY, then this signal is emitted only when they explicitly call g_object_notify() or g_object_notify_by_pspec(), and common practice is to do that only when the value has actually changed.

This signal is typically used to obtain change notification for a single property, by specifying the property name as a detail in the g_signal_connect() call, like this:

(C Language Example):

g_signal_connect (text_view->buffer, "notify::paste-target-list",
                  G_CALLBACK (gtk_text_view_target_list_notify),
                  text_view)

It is important to note that you must use canonical parameter names as detail strings for the notify signal.

Note

This represents the underlying notify::input-hints signal

Declaration

Swift

@discardableResult
@inlinable
func onNotifyInputHints(flags: ConnectFlags = ConnectFlags(0), handler: @escaping (_ unownedSelf: IMContextRef, _ pspec: ParamSpecRef) -> Void) -> Int

Parameters

`flags`	Flags
`unownedSelf`	Reference to instance of self
`pspec`	the `GParamSpec` of the property which changed.
`handler`	The signal handler to call Run the given callback whenever the `notifyInputHints` signal is emitted

Show on GitHub

notifyInputHintsSignal Extension method
Typed notify::input-hints signal for using the connect(signal:) methods
Declaration
Swift

static var notifyInputHintsSignal: IMContextSignalName { get }
Show on GitHub


                    
                    
                    onNotifyInputPurpose(flags:handler:)

Extension method

The notify signal is emitted on an object when one of its properties has its value set through g_object_set_property(), g_object_set(), et al.

This signal is typically used to obtain change notification for a single property, by specifying the property name as a detail in the g_signal_connect() call, like this:

(C Language Example):

g_signal_connect (text_view->buffer, "notify::paste-target-list",
                  G_CALLBACK (gtk_text_view_target_list_notify),
                  text_view)

It is important to note that you must use canonical parameter names as detail strings for the notify signal.

Note

This represents the underlying notify::input-purpose signal

Declaration

Swift

@discardableResult
@inlinable
func onNotifyInputPurpose(flags: ConnectFlags = ConnectFlags(0), handler: @escaping (_ unownedSelf: IMContextRef, _ pspec: ParamSpecRef) -> Void) -> Int

Parameters

`flags`	Flags
`unownedSelf`	Reference to instance of self
`pspec`	the `GParamSpec` of the property which changed.
`handler`	The signal handler to call Run the given callback whenever the `notifyInputPurpose` signal is emitted

Show on GitHub

notifyInputPurposeSignal Extension method
Typed notify::input-purpose signal for using the connect(signal:) methods
Declaration
Swift

static var notifyInputPurposeSignal: IMContextSignalName { get }
Show on GitHub

IMContext Class: IMContextProtocol extension (methods and fields)

deleteSurrounding(offset:nChars:) Extension method
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 n_chars 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 [methodGtk.IMContext.get_surrounding] 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 subsitutions in the existing text in response to new input. It is not useful for applications.
Declaration
Swift

@inlinable func deleteSurrounding(offset: Int, nChars: Int) -> Bool
Show on GitHub


                    
                    
                    filterKey(press:surface:device:time:keycode:state:group:)

Extension method

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

Declaration

Swift

@inlinable
func filterKey<DeviceT, SurfaceT>(press: Bool, surface: SurfaceT, device: DeviceT, time: guint32, keycode: Int, state: Gdk.ModifierType, group: Int) -> Bool where DeviceT : DeviceProtocol, SurfaceT : SurfaceProtocol

Show on GitHub

filterKeypress(event:) Extension method
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.
Declaration
Swift

@inlinable func filterKeypress<EventT>(event: EventT) -> Bool where EventT : EventProtocol
Show on GitHub
focusIn() Extension method
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.
Declaration
Swift

@inlinable func focusIn()
Show on GitHub
focusOut() Extension method
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.
Declaration
Swift

@inlinable func focusOut()
Show on GitHub
getPreeditString(str:attrs:cursorPos:) Extension method
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.
Declaration
Swift

@inlinable func getPreeditString(str: UnsafeMutablePointer<UnsafeMutablePointer<CChar>?>!, attrs: UnsafeMutablePointer<UnsafeMutablePointer<PangoAttrList>?>!, cursorPos: UnsafeMutablePointer<gint>!)
Show on GitHub
getSurrounding(text:cursorIndex:) Extension method
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 [signalGtk.IMContext::retrieve-surrounding] 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 [methodGtk.IMContext.set_surrounding].

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.

get_surrounding is deprecated: Use [method@Gtk.IMContext.get_surrounding_with_selection] instead.
Declaration
Swift

@available(*, deprecated) @inlinable func getSurrounding(text: UnsafeMutablePointer<UnsafeMutablePointer<CChar>?>!, cursorIndex: UnsafeMutablePointer<gint>!) -> Bool
Show on GitHub
getSurroundingWithSelection(text:cursorIndex:anchorIndex:) Extension method
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 [signalGtk.IMContext::retrieve-surrounding] 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 [methodGtk.IMContext.set_surrounding_with_selection].

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.
Declaration
Swift

@inlinable func getSurroundingWithSelection(text: UnsafeMutablePointer<UnsafeMutablePointer<CChar>?>!, cursorIndex: UnsafeMutablePointer<gint>!, anchorIndex: UnsafeMutablePointer<gint>!) -> Bool
Show on GitHub
reset() Extension method
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.
Declaration
Swift

@inlinable func reset()
Show on GitHub
setClient(widget:) Extension method
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.
Declaration
Swift

@inlinable func setClient(widget: WidgetRef? = nil)
Show on GitHub
setClient(widget:) Extension method
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.
Declaration
Swift

@inlinable func setClient<WidgetT>(widget: WidgetT?) where WidgetT : WidgetProtocol
Show on GitHub
setCursorLocation(area:) Extension method
Notify the input method that a change in cursor position has been made.

The location is relative to the client widget.
Declaration
Swift

@inlinable func setCursorLocation<RectangleT>(area: RectangleT) where RectangleT : RectangleProtocol
Show on GitHub
setSurrounding(text:len:cursorIndex:) Extension method
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.

set_surrounding is deprecated: Use [method@Gtk.IMContext.set_surrounding_with_selection] instead
Declaration
Swift

@available(*, deprecated) @inlinable func setSurrounding(text: UnsafePointer<CChar>!, len: Int, cursorIndex: Int)
Show on GitHub
setSurroundingWithSelection(text:len:cursorIndex:anchorIndex:) Extension method
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.
Declaration
Swift

@inlinable func setSurroundingWithSelection(text: UnsafePointer<CChar>!, len: Int, cursorIndex: Int, anchorIndex: Int)
Show on GitHub
set(usePreedit:) Extension method
Sets whether the IM context should use the preedit string to display feedback.

If use_preedit 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.
Declaration
Swift

@inlinable func set(usePreedit: Bool)
Show on GitHub
parentInstance Extension method
Undocumented
Declaration
Swift

@inlinable var parentInstance: GObject { get }
Show on GitHub

IMContextProtocol

Declaration

Default Implementation

Declaration

Declaration

IMContext Class

Declaration

Parameters

Return Value

Declaration

Parameters

Return Value

Declaration

Parameters

Return Value

IMContext signals

Declaration

Parameters

Return Value

Declaration

Parameters

Return Value

Declaration

Parameters

Declaration

Declaration

Parameters

Declaration

Declaration

Parameters

Declaration

Declaration

Parameters

Declaration

Declaration

Parameters

Declaration

Declaration

Parameters

Declaration

Declaration

Parameters

Declaration

Declaration

Parameters

Declaration

IMContext Class: IMContextProtocol extension (methods and fields)

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration