Class Node

Perform the action with the specified name. For a list of actions supported by this instance, check the 'actions' property.

Generates a raw mouse click event, using the specified button.

• 1 is left,
• 2 is middle,
• 3 is right.

FIXME: this needs rewriting... Generate a SearchPath instance giving the 'best' way to find the Accessible wrapped by this node again, starting at the root and applying each search in turn.

This is somewhat analagous to an absolute path in a filesystem, except that some of searches may be recursive, rather than just searching direct children.

Used by the recording framework for identifying nodes in a persistent way, independent of the style of script being written.

FIXME: try to ensure uniqueness FIXME: need some heuristics to get 'good' searches, whatever that means

Get a (ancestorNode, predicate, isRecursive) triple that identifies the best way to find this Node uniquely. FIXME: or None if no such search exists? FIXME: may need to make this more robust FIXME: should this be private?

Search for a node satisyfing the predicate, returning a Node.

If retry is True (the default), it makes multiple attempts, backing off and retrying on failure, and eventually raises a descriptive exception if the search fails.

If retry is False, it gives up after one attempt.

If requireResult is True (the default), an exception is raised after all attempts have failed. If it is false, the function simply returns None.

Finds a child satisying the given criteria.

This is implemented using findChild, and hence will automatically retry if no such child is found, and will eventually raise an exception. It also logs the search.

Search below this node for a menu with the given name.

This is implemented using findChild, and hence will automatically retry if no such child is found, and will eventually raise an exception. It also logs the search.

Search below this node for a menu item with the given name.

This is implemented using findChild, and hence will automatically retry if no such child is found, and will eventually raise an exception. It also logs the search.

Search below this node for a text entry with the given name.

This is implemented using findChild, and hence will automatically retry if no such child is found, and will eventually raise an exception. It also logs the search.

Search below this node for a button with the given name.

This is implemented using findChild, and hence will automatically retry if no such child is found, and will eventually raise an exception. It also logs the search.

Search below this node for a child labelled with the given text.

This is implemented using findChild, and hence will automatically retry if no such child is found, and will eventually raise an exception. It also logs the search.

Search below this node for a child with the given name.

This is implemented using findChild, and hence will automatically retry if no such child is found, and will eventually raise an exception. It also logs the search.

Search below this node for a tab with the given name.

This is implemented using findChild, and hence will automatically retry if no such child is found, and will eventually raise an exception. It also logs the search.

Get all user-visible strings in this node and its descendents.

(Could be implemented as an attribute)

debugName

debug name assigned during search operations

Get Method:

_getDebugName(self)

Set Method:

_setDebugName(self, debugName)

dead

Is the node dead (defunct) ?

Get Method:

_getDead(self)

children

a list of this Accessible's children

Get Method:

_getChildren(self)

roleName

Gets the unlocalized role name of the accessible from the cache if it is available, otherwise, fetches it remotely.

Get Method:

unreachable.getRoleName(self) - Gets the unlocalized role name of the accessible from the cache if it is available, otherwise, fetches it remotely.

Type:

string

role

Gets the role of the accessible from the cache if it is available, otherwise, fetches it remotely.

Get Method:

unreachable.getRole(self) - Gets the role of the accessible from the cache if it is available, otherwise, fetches it remotely.

Type:

Accessibility.Role

indexInParent

Gets the index of this accessible in its parent. Uses the implementation of this method provided by the Accessibility.Accessible object, but checks the bound of the value to ensure it is not outside the range of childCount reported by this accessible's parent.

Get Method:

unreachable.getIndexInParent(self) - Gets the index of this accessible in its parent.

Type:

integer

actions

A dictionary of supported action names as keys, with Action objects as values. Common action names include:

'click' 'press' 'release' 'activate' 'jump' 'check' 'dock' 'undock' 'open' 'menu'

Get Method:

_getActions(self)

combovalue

The value (as a string) currently selected in the combo box.

Get Method:

_getComboValue(self)

Set Method:

_setComboValue(self, value)

URI

Get Method:

_getURI(self)

text

For instances with an AccessibleText interface, the text as a string. This is read-only, unless the instance also has an AccessibleEditableText interface. In this case, you can write values to the attribute. This will get logged in the debug log, and a delay will be added.

If this instance corresponds to a password entry, use the passwordText property instead.

Get Method:

_getText(self)

Set Method:

_setText(self, text)

caretOffset

For instances with an AccessibleText interface, the caret offset as an integer.

Get Method:

_getCaretOffset(self)

Set Method:

_setCaretOffset(self, offset)

position

A tuple containing the position of the Accessible: (x, y)

Get Method:

_getPosition(self)

size

A tuple containing the size of the Accessible: (w, h)

Get Method:

_getSize(self)

extents

A tuple containing the location and size of the Accessible: (x, y, w, h)

Get Method:

_getExtents(self)

labeler

'labeller' (read-only list of Node instances): The node(s) that is/are a label for this node. Generated from 'relations'.

Get Method:

_labeler(self)

labeller

See labeler

Get Method:

_labeler(self)

labelee

'labellee' (read-only list of Node instances): The node(s) that this node is a label for. Generated from 'relations'.

Get Method:

_labelee(self)

labellee

See labelee

Get Method:

_labelee(self)

sensitive

Is the Accessible sensitive (i.e. not greyed out)?

Get Method:

_isSensitive(self)

showing

Get Method:

_isShowing(self)

focusable

Is the Accessible capable of having keyboard focus?

Get Method:

_isFocusable(self)

focused

Does the Accessible have keyboard focus?

Get Method:

_isFocused(self)

checked

Is the Accessible a checked checkbox?

Get Method:

_isChecked(self)

isSelected

Is the Accessible selected?

Get Method:

_getSelected(self)

selectedChildren

Returns a list of children that are selected.

Get Method:

_getSelectedChildren(self)

value

Get Method:

_getValue(self)

Set Method:

_setValue(self, value)

minValue

Get Method:

_getMinValue(self)

minValueIncrement

Get Method:

_getMinValueIncrement(self)

maxValue

Get Method:

_getMaxValue(self)