org.a11y.atspi.Collection

Description

An interface designed to allow accessibles which satisfy a set of

criteria to be returned.

Properties

org.a11y.atspi.Collection:version

version readable u

Methods

org.a11y.atspi.Collection.GetMatches

GetMatches (
  IN rule (aiia{ss}iaiiasib),
  IN sortby u,
  IN count i,
  IN traverse b,
  OUT unnamed_arg4 a(so)
)

Return descendants which satisfy a set of criteria specified in the match rule.

rule: Criteria that objects to be returned must fulfill. This structure is composed as follows:

  • ai: States (see below for more how they are encoded)

  • i: Match type used for matching states

  • a{ss}: Attributes. See also the Accessible.GetAttributes method

  • i: Match type used for matching attributes

  • ai: Roles (see below for how they are encoded)

  • i: Match type used for matching roles

  • as: Interfaces, by name (like “Action” or “Text”).

  • i: Match type used for matching interfaces

  • b: Whether to invert the criteria. If true, the match rule should be denied (inverted); if false, it should not. For example, if the match rule defines that a match is an object of ROLE_HEADING which has STATE_FOCUSABLE and a click action, inverting it would match all objects that are not of ROLE_HEADING, focusable and clickable at the same time.

For all criteria, the value used for the match type corresponds to the AtspiCollectionMatchType enum values.

The set of states and roles are bitsets encoded as an array of multiple 32-bit integers. A state/role with enum value N is set by setting the Nth bit in the bit set. The first integer in the array contains the lowest 0-31 bits, the next integer bits 32-63, etc.

For example, enum value AT_SPI_ROLE_COMBOBOX has a value of 83. In order to pass a set of roles in which only this role is set, an array of integers representing (1 << 83) = 0x800000000000000000000 would be passed: { 0, 0, 0x80000, 0 }

sortby: The way objects should be sorted. The values correspond to those defined in the AtspiCollectionSortOrder enum.

count: Maximum number of objects to return, or 0 for no limit.

traverse: Whether to return descendants from the accessible subtree (if #TRUE) or only direct children (if #FALSE).

rule

sortby

count

traverse

unnamed_arg4

org.a11y.atspi.Collection.GetMatchesTo

GetMatchesTo (
  IN currentObject o,
  IN rule (aiia{ss}iaiiasib),
  IN sortby u,
  IN tree u,
  IN limit_scope b,
  IN count i,
  IN traverse b,
  OUT unnamed_arg7 a(so)
)

currentObject: The object at which to start searching.

rule: Criteria that objects to be returned must fulfill.

sortby: The way objects should be sorted.

tree: Specifies restrictions on the objects to be traversed. Values correspond to the AtspiCollectionTreeTraversalType enum: - ATSPI_Collection_TREE_RESTRICT_CHILDREN (0): Restrict children tree traversal - 1 (ATSPI_Collection_TREE_RESTRICT_SIBLING): Restrict sibling tree traversal - 2 (ATSPI_Collection_TREE_INORDER): In-order tree traversal.

limit_scope: If true, only descendants of currentObject’s parent will be returned. Otherwise (if false), any accessible may be returned if it would preceed currentObject in a flattened hierarchy.

count: The maximum number of results to return, or 0 for no limit.

traverse: Whether to traverse the accessible subtree (in case of true) or only the direct children (on case of false).

Gets all Accessible objects from the collection, after currentObject, matching a given rule.

Returns: All accessible objects matching the given match rule after currentObject.

currentObject

rule

sortby

tree

limit_scope

count

traverse

unnamed_arg7

org.a11y.atspi.Collection.GetMatchesFrom

GetMatchesFrom (
  IN currentObject o,
  IN rule (aiia{ss}iaiiasib),
  IN sortby u,
  IN tree u,
  IN count i,
  IN traverse b,
  OUT unnamed_arg6 a(so)
)

currentObject: Upon reaching this object, searching should stop.

rule: Criteria that objects to be returned must fulfill.

sortby: The way objects should be sorted.

tree: Specifies restrictions on the objects to be traversed. Values correspond to the AtspiCollectionTreeTraversalType enum.

count: The maximum number of results to return, or 0 for no limit.

traverse: Whether to traverse the accessible subtree (if true) or only the direct children (if false).

Gets all Accessible objects from the collection, before currentObject, matching a given rule.

Returns: All accessible objects matching the given match rule after currentObject.

currentObject

rule

sortby

tree

count

traverse

unnamed_arg6

org.a11y.atspi.Collection.GetActiveDescendant

GetActiveDescendant (
  OUT unnamed_arg0 (so)
)

Returns the active descendant of the given object. Not currently implemented in libatspi.

unnamed_arg0