class: Accessible

[34:7] extends: 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].

Members

• handleObj
• lib
• retainedCallbacks
• signalHandlerNames
• signalSetterHandlers

Methods

• Accessible (Handle = null)

  Creates a new Accessible by wrapping a native handle or another wrapper.

  • @p Handle is the native handle or another wrapper whose handle to adopt.

• toNativeHandle (Source)

  Normalizes a constructor argument into a raw pointer carrier. Accepts a raw NativeHandle, a raw NativeBuffer returned from fn.call(...), another generated wrapper exposing handle(), or null. Returns null when the argument carries no pointer.

  • @p Source is the raw handle, raw buffer, wrapper, or null.
  • @r A raw pointer carrier or null when no pointer is present.

• getLib ()

  Returns the opened native library for this generated wrapper.

  • @r The opened native library.

• handle ()

  Returns the wrapped NativeHandle.

  • @r The wrapped NativeHandle.

• isNull ()

  Returns true when the wrapped handle is null.

  • @r A bool.

• describe ()

  Returns a small string for debugging generated wrappers.

  • @r A string.

• getProperty (string Name)

  Reads one generated property by name.

• setProperty (string Name, Value)

  Writes one generated property by name.

• setAccessiblerole (string Value)

  The accessible role of the given GtkAccessible implementation. The accessible role cannot be changed once set.

  • @p Value is the new property value.
  • @r None.

• announce (string message, string priority)

  Requests the user's screen reader to announce the given message. This kind of notification is useful for messages that either have only a visual representation or that are not exposed visually at all, e.g. a notification about a successful operation. Also, by using this API, you can ensure that the message does not interrupts the user's current screen reader output.

  • @p message is the string to announce.
  • @p priority is the priority of the announcement.
  • @r None.

• get_accessible_id ()

  Retrieves the accessible identifier for the accessible object. This functionality can be overridden by GtkAccessible implementations. It is left to the accessible implementation to define the scope and uniqueness of the identifier.

• get_accessible_parent ()

  Retrieves the accessible parent for an accessible object. This function returns NULL for top level widgets.

• get_accessible_role ()

  Retrieves the accessible role of an accessible object.

• get_at_context ()

  Retrieves the implementation for the given accessible object.

• get_first_accessible_child ()

  Retrieves the first accessible child of an accessible object.

• get_next_accessible_sibling ()

  Retrieves the next accessible sibling of an accessible object

• get_platform_state (string state)

  Queries a platform state, such as focus. This functionality can be overridden by GtkAccessible implementations, e.g. to get platform state from an ignored child widget, as is the case for GtkText wrappers.

  • @p state is platform state to query.

• reset_property (string property)

  Resets the accessible property to its default value.

  • @p property is the accessible property.
  • @r None.

• reset_relation (string relation)

  Resets the accessible relation to its default value.

  • @p relation is the accessible relation.
  • @r None.

• reset_state (string state)

  Resets the accessible state to its default value.

  • @p state is the accessible state.
  • @r None.

• set_accessible_parent (object parent, object next_sibling)

  Sets the parent and sibling of an accessible object. This function is meant to be used by accessible implementations that are not part of the widget hierarchy, and but act as a logical bridge between widgets. For instance, if a widget creates an object that holds metadata for each child, and you want that object to implement the GtkAccessible interface, you will use this function to ensure that the parent of each child widget is the metadata object, and the parent of each metadata object is the container widget.

  • @p parent is the parent accessible object.
  • @p next_sibling is the sibling accessible object.
  • @r None.

• update_next_accessible_sibling (object new_sibling)

  Updates the next accessible sibling. That might be useful when a new child of a custom accessible is created, and it needs to be linked to a previous child.

  • @p new_sibling is the new next accessible sibling to set.
  • @r None.

• update_platform_state (string state)

  Informs ATs that the platform state has changed. This function should be used by GtkAccessible implementations that have a platform state but are not widgets. Widgets handle platform states automatically.

  • @p state is the platform state to update.
  • @r None.

class: AccessibleMeta

[312:14] static extends: object

Generated metadata helpers for Accessible interface surfaces.

Methods

• properties ()

  Returns property metadata for Accessible.

  • @r A list.