Module AEInterfaces :: Class IAccessibleNav

Class IAccessibleNav

        object --+    
                 |    
AccAdapt.Interface --+
                     |
                    IAccessibleNav

Provides methods for navigating across accessible objects.

Instance Methods

[hide private]

POR

getNextAcc()
Gets the next accessible relative to the one providing this interface.

source code

POR

getPrevAcc()
Gets the previous accessible relative to the one providing this interface.

source code

POR

getParentAcc()
Gets the parent accessible relative to the one providing this interface.

source code

POR

getFirstAccChild()
Gets the first accessible child relative to the subject accessible.

source code

POR

getLastAccChild()
Gets the last accessible child relative to the subject accessible.

source code

POR

getChildAcc(index)
Gets the child accessible at the given index relative to the one providing this interface.

source code

POR

findAncestorAcc(predicate)
Searches all ancestors for one matching the given predicate.

source code

POR

findDescendantAcc(predicate, depth_first)
Searches all descendants for one matching the given predicate.

source code

Inherited from AccAdapt.Interface: __new__

Inherited from object: __delattr__, __getattribute__, __hash__, __init__, __reduce__, __reduce_ex__, __repr__, __setattr__, __str__

Properties

[hide private]

Inherited from object: __class__

Method Details

[hide private]

getNextAcc()

source code

Gets the next accessible relative to the one providing this interface.

Returns: POR

Point of regard to the next accessible

Raises:

IndexError - When there is no next accessible
LookupError - When lookup for the next accessible fails even though it may exist

getPrevAcc()

source code

Gets the previous accessible relative to the one providing this interface.

Returns: POR

Point of regard to the previous accessible

Raises:

IndexError - When there is no previous accessible
LookupError - When lookup for the previous accessible fails even though it may exist

getParentAcc()

source code

Gets the parent accessible relative to the one providing this interface.

Returns: POR

Point of regard to the parent accessible

Raises:

LookupError - When lookup for the parent accessible fails because it does not exist

getFirstAccChild()

source code

Gets the first accessible child relative to the subject accessible.

Returns: POR

Point of regard to the first child accessible

Raises:

LookupError - When lookup for child fails because it does not exist

getLastAccChild()

source code

Gets the last accessible child relative to the subject accessible.

Returns: POR

Point of regard to the last child accessible

Raises:

LookupError - When lookup for child fails because it does not exist

getChildAcc(index)

source code

Gets the child accessible at the given index relative to the one providing this interface.

Parameters:

index (integer) - Index of the child to retrieve

Returns: POR

Point of regard to the child accessible

Raises:

IndexError - When there is no child at the given index
LookupError - When the lookup for the child fails even though it may exist

findAncestorAcc(predicate)

source code

Searches all ancestors for one matching the given predicate.

Parameters:

predicate (callable) - Search predicate

Returns: POR

Point of regard to the target or None if not found

Raises:

LookupError - When the lookup fails during the search

findDescendantAcc(predicate, depth_first)

source code

Searches all descendants for one matching the given predicate.

Parameters:

predicate (callable) - Search predicate
depth_first (boolean) - Perform the search in depth-first (True) or breadth first (False) order?

Returns: POR

Point of regard to the target or None if not found

Raises:

LookupError - When the lookup fails during the search