AccessibleProtocol

public protocol AccessibleProtocol : ObjectProtocol

The GtkAccessible class is the base class for accessible implementations for GtkWidget subclasses. It is a thin wrapper around AtkObject, which adds facilities for associating a widget with its accessible object.

An accessible implementation for a third-party widget should derive from GtkAccessible and implement the suitable interfaces from ATK, such as AtkText or AtkSelection. To establish the connection between the widget class and its corresponding acccessible implementation, override the get_accessible vfunc in GtkWidgetClass.

The AccessibleProtocol protocol exposes the methods and properties of an underlying GtkAccessible 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 Accessible. Alternatively, use AccessibleRef 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 GtkAccessible instance.

    Declaration

    Swift

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

    Typed pointer to the underlying GtkAccessible instance.

    Default Implementation

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

    Declaration

    Swift

    var accessible_ptr: UnsafeMutablePointer<GtkAccessible>! { get }
    Show on GitHub

  • Required Initialiser for types conforming to AccessibleProtocol

    Declaration

    Swift

    init(raw: UnsafeMutableRawPointer)
    Show on GitHub

Accessible Class

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

    Declaration

    Swift

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

    Declaration

    Swift

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

    Declaration

    Swift

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

    Parameters

    property

    the property to get the value for

    Return Value

    the value of the named property

    Show on GitHub

Accessible Class: AccessibleProtocol extension (methods and fields)

  • connectWidgetDestroyed() Extension method

    This function specifies the callback function to be called when the widget corresponding to a GtkAccessible is destroyed.

    connect_widget_destroyed is deprecated: Use gtk_accessible_set_widget() and its vfuncs.

    Declaration

    Swift

    @available(*, deprecated)
@inlinable
func connectWidgetDestroyed()
    Show on GitHub
  • getWidget() Extension method

    Gets the GtkWidget corresponding to the GtkAccessible. The returned widget does not have a reference added, so you do not need to unref it.

    Declaration

    Swift

    @inlinable
func getWidget() -> WidgetRef!
    Show on GitHub
  • set(widget:) Extension method

    Sets the GtkWidget corresponding to the GtkAccessible.

    accessible will not hold a reference to widget. It is the caller’s responsibility to ensure that when widget is destroyed, the widget is unset by calling this function again with widget set to nil.

    Declaration

    Swift

    @inlinable
func set(widget: WidgetRef? = nil)
    Show on GitHub
  • set(widget:) Extension method

    Sets the GtkWidget corresponding to the GtkAccessible.

    accessible will not hold a reference to widget. It is the caller’s responsibility to ensure that when widget is destroyed, the widget is unset by calling this function again with widget set to nil.

    Declaration

    Swift

    @inlinable
func set<WidgetT>(widget: WidgetT?) where WidgetT : WidgetProtocol
    Show on GitHub
  • widget Extension method

    Undocumented

    Declaration

    Swift

    @inlinable
var widget: WidgetRef! { get nonmutating set }
    Show on GitHub
  • parent Extension method

    Undocumented

    Declaration

    Swift

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