Trees       Indices       Help   
Module AEInterfaces :: Class IAccessibleAction
[hide private]
[frames] | no frames]

Class IAccessibleAction

source code

        object --+    
                 |    
AccAdapt.Interface --+
                     |
                    IAccessibleAction

Provides methods for manipulating accessible objects.

Instance Methods [hide private]
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 POR.		 source code
boolean
copyAccText(por)
Copy the text starting at the subject and ending at the given POR.		 source code
boolean
cutAccText(por)
Cut the text starting at the subject and ending at the given POR.		 source code
boolean
deleteAccText(por)
' Delete the text starting at the subject and ending at the given POR.		 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 POR.		 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 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]

setAccFocus()

source code 

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)

source code 

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)

source code 

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)

source code 

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()

source code 

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)

source code 

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)

source code 

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)

source code 

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

Parameters:
  • por (POR) - 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)

source code 

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

Parameters:
  • por (POR) - 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)

source code 

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

Parameters:
  • por (POR) - 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)

source code 

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

Parameters:
  • por (POR) - 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()

source code 

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)

source code 

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

Parameters:
  • por (POR) - 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)

source code 

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 (POR) - 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)

source code 

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

   Trees       Indices       Help   
Generated by Epydoc 3.0beta1 on Mon Jun 4 15:33:17 2007 http://epydoc.sourceforge.net