Module AEInterfaces :: Class IAccessibleInfo

Class IAccessibleInfo

        object --+    
                 |    
AccAdapt.Interface --+
                     |
                    IAccessibleInfo

Provides methods for accessing basic information about accessible objects.

Instance Methods

[hide private]

list of PORs

getAccSelection()
Gets a list of PORs referring to the selected objects in the subject accessible.

source code

integer

getAccChildCount()
Gets the number of child accessibles for the object implementing this interface.

source code

string

getAccAppName()
Gets the name of the application application to which the subject accessible belongs.

source code

hashable

getAccAppID()
Gets a unique ID identifying the application to which the subject accessible belongs.

source code

string

getAccRoleName()
Gets the localized unicode accessible role name for the object implementing this interface.

source code

string

getAccName()
Gets the accessible name for the object implementing this interface.

source code

string

getAccDescription()
Gets the accessible description for the object implementing this interface.

source code

list of string

getAccStates()
Gets a list of states for the object implementing this interface.

source code

string

getAccItemText()
Gets the accessible text for the object implementing this interface.

source code

list of POR

getAccRelations(kind)
Gets a list of accessibles related to the subject accessible in the manner given by kind.

source code

string

getAccTextAttr(name)
Gets the value of a given attribute name.

source code

dictionary

getAccAllTextAttrs()
Gets all of the name:value attribute pairs of an accessible.

source code

integer

getAccLevel()
Gets the logical depth of an accessible within a tree or hierarchy.

source code

integer

getAccIndex()
Gets the index an accessible within some 1D ordered collection.

source code

integer

getAccRow()
Gets the row index of an accessible within some 2D ordered collection.

source code

integer

getAccColumn()
Gets the column index of an accessible within some 2D ordered collection.

source code

integer

getAccRowColIndex(row, col)
Gets the 1D index of the cell at the given 2D row and column.

source code

string

getAccColumnHeader()
Gets the description of the column in which the accessible at the POR falls, typically the column header.

source code

string

getAccRowHeader()
Gets the description of the row in which the accessible at the POR falls, typically the row header.

source code

dictionary

getAccAttrs()
Gets a list of name:value attribute pairs for the subject.

source code

3-tuple of float

getAccFloatValueExtents()
Gets the minimum, maximum, and step for the floating point value exposed by the subject.

source code

2-tuple of integer

getAccVisualExtents()
Gets the visual width and height of the subject.

source code

2-tuple of integer

getAccVisualPoint()
Gets the focal point within the subject, where the focal point is defined as the center of the most interesting point of regard.

source code

2-tuple integer

getAccPosition(self)
Gets the position of the accessible object, usually upper-left corner.

source code

float

getAccFloatValue()
Gets the current floating point value of the subject

source code

dictionary

getAccDefTextAttrs()
Gets all of the default text attributes assigned to the subject.

source code

list of string

getAccTextSelection(n=None)
Gets a list of all text selections in the subject if n is None, or the nth selection if it is specified.

source code

getAccText(self, por)
Gets the text starting at the subject and ending at the given POR.

source code

2-tuple of integer

getAccTableExtents()
Returns the number of rows and columns in a table.

source code

string

getAccAppLocale()
Gets the POSIX locale of an application as a string.

source code

boolean

isAccEmbedded()
Gets whether or not the accessible considers itself embedded in an ancestor's content.

source code

string

getAccURI()
Obtain a resource locator ('URI') string which can be used to access the content to which this link "points" or is connected.

source code

integer

getAccAnchorCount()
Obtain he number of separate anchors associated with this accessible.

source code

boolean

isAccTrivial()
Gets whether or not the accessible considers itself to be trivial.

source code

boolean

isAccVisible()
Gets whether or not the accessible considers itself visible.

source code

string

getAccRole()
Gets the unlocalized string role identifier for the object implementing this interface.

source code

boolean

hasAccRole(role)
Gets if the subject has the given role.

source code

boolean

hasOneAccRole(*roles)
Gets if the subject has any one of the given roles.

source code

boolean

hasAccState(state)
Gets if the subject has the given state.

source code

boolean

hasAccOneState(*states)
Gets if the subject has at least one of the given states.

source code

boolean

hasAccAllStates(*states)
Gets if the subject has all of the given states.

source code

boolean

allowsAccEmbeds()
Gets whether or not the subject accessible allows embedded objects in its text.

source code

boolean

isAccTopLevelWindow()
Gets whether or not the subject accessible is a top-level container in the accessible hierarchy.

source code

list of string

getAccActionNames()
Gets the list of all action names defined by the subject.

source code

list of string

getAccActionDescs()
Gets the list of all action descriptions defined by the subject.

source code

integer

getAccActionCount()
Gets the number of available actions on the subject.

source code

list of tuple of string

getAccActionKeys()
Gets the key bindings associated with all available actions.

source code

integer

getAccTextSelectionCount(self)
Gets the number of discontiguous selected text ranges.

source code

POR

getAccCaret(self)
Gets the current offset of the caret in this text object as a POR.

source code

integer

getAccTextCharCount(self)
Gets the number of characters in a text body.

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]

