IMMulticontextProtocol

public protocol IMMulticontextProtocol : IMContextProtocol

GtkIMMulticontext is an input method context supporting multiple, switchable input methods.

Text widgets such as GtkText or GtkTextView use a GtkIMMultiContext to implement their im-module property for switching between different input methods.

The IMMulticontextProtocol protocol exposes the methods and properties of an underlying GtkIMMulticontext 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 IMMulticontext. Alternatively, use IMMulticontextRef 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 GtkIMMulticontext instance.

    Declaration

    Swift

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

    Typed pointer to the underlying GtkIMMulticontext instance.

    Default Implementation

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

    Declaration

    Swift

    var im_multicontext_ptr: UnsafeMutablePointer<GtkIMMulticontext>! { get }
    Show on GitHub

  • Required Initialiser for types conforming to IMMulticontextProtocol

    Declaration

    Swift

    init(raw: UnsafeMutableRawPointer)
    Show on GitHub

IMMulticontext Class

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

    Declaration

    Swift

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

    Declaration

    Swift

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

    Declaration

    Swift

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

    Parameters

    property

    the property to get the value for

    Return Value

    the value of the named property

    Show on GitHub

IMMulticontext Class: IMMulticontextProtocol extension (methods and fields)

  • getContextId() Extension method

    Gets the id of the currently active delegate of the context.

    Declaration

    Swift

    @inlinable
func getContextId() -> String!
    Show on GitHub
  • set(contextId:) Extension method

    Sets the context id for context.

    This causes the currently active delegate of context to be replaced by the delegate corresponding to the new context id.

    Setting this to a non-nil value overrides the system-wide IM module setting. See the [propertyGtk.Settings:gtk-im-module] property.

    Declaration

    Swift

    @inlinable
func set(contextId: UnsafePointer<CChar>? = nil)
    Show on GitHub
  • contextId Extension method

    Gets the id of the currently active delegate of the context.

    Declaration

    Swift

    @inlinable
var contextId: String! { get nonmutating set }
    Show on GitHub
  • object Extension method

    Undocumented

    Declaration

    Swift

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