atspi-collection

## atspi-collection atspi-collection |

## Synopsis

                        AtspiCollection;
    gboolean            atspi_collection_is_ancestor_of     (AtspiCollection *collection,
                                                             AtspiAccessible *test,
                                                             GError **error);
    GArray *            atspi_collection_get_matches        (AtspiCollection *collection,
                                                             AtspiMatchRule *rule,
                                                             AtspiCollectionSortOrder sortby,
                                                             gint count,
                                                             gboolean traverse,
                                                             GError **error);
    GArray *            atspi_collection_get_matches_to     (AtspiCollection *collection,
                                                             AtspiAccessible *current_object,
                                                             AtspiMatchRule *rule,
                                                             AtspiCollectionSortOrder sortby,
                                                             AtspiCollectionTreeTraversalType tree,
                                                             gboolean recurse,
                                                             gint count,
                                                             gboolean traverse,
                                                             GError **error);
    GArray *            atspi_collection_get_matches_from   (AtspiCollection *collection,
                                                             AtspiAccessible *current_object,
                                                             AtspiMatchRule *rule,
                                                             AtspiCollectionSortOrder sortby,
                                                             AtspiCollectionTreeTraversalType tree,
                                                             gint count,
                                                             gboolean traverse,
                                                             GError **error);
    AtspiAccessible *   atspi_collection_get_active_descendant
                                                            (AtspiCollection *collection,
                                                             GError **error);

## Object Hierarchy

      GInterface
       +----AtspiCollection

## Known Implementations

AtspiCollection is implemented by AtspiAccessible.

## Description

## Details

### AtspiCollection

    typedef struct _AtspiCollection AtspiCollection;

### atspi_collection_is_ancestor_of ()

    gboolean            atspi_collection_is_ancestor_of     (AtspiCollection *collection,
                                                             AtspiAccessible *test,
                                                             GError **error);

`collection` : |
`test` : |
`error` : |
Returns : |

### atspi_collection_get_matches ()

    GArray *            atspi_collection_get_matches        (AtspiCollection *collection,
                                                             AtspiMatchRule *rule,
                                                             AtspiCollectionSortOrder sortby,
                                                             gint count,
                                                             gboolean traverse,
                                                             GError **error);

`collection`: The AtspiCollection. `rule`: A AtspiMatchRule describing the match criteria. `sortby`: An AtspiCollectionSortOrder specifying the way the results are to be sorted. `count`: The maximum number of results to return, or 0 for no limit. `traverse`: TODO

`collection` : |
`rule` : |
`sortby` : |
`count` : |
`traverse` : |
`error` : |
Returns : | A GArray of AtspiAccessibles matching the given match rule. [element-type AtspiAccessible*][transfer full AtspiAccessible*]

### atspi_collection_get_matches_to ()

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

`collection`: The AtspiCollection. `current_object`: The object at which to start searching. `rule`: A AtspiMatchRule describing the match criteria. `sortby`: An AtspiCollectionSortOrder specifying the way the results are to be sorted. `tree`: An AtspiCollectionTreeTraversalType specifying restrictions on the objects to be traversed. `recurse`: TODO `count`: The maximum number of results to return, or 0 for no limit. `traverse`: TODO

`collection` : |
`current_object` : |
`rule` : |
`sortby` : |
`tree` : |
`recurse` : |
`count` : |
`traverse` : |
`error` : |
Returns : | A GArray of AtspiAccessibles matching the given match rule after `current_object`. [element-type AtspiAccessible*][transfer full AtspiAccessible*]

### atspi_collection_get_matches_from ()

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

`collection`: The AtspiCollection. `current_object`: Upon reaching this object, searching should stop. `rule`: A AtspiMatchRule describing the match criteria. `sortby`: An AtspiCollectionSortOrder specifying the way the results are to be sorted. `tree`: An AtspiCollectionTreeTraversalType specifying restrictions on the objects to be traversed. `count`: The maximum number of results to return, or 0 for no limit. `traverse`: TODO

`collection` : |
`current_object` : |
`rule` : |
`sortby` : |
`tree` : |
`count` : |
`traverse` : |
`error` : |
Returns : | A GArray of AtspiAccessibles matching the given match rule that preceed `current_object`. [element-type AtspiAccessible*][transfer full AtspiAccessible*]

### atspi_collection_get_active_descendant ()

    AtspiAccessible *   atspi_collection_get_active_descendant
                                                            (AtspiCollection *collection,
                                                             GError **error);

`collection`: The AtspiCollection to query.

`collection` : |
`error` : |
Returns : | The active descendant of collection. Not yet implemented. [transfer full]