Atspi.Collection¶

Implementations:: Atspi.Accessible

Methods¶

	`get_active_descendant` ()
	`get_matches` (rule, sortby, count, traverse)
	`get_matches_from` (current_object, rule, sortby, tree, count, traverse)
	`get_matches_to` (current_object, rule, sortby, tree, limit_scope, count, traverse)
	`is_ancestor_of` (test)

Virtual Methods¶

None

Properties¶

None

Signals¶

None

Fields¶

None

Class Details¶

class Atspi.Collection¶

Bases:: GObject.GInterface

An interface designed to allow accessibles which satisfy a set of criteria to be returned.

An interface designed to allow accessibles which satisfy a set of criteria to be returned. This interface can be used to avoid iteration or client-side search of the object tree.

get_active_descendant()¶

Raises:: GLib.Error
Returns:: The active descendant of the given object. Not yet implemented.
Return type:: Atspi.Accessible

get_matches(rule, sortby, count, traverse)¶

Parameters:

rule (Atspi.MatchRule) – An Atspi.MatchRule describing the match criteria.
sortby (Atspi.CollectionSortOrder) – An Atspi.CollectionSortOrder specifying the way the results are to be sorted.
count (int) – The maximum number of results to return, or 0 for no limit.
traverse (bool) – Not supported.

Raises:

GLib.Error

Returns:

All Atspi.Accessible objects matching the given match rule.

Return type:

[Atspi.Accessible]

Gets all Atspi.Accessible objects from the self matching a given rule.

get_matches_from(current_object, rule, sortby, tree, count, traverse)¶

Parameters:

current_object (Atspi.Accessible) – Upon reaching this object, searching should stop.
rule (Atspi.MatchRule) – An Atspi.MatchRule describing the match criteria.
sortby (Atspi.CollectionSortOrder) – An Atspi.CollectionSortOrder specifying the way the results are to be sorted.
tree (Atspi.CollectionTreeTraversalType) – An Atspi.CollectionTreeTraversalType specifying restrictions on the objects to be traversed.
count (int) – The maximum number of results to return, or 0 for no limit.
traverse (bool) – Not supported.

Raises:

GLib.Error

Returns:

All Atspi.Accessible objects matching the given match rule that preceed current_object.

Return type:

[Atspi.Accessible]

Gets all Atspi.Accessible objects from the self, before current_object, matching a given rule.

get_matches_to(current_object, rule, sortby, tree, limit_scope, count, traverse)¶

Parameters:

current_object (Atspi.Accessible) – The object at which to start searching.
rule (Atspi.MatchRule) – An Atspi.MatchRule describing the match criteria.
sortby (Atspi.CollectionSortOrder) – An Atspi.CollectionSortOrder specifying the way the results are to be sorted.
tree (Atspi.CollectionTreeTraversalType) – An Atspi.CollectionTreeTraversalType specifying restrictions on the objects to be traversed.
limit_scope (bool) – If True, only descendants of current_object's parent will be returned. Otherwise (if False), any accessible may be returned if it would preceed current_object in a flattened hierarchy.
count (int) – The maximum number of results to return, or 0 for no limit.
traverse (bool) – Not supported.

Raises:

GLib.Error

Returns:

All Atspi.Accessible objects matching the given match rule after current_object.

Return type:

[Atspi.Accessible]

Gets all Atspi.Accessible objects from the self, after current_object, matching a given rule.

is_ancestor_of(test)¶

Parameters:: test (Atspi.Accessible) –
Raises:: GLib.Error
Return type:: bool

Not yet implemented.