AccessEngine :: AEAccInterfaces :: IAccessibleAction :: Class IAccessibleAction

[frames] | no frames]

Class IAccessibleAction

            object --+    
                     |    
AEAccAdapter.Interface --+
                         |
                        IAccessibleAction

Provides methods for manipulating accessible objects.

Instance Methods

boolean

setAccFocus()
Gives the subject accessible the input focus.

source code

boolean

selectAcc(all=False)
Selects the subject accessible or one of its children or items if all is False.

source code

boolean

deselectAcc(all=False)
Deselects the subject accessible if all is False.

source code

boolean

doAccAction(index)
Executes the action given by the index in the list of all actions.

source code

boolean

setAccCaret()
Moves the caret to the location given by the subject.

source code

boolean

setAccText(text)
Replace contents of text area with the given text.

source code

boolean

insertAccText(text, attrs)
Inserts text at the location given by the subject.

source code

boolean

setAccTextAttrs(por, attrs)
Sets the accessible text attributes from the subject to the given AEPor.

source code

boolean

copyAccText(por)
Copy the text starting at the subject and ending at the given AEPor.

source code

boolean

cutAccText(por)
Cut the text starting at the subject and ending at the given AEPor.

source code

boolean

deleteAccText(por)
' Delete the text starting at the subject and ending at the given AEPor.

source code

boolean

pasteAccText()
Paste the text starting at the subject.

source code

boolean

selectAccText(por, n=None)
Adds a new selection if n is None or sets the nth selection otherwise starting at the subject and ending at the given AEPor.

source code

boolean

deselectAccText(por, n=None)
Removes a all text selections if n is None or removes the nth text selection otherwise.

source code

doMouseAction(event)
Performs a mouse event on the center of a given point of regard.

source code

Inherited from AEAccAdapter.Interface: __new__

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

Properties

Inherited from object: __class__

Method Details

setAccFocus()

Gives the subject accessible the input focus.

Returns: boolean

Did accessible accept (True) or refuse (False) the focus change?

Raises:

LookupError - When the accessible object is dead or does not support setting the focus

selectAcc(all=False)

Selects the subject accessible or one of its children or items if all is False. Selects all children or items if all is True.

Parameters:

all (boolean) - Select all items?

Returns: boolean

Did accessible accept (True) or refuse (False) the selection?

Raises:

LookupError - When the accessible object is dead

deselectAcc(all=False)

Deselects the subject accessible if all is False. Deselects all children if all is True.

Parameters:

all (boolean) - Deselect all children?

Returns: boolean

Did accessible accept (True) or refuse (False) the deselection?

Raises:

LookupError - When the accessible object is dead

doAccAction(index)

Executes the action given by the index in the list of all actions.

Parameters:

index (integer) - Index of the action to execute

Returns: boolean

Did the action execute (True) or not (False)?

Raises:

LookupError - When the accessible object is dead

setAccCaret()

Moves the caret to the location given by the subject.

Returns: boolean

Indicator of whether the caret was moved successfully

Raises:

LookupError - When the accessible object is dead

setAccText(text)

Replace contents of text area with the given text.

Parameters:

text (string) - Text to set as the content of the text area

Returns: boolean

Indicator of whether the text was set successfully or not

Raises:

LookupError - When the accessible object is dead

insertAccText(text, attrs)

Inserts text at the location given by the subject.

Parameters:

text (string) - Text to insert at the given position
attrs (dictionary) - Dictionary of string name/value pairs of text attributes to set on the inserted text

Returns: boolean

Indicator of whether the text was inserted successfully or not

Raises:

LookupError - When the accessible object is dead

setAccTextAttrs(por, attrs)

Sets the accessible text attributes from the subject to the given AEPor.

Parameters:

por (AEPor) - Point of regard to the end of the text run
attrs (dictionary) - Dictionary of string name/value pairs of text attributes to set on the text range

Returns: boolean

Indicator of whether the text attributes were set successfully or not

Raises:

LookupError - When the accessible object is dead

copyAccText(por)

Copy the text starting at the subject and ending at the given AEPor.

Parameters:

por (AEPor) - Point of regard to the end terminus of the copy operation

Returns: boolean

Indicator of whether the text was copied successfully or not

Raises:

LookupError - When the accessible object is dead

cutAccText(por)

Cut the text starting at the subject and ending at the given AEPor.

Parameters:

por (AEPor) - Point of regard to the end terminus of the copy operation

Returns: boolean

Indicator of whether the text was copied successfully or not

Raises:

LookupError - When the accessible object is dead

deleteAccText(por)

' Delete the text starting at the subject and ending at the given AEPor.

Parameters:

por (AEPor) - Point of regard to the end terminus of the copy operation

Returns: boolean

Indicator of whether the text was copied successfully or not

Raises:

LookupError - When the accessible object is dead

pasteAccText()

Paste the text starting at the subject.

Returns: boolean

Indicator of whether the text was copied successfully or not

Raises:

LookupError - When the accessible object is dead

selectAccText(por, n=None)

Adds a new selection if n is None or sets the nth selection otherwise starting at the subject and ending at the given AEPor.

Parameters:

por (AEPor) - Point of regard to the end terminus of the select operation

Returns: boolean

Indicator of whether the text was selected successfully or not

Raises:

LookupError - When the accessible object is dead

deselectAccText(por, n=None)

Removes a all text selections if n is None or removes the nth text selection otherwise. When n is None, returns True if at least one selection was removed.

Parameters:

por (AEPor) - Point of regard to the end terminus of the select operation

Returns: boolean

Indicator of whether the text was deselected successfully or not

Raises:

LookupError - When the accessible object is dead

doMouseAction(event)

Performs a mouse event on the center of a given point of regard.

Parameters:

event (integer of type EVENT_SYNTHMOUSE*) - Mouse event to perform

Returns:

Indicator of whether the event was performed (True) or not (False)

Raises:

LookupError - When the accessible object is dead