AccessibleT

gtk.accessible.Accessible is an interface for describing UI elements for Assistive Technologies.

Every accessible implementation has:

The role cannot be changed after instantiating a gtk.accessible.Accessible 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 gtk.widget.Widget visibility changes, the gtk.types.AccessibleState.Hidden state will also change to reflect the gtk.widget.Widget.gboolean 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 gtk.accessible.Accessible.setAccessibleParent and updating the sibling by gtk.accessible.Accessible.updateNextAccessibleSibling.

Members

Functions

announce
void announce(string message, gtk.types.AccessibleAnnouncementPriority priority)

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

getAccessibleParent
gtk.accessible.Accessible getAccessibleParent()

Retrieves the accessible parent for an accessible object.

getAccessibleRole
gtk.types.AccessibleRole getAccessibleRole()

Retrieves the accessible role of an accessible object.

getAtContext
gtk.atcontext.ATContext getAtContext()

Retrieves the accessible implementation for the given gtk.accessible.Accessible.

getBounds
bool getBounds(int x, int y, int width, int height)

Queries the coordinates and dimensions of this accessible

getFirstAccessibleChild
gtk.accessible.Accessible getFirstAccessibleChild()

Retrieves the first accessible child of an accessible object.

getNextAccessibleSibling
gtk.accessible.Accessible getNextAccessibleSibling()

Retrieves the next accessible sibling of an accessible object

getPlatformState
bool getPlatformState(gtk.types.AccessiblePlatformState state)

Query a platform state, such as focus.

resetProperty
void resetProperty(gtk.types.AccessibleProperty property)

Resets the accessible property to its default value.

resetRelation
void resetRelation(gtk.types.AccessibleRelation relation)

Resets the accessible relation to its default value.

resetState
void resetState(gtk.types.AccessibleState state)

Resets the accessible state to its default value.

setAccessibleParent
void setAccessibleParent(gtk.accessible.Accessible parent, gtk.accessible.Accessible nextSibling)

Sets the parent and sibling of an accessible object.

updateNextAccessibleSibling
void updateNextAccessibleSibling(gtk.accessible.Accessible newSibling)

Updates the next accessible sibling of self.

updateProperty
void updateProperty(gtk.types.AccessibleProperty[] properties, gobject.value.Value[] values)

Updates an array of accessible properties.

updateRelation
void updateRelation(gtk.types.AccessibleRelation[] relations, gobject.value.Value[] values)

Updates an array of accessible relations.

updateState
void updateState(gtk.types.AccessibleState[] states, gobject.value.Value[] values)

Updates an array of accessible states.