Method

AtspiCollectionget_matches_from

Declaration [src]

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

Description [src]

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

Parameters

current_object AtspiAccessible
 

Upon reaching this object, searching should stop.

 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.

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 that preceed current_object.

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