pyAA.AA.AccessibleObject

Package pyAA :: Module AA :: Class AccessibleObject

[show private | hide private]

Type AccessibleObject

object --+
         |
        AccessibleObject

Represents the properties and actions of some user interface object. Provides methods comparable to those of IAccessible and then some.

Method Summary
	`__init__(self, ia, child)` Initialize an instance.
	`ChildFromPath(self, path)` Return a child object at the leaf of the given path starting at this object.
	`DoDefaultAction(self)` Trigger the default action on the object.
list of AccessibleObject	`FindAllChildren(self, predicate)` Find all objects that satisfy the predicate.
list of AccessibleObject	`FindAllChildrenInternal(self, predicate, result)` Find all objects that satisfy the predicate.
AccessibleObject	`FindOneChild(self, predicate)` Search for an object that satisfies the predicate.
AccessibleObject	`FindOneChildInternal(self, predicate)` Search for an object that satisfies the predicate.
integer	`GetChildCount(self)` Return number of children of this object
integer	`GetChildID(self)` Return child ID of this object or CHILDID_SELF
list of AccessibleObject	`GetChildren(self)` Return children of this object
string	`GetClassName(self)` Return window class name of the object
string	`GetDescription(self)` Return description of the object
AccessibleObject	`GetFocus(self)` Return object that has the focus or None if there is no focus
string	`GetHelp(self)` Return help associated with the object
string	`GetKeyboardShortcut(self)` Return shortcut or mnemonic associated with an object
4-tuple of integer	`GetLocation(self)` Return bounding box of the object on the screen (x1, y1, x2, y2)
string	`GetName(self)` Return name of the object
AccessibleObject	`GetParent(self)` Return parent of this object
string	`GetPath(self)` Return xPath representation of this object from a root object below the Desktop
2-tuple of integer	`GetProcessAndThreadID(self)` Return iDs of the process and thread that created this object
integer	`GetRole(self)` Return role of the object
string	`GetRoleText(self)` Return description of the role of the object
list of AccessibleObject	`GetSelection(self)` Return all selected children
integer	`GetState(self)` Return state of the object as a bit mask
string	`GetStateText(self)` Return description of the state of the object
string	`GetValue(self)` Return value of the object
integer	`GetWindow(self)` Return window handle for this object, not guaranteed unique
AccessibleObject	`HitTest(self, point)` Return the AccessibleObject contained in this one that contains the point.
boolean	`IsNotReady(self)` Return is the object invisible or unavailable?
AccessibleObject	`Navigate(self, direction)` Get the AccessibleObject in the direction specified.
	`Select(self, flags_select)` Select this object.
	`SetFocus(self)` Give this object the focus using a Win32 SetFocus callif possible.
Inherited from `object`: `__delattr__`, `__getattribute__`, `__hash__`, `__new__`, `__reduce__`, `__reduce_ex__`, `__repr__`, `__setattr__`, `__str__`

Property Summary
	`ChildCount`
	`ChildID`
	`Children`
	`ClassName`
	`Description`
	`Focus`
	`Help`
	`KeyboardShortcut`
	`Location`
	`Name`
	`Parent`
	`Path`
	`ProcessID`
	`Role`
	`RoleText`
	`Selection`
	`State`
	`StateText`
	`Value`
	`Window`

Instance Variable Summary
integer	`child`: Child ID if this is a proxy to a child window
opaque pointer to IAccessible object	`ia`: Pointer to an IAccessible interface

Method Details

init(self, ia=None, child=None)
(Constructor)

Initialize an instance.

See instance variables for descriptions of parameters.

Overrides:: __builtin__.object.__init__

ChildFromPath(self, path)

Return a child object at the leaf of the given path starting at this object.

Parameters:: path - XPath like repesentation to a unique descendent object of this object
(type=string)

DoDefaultAction(self)

Trigger the default action on the object.

FindAllChildren(self, predicate)

Find all objects that satisfy the predicate.

Parameters:: predicate - Function that evaluates to true for the desired object
(type=function)

Returns:: Target objects or None if not found
(type=list of AccessibleObject)

FindAllChildrenInternal(self, predicate, result)

Find all objects that satisfy the predicate. Do not call this method directly.

Parameters:: predicate - Function that evaluates to true for the desired object
(type=function); result - Temporary storage for recursive search
(type=list of AccessibleObject)

Returns:: Target objects or None if not found
(type=list of AccessibleObject)

