IMContext

open class IMContext : GLibObject.Object, IMContextProtocol

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 IMContext type acts as a reference-counted owner of an underlying GtkIMContext instance. It provides the methods that can operate on this data type through IMContextProtocol conformance. Use IMContext as a strong reference or owner of a GtkIMContext instance.

Show on GitHub 
  • Designated initialiser from the underlying `C` data type.

    This creates an instance without performing an unbalanced retain i.e., ownership is transferred to the IMContext instance.

    Declaration

    Swift

    @inlinable
public init(_ op: UnsafeMutablePointer<GtkIMContext>)

    Parameters

    op

    pointer to the underlying object
    Show on GitHub

  • Designated initialiser from a constant pointer to the underlying C data type. This creates an instance without performing an unbalanced retain i.e., ownership is transferred to the IMContext instance.

    Declaration

    Swift

    @inlinable
public init(_ op: UnsafePointer<GtkIMContext>)

    Parameters

    op

    pointer to the underlying object
    Show on GitHub

  • Optional initialiser from a non-mutating gpointer to the underlying C data type. This creates an instance without performing an unbalanced retain i.e., ownership is transferred to the IMContext instance.

    Declaration

    Swift

    @inlinable
override public init!(gpointer op: gpointer?)

    Parameters

    op

    gpointer to the underlying object
    Show on GitHub

  • Optional initialiser from a non-mutating gconstpointer to the underlying C data type. This creates an instance without performing an unbalanced retain i.e., ownership is transferred to the IMContext instance.

    Declaration

    Swift

    @inlinable
override public init!(gconstpointer op: gconstpointer?)

    Parameters

    op

    pointer to the underlying object
    Show on GitHub

  • Optional initialiser from a constant pointer to the underlying C data type. This creates an instance without performing an unbalanced retain i.e., ownership is transferred to the IMContext instance.

    Declaration

    Swift

    @inlinable
public init!(_ op: UnsafePointer<GtkIMContext>?)

    Parameters

    op

    pointer to the underlying object
    Show on GitHub

  • Optional initialiser from the underlying C data type. This creates an instance without performing an unbalanced retain i.e., ownership is transferred to the IMContext instance.

    Declaration

    Swift

    @inlinable
public init!(_ op: UnsafeMutablePointer<GtkIMContext>?)

    Parameters

    op

    pointer to the underlying object
    Show on GitHub

  • Designated initialiser from the underlying C data type. Will retain GtkIMContext. i.e., ownership is transferred to the IMContext instance.

    Declaration

    Swift

    @inlinable
public init(retaining op: UnsafeMutablePointer<GtkIMContext>)

    Parameters

    op

    pointer to the underlying object
    Show on GitHub

  • Reference intialiser for a related type that implements IMContextProtocol Will retain GtkIMContext.

    Declaration

    Swift

    @inlinable
public init<T>(iMContext other: T) where T : IMContextProtocol

    Parameters

    other

    an instance of a related type that implements IMContextProtocol
    Show on GitHub

  • Unsafe typed initialiser. Do not use unless you know the underlying data type the pointer points to conforms to IMContextProtocol.

    Declaration

    Swift

    @inlinable
override public init<T>(cPointer p: UnsafeMutablePointer<T>)

    Parameters

    cPointer

    pointer to the underlying object
    Show on GitHub

  • Unsafe typed, retaining initialiser. Do not use unless you know the underlying data type the pointer points to conforms to IMContextProtocol.

    Declaration

    Swift

    @inlinable
override public init<T>(retainingCPointer cPointer: UnsafeMutablePointer<T>)

    Parameters

    cPointer

    pointer to the underlying object
    Show on GitHub

  • Unsafe untyped initialiser. Do not use unless you know the underlying data type the pointer points to conforms to IMContextProtocol.

    Declaration

    Swift

    @inlinable
override public init(raw p: UnsafeRawPointer)

    Parameters

    p

    raw pointer to the underlying object
    Show on GitHub

  • Unsafe untyped, retaining initialiser. Do not use unless you know the underlying data type the pointer points to conforms to IMContextProtocol.

    Declaration

    Swift

    @inlinable
override public init(retainingRaw raw: UnsafeRawPointer)
    Show on GitHub

  • Unsafe untyped initialiser. Do not use unless you know the underlying data type the pointer points to conforms to IMContextProtocol.

    Declaration

    Swift

    @inlinable
public required init(raw p: UnsafeMutableRawPointer)

    Parameters

    p

    mutable raw pointer to the underlying object
    Show on GitHub

  • Unsafe untyped, retaining initialiser. Do not use unless you know the underlying data type the pointer points to conforms to IMContextProtocol.

    Declaration

    Swift

    @inlinable
required public init(retainingRaw raw: UnsafeMutableRawPointer)

    Parameters

    raw

    mutable raw pointer to the underlying object
    Show on GitHub

  • Unsafe untyped initialiser. Do not use unless you know the underlying data type the pointer points to conforms to IMContextProtocol.

    Declaration

    Swift

    @inlinable
override public init(opaquePointer p: OpaquePointer)

    Parameters

    p

    opaque pointer to the underlying object
    Show on GitHub

  • Unsafe untyped, retaining initialiser. Do not use unless you know the underlying data type the pointer points to conforms to IMContextProtocol.

    Declaration

    Swift

    @inlinable
override public init(retainingOpaquePointer p: OpaquePointer)

    Parameters

    p

    opaque pointer to the underlying object
    Show on GitHub