getAccSelection()

source code

Gets a list of PORs referring to the selected objects in the subject accessible.

Returns: list of PORs

Points of regard to selected accessibles

Raises:

LookupError - When the subject accessible is dead

getAccChildCount()

source code

Gets the number of child accessibles for the object implementing this interface.

Returns: integer

Number of accessible children

Raises:

LookupError - When the accessible object is dead

getAccAppName()

source code

Gets the name of the application application to which the subject accessible belongs.

Returns: string

Name of the subject's application

Raises:

LookupError - When the accessible or any parent accessible up to the application is dead

getAccAppID()

source code

Gets a unique ID identifying the application to which the subject accessible belongs.

Returns: hashable

Unique identifier for the subject's application

Raises:

LookupError - When the accessible or any parent accessible up to the application is dead

getAccRoleName()

source code

Gets the localized unicode accessible role name for the object implementing this interface.

Returns: string

Unicode role name

Raises:

LookupError - When the accessible object is dead

getAccName()

source code

Gets the accessible name for the object implementing this interface.

Returns: string

Name of the accessible

Raises:

LookupError - When the accessible object is dead
IndexError - When the item offset is outside the bounds of the number of children of the subject accessible

getAccDescription()

source code

Gets the accessible description for the object implementing this interface.

Returns: string

Accessible description of requested object

Raises:

LookupError - When the subject accessible is dead
IndexError - When the item offset is outside the bounds of the number of children of the subject accessible

getAccStates()

source code

Gets a list of states for the object implementing this interface.

Returns: list of string

Names of all states

Raises:

LookupError - When the subject accessible is dead
IndexError - When the item offset is outside the bounds of the number of children of the subject accessible

getAccItemText()

source code

Gets the accessible text for the object implementing this interface. The item text will be the accessible text if that is available, otherwise it will be the accessible name.

Returns: string

The accessible text or name

Raises:

LookupError - When the subject accessible is dead
IndexError - When the item offset is invalid

getAccRelations(kind)

source code

Gets a list of accessibles related to the subject accessible in the manner given by kind.

Parameters:

kind (string) - Name specifying the kind of relations to retrieve

Returns: list of POR

List of PORs related to subject accessible in the manner given by kind

Raises:

LookupError - When the accessible object is dead

getAccTextAttr(name)

source code

Gets the value of a given attribute name.

Parameters:

name (string) - Name of the attribute

Returns: string

Value of the accessible attribute

Raises:

LookupError - When the accessible object is dead

getAccAllTextAttrs()

source code

Gets all of the name:value attribute pairs of an accessible.

Returns: dictionary

Name:value pairs in the accessible attributes

Raises:

LookupError - When the accessible object is dead

getAccLevel()

source code

Gets the logical depth of an accessible within a tree or hierarchy.

Returns: integer

Level of an accessible with zero being the root

Raises:

LookupError - When the accessible object is dead

getAccIndex()

source code

Gets the index an accessible within some 1D ordered collection.

Returns: integer

Index of an accessible with zero being the first

Raises:

LookupError - When the accessible object is dead

getAccRow()

source code

Gets the row index of an accessible within some 2D ordered collection.

Returns: integer

Row of an accessible with zero being the first

Raises:

LookupError - When the accessible object is dead

getAccColumn()

source code

Gets the column index of an accessible within some 2D ordered collection.

Returns: integer

Column of an accessible with zero being the first

Raises:

LookupError - When the accessible object is dead

getAccRowColIndex(row, col)

source code

Gets the 1D index of the cell at the given 2D row and column.

Parameters:

row (integer) - Row index
col (integer) - Column index

Returns: integer

1D index into the table

Raises:

IndexError - When the row/column offsets are invalid
LookupError - When the accessible object is dead

getAccColumnHeader()

source code

Gets the description of the column in which the accessible at the POR falls, typically the column header.

Returns: string

Description of the column

Raises:

LookupError - When the accessible object is dead

getAccRowHeader()

source code

Gets the description of the row in which the accessible at the POR falls, typically the row header.

Returns: string

Description of the row

Raises:

LookupError - When the accessible object is dead

getAccAttrs()

source code

Gets a list of name:value attribute pairs for the subject.

Returns: dictionary

Name:value pairs of the accessible object attributes

Raises:

LookupError - When the accessible object is dead

getAccFloatValueExtents()

source code

Gets the minimum, maximum, and step for the floating point value exposed by the subject.

Returns: 3-tuple of float

Minimum, maximum, and step values

Raises:

LookupError - When the accessible object is dead

getAccVisualExtents()

source code

Gets the visual width and height of the subject.

Returns: 2-tuple of integer

Width and height extents

Raises:

LookupError - When the accessible object is dead

getAccVisualPoint()

source code

Gets the focal point within the subject, where the focal point is defined as the center of the most interesting point of regard. For a simple control, the focal point is the center of the control. For a control with items, the focal point is the center of an item.

Returns: 2-tuple of integer

x,y coordinates

Raises:

LookupError - When the accessible object is dead

getAccPosition(self)

source code

