PlugProtocol

public protocol PlugProtocol : ComponentProtocol, ObjectProtocol

See AtkSocket

The PlugProtocol protocol exposes the methods and properties of an underlying AtkPlug 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 Plug. Alternatively, use PlugRef 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 AtkPlug instance.

    Declaration

    Swift

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

    Typed pointer to the underlying AtkPlug instance.

    Default Implementation

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

    Declaration

    Swift

    var plug_ptr: UnsafeMutablePointer<AtkPlug>! { get }
    Show on GitHub

  • Required Initialiser for types conforming to PlugProtocol

    Declaration

    Swift

    init(raw: UnsafeMutableRawPointer)
    Show on GitHub

Plug Class

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

    Declaration

    Swift

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

    Declaration

    Swift

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

    Declaration

    Swift

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

    Parameters

    property

    the property to get the value for

    Return Value

    the value of the named property

    Show on GitHub

Plug Class: PlugProtocol extension (methods and fields)

  • getId() Extension method

    Gets the unique ID of an AtkPlug object, which can be used to embed inside of an AtkSocket using atk_socket_embed().

    Internally, this calls a class function that should be registered by the IPC layer (usually at-spi2-atk). The implementor of an AtkPlug object should call this function (after atk-bridge is loaded) and pass the value to the process implementing the AtkSocket, so it could embed the plug.

    Declaration

    Swift

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

    Sets child as accessible child of plug and plug as accessible parent of child. child can be NULL.

    In some cases, one can not use the AtkPlug type directly as accessible object for the toplevel widget of the application. For instance in the gtk case, GtkPlugAccessible can not inherit both from GtkWindowAccessible and from AtkPlug. In such a case, one can create, in addition to the standard accessible object for the toplevel widget, an AtkPlug object, and make the former the child of the latter by calling atk_plug_set_child().

    Declaration

    Swift

    @inlinable
func set<ObjectT>(child: ObjectT) where ObjectT : ObjectProtocol
    Show on GitHub
  • id Extension method

    Gets the unique ID of an AtkPlug object, which can be used to embed inside of an AtkSocket using atk_socket_embed().

    Internally, this calls a class function that should be registered by the IPC layer (usually at-spi2-atk). The implementor of an AtkPlug object should call this function (after atk-bridge is loaded) and pass the value to the process implementing the AtkSocket, so it could embed the plug.

    Declaration

    Swift

    @inlinable
var id: String! { get }
    Show on GitHub
  • parent Extension method

    Undocumented

    Declaration

    Swift

    @inlinable
var parent: AtkObject { get }
    Show on GitHub