FindOneChild(self, predicate)

Search for an object that satisfies the predicate.

Parameters:: predicate - Function that evaluates to true for the desired object
(type=function)

Returns:: Target object or None if not found
(type=AccessibleObject)

FindOneChildInternal(self, predicate)

Search for an object that satisfies the predicate. Do not call this method directly.

Parameters:: predicate - Function that evaluates to true for the desired object
(type=function)

Returns:: Target object or None if not found
(type=AccessibleObject)

GetChildCount(self)

Returns:: Number of children of this object
(type=integer)

GetChildID(self)

Returns:: Child ID of this object or CHILDID_SELF
(type=integer)

GetChildren(self)

Returns:: Children of this object
(type=list of AccessibleObject)

GetClassName(self)

Returns:: Window class name of the object
(type=string)

GetDescription(self)

Returns:: Description of the object
(type=string)

GetFocus(self)

Returns:: Object that has the focus or None if there is no focus
(type=AccessibleObject)

Note: What is the scope? Children? Whole system?

GetHelp(self)

Returns:: Help associated with the object
(type=string)

GetKeyboardShortcut(self)

Returns:: Shortcut or mnemonic associated with an object
(type=string)

GetLocation(self)

Returns:: Bounding box of the object on the screen (x1, y1, x2, y2)
(type=4-tuple of integer)

GetName(self)

Returns:: Name of the object
(type=string)

GetParent(self)

Returns:: Parent of this object
(type=AccessibleObject)

GetPath(self)

Returns:: XPath representation of this object from a root object below the Desktop
(type=string)

GetProcessAndThreadID(self)

Returns:: IDs of the process and thread that created this object
(type=2-tuple of integer)

GetRole(self)

Returns:: Role of the object
(type=integer)

GetRoleText(self)

Returns:: Description of the role of the object
(type=string)

GetSelection(self)

Returns:: All selected children
(type=list of AccessibleObject)

GetState(self)

Returns:: State of the object as a bit mask
(type=integer)

GetStateText(self)

Returns:: Description of the state of the object
(type=string)

GetValue(self)

Returns:: Value of the object
(type=string)

GetWindow(self)

Returns:: Window handle for this object, not guaranteed unique
(type=integer)

HitTest(self, point)

Return the AccessibleObject contained in this one that contains the point.

Parameters:: point - Point on the display
(type=2-tuple of integer)

Returns:: Object at the given point or None
(type=AccessibleObject)

IsNotReady(self)

Returns:: Is the object invisible or unavailable?
(type=boolean)

Navigate(self, direction)

Get the AccessibleObject in the direction specified. The direction is one of the pyAA.Constants.NAVDIR_* constants which represent the spatial directions (up, down, left, and right) and the logical directions (previous and next). Constants for the first and last children are also included.

Parameters:: direction - Direction to move
(type=integer)

Returns:: Object in the direction specified if one exists
(type=AccessibleObject)

Select(self, flags_select)

Select this object.

Parameters:: flags_select - Selection constants
(type=integer)

SetFocus(self)

Give this object the focus using a Win32 SetFocus callif possible.

Property Details

ChildCount

Get Method:: GetChildCount(self)

ChildID

Get Method:: GetChildID(self)

Children

Get Method:: GetChildren(self)

ClassName

Get Method:: GetClassName(self)

Description

Get Method:: GetDescription(self)

Focus

Get Method:: GetFocus(self)

Help

Get Method:: GetHelp(self)

KeyboardShortcut

Get Method:: GetKeyboardShortcut(self)

Location

Get Method:: GetLocation(self)

Name

Get Method:: GetName(self)

Parent

Get Method:: GetParent(self)

Path

Get Method:: GetPath(self)

ProcessID

Get Method:: GetProcessAndThreadID(self)

Role

Get Method:: GetRole(self)

RoleText

Get Method:: GetRoleText(self)

Selection

Get Method:: GetSelection(self)

State

Get Method:: GetState(self)

StateText

Get Method:: GetStateText(self)

Value

Get Method:: GetValue(self)

Window

Get Method:: GetWindow(self)

Instance Variable Details

child

Child ID if this is a proxy to a child window

Type:: integer

ia

Pointer to an IAccessible interface

Type:: opaque pointer to IAccessible object

Generated by Epydoc 2.1 on Thu Mar 10 23:08:34 2005

http://epydoc.sf.net