IMContextSimpleProtocol

public protocol IMContextSimpleProtocol : IMContextProtocol

GtkIMContextSimple is an input method supporting table-based input methods.

Compose sequences

GtkIMContextSimple reads compose sequences from the first of the following files that is found: ~/.config/gtk-4.0/Compose, ~/.XCompose, /usr/share/X11/locale/$locale/Compose (for locales that have a nontrivial Compose file). The syntax of these files is described in the Compose(5) manual page.

If none of these files is found, GtkIMContextSimple uses a built-in table of compose sequences that is derived from the X11 Compose files.

Note that compose sequences typically start with the Compose_key, which is often not available as a dedicated key on keyboards. Keyboard layouts may map this keysym to other keys, such as the right Control key.

Unicode characters

GtkIMContextSimple also supports numeric entry of Unicode characters by typing <kbd>Ctrl</kbd>-<kbd>Shift</kbd>-<kbd>u</kbd>, followed by a hexadecimal Unicode codepoint.

For example,

Ctrl-Shift-u 1 2 3 Enter

yields U+0123 LATIN SMALL LETTER G WITH CEDILLA, i.e. ģ.

Dead keys

GtkIMContextSimple supports dead keys. For example, typing

dead_acute a

yields U+00E! LATIN SMALL LETTER_A WITH ACUTE, i.e. á. Note that this depends on the keyboard layout including dead keys.

The IMContextSimpleProtocol protocol exposes the methods and properties of an underlying GtkIMContextSimple 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 IMContextSimple. Alternatively, use IMContextSimpleRef 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 GtkIMContextSimple instance.

    Declaration

    Swift

    var ptr: UnsafeMutableRawPointer! { get }
    Show on GitHub
  • im_context_simple_ptr Default implementation

    Typed pointer to the underlying GtkIMContextSimple instance.

    Default Implementation

    Return the stored, untyped pointer as a typed pointer to the GtkIMContextSimple instance.

    Declaration

    Swift

    var im_context_simple_ptr: UnsafeMutablePointer<GtkIMContextSimple>! { get }
    Show on GitHub

  • Required Initialiser for types conforming to IMContextSimpleProtocol

    Declaration

    Swift

    init(raw: UnsafeMutableRawPointer)
    Show on GitHub

IMContextSimple Class

  • Bind a IMContextSimplePropertyName source property to a given target object.

    Declaration

    Swift

    @discardableResult
@inlinable
func bind<Q, T>(property source_property: IMContextSimplePropertyName, 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 IMContextSimple property

    Declaration

    Swift

    @inlinable
func get(property: IMContextSimplePropertyName) -> 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 IMContextSimple property. Note that this will only have an effect on properties that are writable and not construct-only!

    Declaration

    Swift

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

    Parameters

    property

    the property to get the value for

    Return Value

    the value of the named property

    Show on GitHub

IMContextSimple Class: IMContextSimpleProtocol extension (methods and fields)

  • add(composeFile:) Extension method

    Adds an additional table from the X11 compose file.

    Declaration

    Swift

    @inlinable
func add(composeFile: UnsafePointer<CChar>!)
    Show on GitHub

  • Adds an additional table to search to the input context. Each row of the table consists of max_seq_len key symbols followed by two guint16 interpreted as the high and low words of a gunicode value. Tables are searched starting from the last added.

    The table must be sorted in dictionary order on the numeric value of the key symbol fields. (Values beyond the length of the sequence should be zero.)

    add_table is deprecated: Use gtk_im_context_simple_add_compose_file()

    Declaration

    Swift

    @available(*, deprecated)
@inlinable
func addTable(data: UnsafeMutablePointer<guint16>!, maxSeqLen: Int, nSeqs: Int)
    Show on GitHub
  • object Extension method

    Undocumented

    Declaration

    Swift

    @inlinable
var object: GtkIMContext { get }
    Show on GitHub