AccessibleProtocol

public protocol AccessibleProtocol

GtkAccessible is an interface for describing UI elements for Assistive Technologies.

Every accessible implementation has:

  • a “role”, represented by a value of the [enumGtk.AccessibleRole] enumeration
  • an “attribute”, represented by a set of [enumGtk.AccessibleState], [enumGtk.AccessibleProperty] and [enumGtk.AccessibleRelation] values

The role cannot be changed after instantiating a GtkAccessible implementation.

The attributes are updated every time a UI element’s state changes in a way that should be reflected by assistive technologies. For instance, if a GtkWidget visibility changes, the GTK_ACCESSIBLE_STATE_HIDDEN state will also change to reflect the [propertyGtk.Widget:visible] property.

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 Interface

  • 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 Interface: AccessibleProtocol extension (methods and fields)

  • getAccessibleRole() Extension method

    Retrieves the GtkAccessibleRole for the given GtkAccessible.

    Declaration

    Swift

    @inlinable
func getAccessibleRole() -> GtkAccessibleRole
    Show on GitHub
  • reset(property:) Extension method

    Resets the accessible property to its default value.

    Declaration

    Swift

    @inlinable
func reset(property: GtkAccessibleProperty)
    Show on GitHub
  • reset(relation:) Extension method

    Resets the accessible relation to its default value.

    Declaration

    Swift

    @inlinable
func reset(relation: GtkAccessibleRelation)
    Show on GitHub
  • reset(state:) Extension method

    Resets the accessible state to its default value.

    Declaration

    Swift

    @inlinable
func reset(state: GtkAccessibleState)
    Show on GitHub

  • Updates an array of accessible properties.

    This function should be called by GtkWidget types whenever an accessible property change must be communicated to assistive technologies.

    This function is meant to be used by language bindings.

    Declaration

    Swift

    @inlinable
func updatePropertyValue(nProperties: Int, properties: UnsafeMutablePointer<GtkAccessibleProperty>!, values: UnsafePointer<GValue>!)
    Show on GitHub

  • Updates an array of accessible relations.

    This function should be called by GtkWidget types whenever an accessible relation change must be communicated to assistive technologies.

    This function is meant to be used by language bindings.

    Declaration

    Swift

    @inlinable
func updateRelationValue(nRelations: Int, relations: UnsafeMutablePointer<GtkAccessibleRelation>!, values: UnsafePointer<GValue>!)
    Show on GitHub

  • Updates an array of accessible states.

    This function should be called by GtkWidget types whenever an accessible state change must be communicated to assistive technologies.

    This function is meant to be used by language bindings.

    Declaration

    Swift

    @inlinable
func updateStateValue(nStates: Int, states: UnsafeMutablePointer<GtkAccessibleState>!, values: UnsafePointer<GValue>!)
    Show on GitHub

  • Undocumented

    Declaration

    Swift

    @inlinable
func testAccessibleAssertionMessageRole(domain: UnsafePointer<CChar>!, file: UnsafePointer<CChar>!, line: Int, func: UnsafePointer<CChar>!, expr: UnsafePointer<CChar>!, expectedRole: GtkAccessibleRole, actualRole: GtkAccessibleRole)
    Show on GitHub
  • testAccessibleHas(property:) Extension method

    Checks whether the GtkAccessible has property set.

    Declaration

    Swift

    @inlinable
func testAccessibleHas(property: GtkAccessibleProperty) -> Bool
    Show on GitHub
  • testAccessibleHas(relation:) Extension method

    Checks whether the GtkAccessible has relation set.

    Declaration

    Swift

    @inlinable
func testAccessibleHas(relation: GtkAccessibleRelation) -> Bool
    Show on GitHub
  • testAccessibleHas(role:) Extension method

    Checks whether the GtkAccessible:accessible-role of the accessible is role.

    Declaration

    Swift

    @inlinable
func testAccessibleHas(role: GtkAccessibleRole) -> Bool
    Show on GitHub
  • testAccessibleHas(state:) Extension method

    Checks whether the GtkAccessible has state set.

    Declaration

    Swift

    @inlinable
func testAccessibleHas(state: GtkAccessibleState) -> Bool
    Show on GitHub
  • accessibleRole Extension method

    Retrieves the GtkAccessibleRole for the given GtkAccessible.

    Declaration

    Swift

    @inlinable
var accessibleRole: GtkAccessibleRole { get }
    Show on GitHub