Method

AtspiCollectionget_matches_to

Declaration [src]

GArray*
atspi_collection_get_matches_to (
  AtspiCollection* collection,
  AtspiAccessible* current_object,
  AtspiMatchRule* rule,
  AtspiCollectionSortOrder sortby,
  AtspiCollectionTreeTraversalType tree,
  gboolean limit_scope,
  gint count,
  gboolean traverse,
  GError** error
)

Description [src]

Gets all AtspiAccessible objects from the collection, after current_object, matching a given rule.

Parameters

current_object AtspiAccessible
 

The object at which to start searching.

 The data is owned by the caller of the function.
rule AtspiMatchRule
 

An AtspiMatchRule describing the match criteria.

 The data is owned by the caller of the function.
sortby AtspiCollectionSortOrder
 

An AtspiCollectionSortOrder specifying the way the results are to be sorted.

tree AtspiCollectionTreeTraversalType
 

An AtspiCollectionTreeTraversalType specifying restrictions on the objects to be traversed.

limit_scope gboolean
 

If TRUE, only descendants of current_objects parent will be returned. Otherwise (if FALSE), any accessible may be returned if it would preceed current_object in a flattened hierarchy.

count gint
 

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

traverse gboolean
 

Not supported.

error GError **
  The return location for a GError*, or NULL.

Return value

Returns: An array of AtspiAccessible*
 

All AtspiAccessible objects matching the given match rule after current_object.

 The caller of the method takes ownership of the data, and is responsible for freeing it.