Accessible

Object Hierarchy:

Description:

[ CCode ( type_cname = "GtkAccessibleInterface" , type_id = "gtk_accessible_get_type ()" ) ]
public interface Accessible : Object

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
“attributes”, 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].

All known implementing classes:

All known sub-interfaces:

AccessibleRange

AccessibleText

Namespace: Gtk

Package: gtk4

Content:

Properties:

public abstract AccessibleRole accessible_role { get; set; }
The accessible role of the given `GtkAccessible` implementation.

Methods:

public void announce (string message, AccessibleAnnouncementPriority priority)
Requests the user's screen reader to announce the given message.
public abstract Accessible? get_accessible_parent ()
Retrieves the accessible parent for an accessible object.
public AccessibleRole get_accessible_role ()
Retrieves the accessible role of an accessible object.
public abstract ATContext? get_at_context ()
Retrieves the implementation for the given accessible object.
public abstract bool get_bounds (out int x, out int y, out int width, out int height)
Queries the coordinates and dimensions of this accessible
public abstract Accessible? get_first_accessible_child ()
Retrieves the first accessible child of an accessible object.
public abstract Accessible? get_next_accessible_sibling ()
Retrieves the next accessible sibling of an accessible object
public abstract bool get_platform_state (AccessiblePlatformState state)
Queries a platform state, such as focus.
public void reset_property (AccessibleProperty property)
Resets the accessible property to its default value.
public void reset_relation (AccessibleRelation relation)
Resets the accessible relation to its default value.
public void reset_state (AccessibleState state)
Resets the accessible state to its default value.
public void set_accessible_parent (Accessible? parent, Accessible? next_sibling)
Sets the parent and sibling of an accessible object.
public void update_next_accessible_sibling (Accessible? new_sibling)
Updates the next accessible sibling.
public void update_platform_state (AccessiblePlatformState state)
Informs ATs that the platform state has changed.
public void update_property (...)
Updates a list of accessible properties.
public void update_property_value (AccessibleProperty[] properties, Value[] values)
Updates an array of accessible properties.
public void update_relation (...)
Updates a list of accessible relations.
public void update_relation_value (AccessibleRelation[] relations, Value[] values)
Updates an array of accessible relations.
public void update_state (...)
Updates a list of accessible states.
public void update_state_value (AccessibleState[] states, Value[] values)
Updates an array of accessible states.

Inherited Members:

All known members inherited from class GLib.Object