Accessible

interface Accessible

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

Every accessible implementation has:

  • a “role”, represented by a value of the enum@Gtk.AccessibleRole enumeration

  • an “attribute”, represented by a set of enum@Gtk.AccessibleState, enum@Gtk.AccessibleProperty and enum@Gtk.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 property@Gtk.Widget:visible property.

Every accessible implementation is part of a tree of accessible objects. Normally, this tree corresponds to the widget tree, but can be customized by reimplementing the vfunc@Gtk.Accessible.get_accessible_parent, vfunc@Gtk.Accessible.get_first_accessible_child and vfunc@Gtk.Accessible.get_next_accessible_sibling virtual functions. Note that you can not create a top-level accessible object as of now, which means that you must always have a parent accessible object. Also note that when an accessible object does not correspond to a widget, and it has children, whose implementation you don't control, it is necessary to ensure the correct shape of the a11y tree by calling method@Gtk.Accessible.set_accessible_parent and updating the sibling by method@Gtk.Accessible.update_next_accessible_sibling.

Skipped during bindings generation

  • parameter x: x: Out parameter is not supported

  • parameter properties: Array parameter of type AccessibleProperty is not supported

  • parameter relations: Array parameter of type AccessibleRelation is not supported

  • parameter states: Array parameter of type AccessibleState is not supported

Inheritors

Types

Link copied to clipboard
object Companion

Properties

Link copied to clipboard

The accessible role of the given GtkAccessible implementation.

Link copied to clipboard
abstract val gtkAccessiblePointer: <Error class: unknown class><<Error class: unknown class>>

Functions

Link copied to clipboard
open fun announce(message: String, priority: AccessibleAnnouncementPriority)

Requests the user's screen reader to announce the given message.

Link copied to clipboard

Retrieves the accessible parent for an accessible object.

Link copied to clipboard

Retrieves the accessible role of an accessible object.

Link copied to clipboard

Retrieves the accessible implementation for the given GtkAccessible.

Link copied to clipboard

Retrieves the first accessible child of an accessible object.

Link copied to clipboard

Retrieves the next accessible sibling of an accessible object

Link copied to clipboard

Query a platform state, such as focus.

Link copied to clipboard
open fun resetProperty(property: AccessibleProperty)

Resets the accessible @property to its default value.

Link copied to clipboard
open fun resetRelation(relation: AccessibleRelation)

Resets the accessible @relation to its default value.

Link copied to clipboard
open fun resetState(state: AccessibleState)

Resets the accessible @state to its default value.

Link copied to clipboard
open fun setAccessibleParent(parent: Accessible? = null, nextSibling: Accessible? = null)

Sets the parent and sibling of an accessible object.

Link copied to clipboard
open fun updateNextAccessibleSibling(newSibling: Accessible? = null)

Updates the next accessible sibling of @self.