Gets the position of the accessible object, usually upper-left corner.

Returns: 2-tuple integer

x,y coordinate

Raises:

NotImplementedError - When this accessible does not support the Component interface

getAccFloatValue()

source code

Gets the current floating point value of the subject

Returns: float

Current value

Raises:

LookupError - When the accessible object is dead

getAccDefTextAttrs()

source code

Gets all of the default text attributes assigned to the subject.

Returns: dictionary

Name:value pairs of the default text attributes

Raises:

LookupError - When the accessible object is dead

getAccTextSelection(n=None)

source code

Gets a list of all text selections in the subject if n is None, or the nth selection if it is specified.

Parameters:

n (integer) - Index of selection to be returned, or None to indicate all

Returns: list of string

List of selected text runs

Raises:

LookupError - When the accessible object is dead

getAccText(self, por)

source code

Gets the text starting at the subject and ending at the given POR.

Parameters:

por (POR) - Point of regard to the end terminus of the get operation

Raises:

LookupError - When the accessible object is dead

getAccTableExtents()

source code

Returns the number of rows and columns in a table.

Returns: 2-tuple of integer: Row and column count

getAccAppLocale()

source code

Gets the POSIX locale of an application as a string.

Returns: string: POSIX locale of the application

isAccEmbedded()

source code

Gets whether or not the accessible considers itself embedded in an ancestor's content.

Returns: boolean

Does the accessible consider itself embedded?

Raises:

LookupError - When the accessible object is dead

getAccURI()

source code

Obtain a resource locator ('URI') string which can be used to access the content to which this link "points" or is connected.

Returns: string

URI string

Raises:

LookupError - When the accessible object is dead

getAccAnchorCount()

source code

Obtain he number of separate anchors associated with this accessible.

Returns: integer

Number of anchors

Raises:

PORError - When the POR is invalid

isAccTrivial()

source code

Gets whether or not the accessible considers itself to be trivial.

Returns: boolean

Does the accessible consider itself trivial?

Raises:

LookupError - When the accessible object is dead

isAccVisible()

source code

Gets whether or not the accessible considers itself visible.

Returns: boolean

Does the accessible consider itself visible?

Raises:

LookupError - When the accessible object is dead

getAccRole()

source code

Gets the unlocalized string role identifier for the object implementing this interface.

Returns: string

Role name

Raises:

LookupError - When the accessible object is dead

hasAccRole(role)

source code

Gets if the subject has the given role.

Parameters:

role (string) - Name of the role

Returns: boolean

Does the accessible have the given role?

Raises:

LookupError - When the accessible object is dead

hasOneAccRole(*roles)

source code

Gets if the subject has any one of the given roles.

Parameters:

roles (list of string) - Names of the roles

Returns: boolean

Does the accessible have any one of the given roles?

hasAccState(state)

source code

Gets if the subject has the given state.

Parameters:

state (string) - Name of the state

Returns: boolean

Does the accessible have the given state?

Raises:

LookupError - When the accessible object is dead

hasAccOneState(*states)

source code

Gets if the subject has at least one of the given states.

Parameters:

states (string) - State names

Returns: boolean

Does the accessible have at least one of the given states?

Raises:

LookupError - When the accessible object is dead

hasAccAllStates(*states)

source code

Gets if the subject has all of the given states.

Parameters:

states (string) - State names

Returns: boolean

Does the accessible have all of the given states?

Raises:

LookupError - When the accessible object is dead

allowsAccEmbeds()

source code

Gets whether or not the subject accessible allows embedded objects in its text.

Returns: boolean

Does the subject allow embedded objects?

Raises:

LookupError - When the accessible object is dead

isAccTopLevelWindow()

source code

Gets whether or not the subject accessible is a top-level container in the accessible hierarchy.

Returns: boolean

Is the subject a top-level container or not?

Raises:

LookupError - When the accessible object is dead

getAccActionNames()

source code

Gets the list of all action names defined by the subject.

Returns: list of string

List of all action names

Raises:

LookupError - When the accessible object is dead

getAccActionDescs()

source code

Gets the list of all action descriptions defined by the subject.

Returns: list of string

List of all action descriptions

Raises:

LookupError - When the accessible object is dead

getAccActionCount()

source code

Gets the number of available actions on the subject.

Returns: integer

Number of actions available

Raises:

LookupError - When the accessible object is dead

getAccActionKeys()

source code

Gets the key bindings associated with all available actions.

Returns: list of tuple of string

List of tuples, each containing one or more string keysym names indicating the keys to press in sequence to perform the action

Raises:

LookupError - When the accessible object is dead

getAccTextSelectionCount(self)

source code

Gets the number of discontiguous selected text ranges.

Returns: integer

Number of selections

Raises:

LookupError - When the accessible object is dead

getAccCaret(self)

source code

Gets the current offset of the caret in this text object as a POR.

Returns: POR

Point of regard of the text caret in this object

Raises:

LookupError - When the accessible object is dead

getAccTextCharCount(self)

source code

Gets the number of characters in a text body.

Returns: integer

Total number of characters

Raises:

LookupError - When the accessible object is dead