Trees       Indices       Help   
Package NVDAObjects :: Package IAccessible :: Class IAccessible
[hide private]
[frames] | no frames]

Class IAccessible

source code

                   object --+                
                            |                
baseObject.AutoPropertyObject --+            
                                |            
      baseObject.ScriptableObject --+        
                                    |        
                           NVDAObject --+    
                                        |    
                            window.Window --+
                                            |
                                           IAccessible

the NVDAObject for IAccessible

Nested Classes [hide private]

Inherited from NVDAObject: TextInfo, __metaclass__

Instance Methods [hide private]
 
findOverlayClasses(self, clsList)
Chooses overlay classes which should be added to this object's class structure after the object has been initially instantiated.		 source code
 
__init__(self, windowHandle=None, IAccessibleObject=None, IAccessibleChildID=None, event_windowHandle=None, event_objectID=None, event_childID=None)
x.__init__(...) initializes x; see help(type(x)) for signature		 source code
 
isDuplicateIAccessibleEvent(self, obj)
Compaires the object of an event to self to see if the event should be treeted as duplicate.		 source code
bool
_get_shouldAllowIAccessibleFocusEvent(self)
Determine whether a focus event should be allowed for this object.		 source code
 
_get_TextInfo(self) source code
boolean
_isEqual(self, other)
Calculates if this object is equal to another object.		 source code
basestring
_get_name(self)
The name or label of this object (example: the text of a button).		 source code
basestring
_get_value(self)
The value of this object (example: the current percentage of a scrollbar, the selected option in a combo box).		 source code
 
_get_actionCount(self)
Retreaves the number of actions supported by this object.		 source code
basestring
getActionName(self, index=None)
Retreaves the name of an action supported by this object.		 source code
 
doAction(self, index=None)
Performs an action supported by this object.		 source code
 
_get_IAccessibleIdentity(self) source code
 
_get_IAccessibleRole(self) source code
int
_get_role(self)
The role or type of control this object represents (example: button, list, dialog).		 source code
 
_get_IAccessibleStates(self) source code
set of int
_get_states(self)
Retreaves the current states of this object (example: selected, focused).		 source code
 
_get_decodedAccDescription(self) source code
basestring
_get_description(self)
The description or help text of this object.		 source code
basestring
_get_keyboardShortcut(self)
The shortcut key that activates this object(example: alt+t).		 source code
int
_get_childCount(self)
Retreaves the number of children this object contains.		 source code
tuple of int
_get_location(self)
The location of this object on the screen.		 source code
 
isPointInObject(self, x, y) source code
NVDAObject or None
_get_labeledBy(self)
Retreaves the object that this object is labeled by (example: the static text label beside an edit field).		 source code
NVDAObject or None
_get_parent(self)
Retreaves this object's parent (the object that contains this object).		 source code
NVDAObject or None
_get_next(self)
Retreaves the object directly after this object with the same parent.		 source code
NVDAObject or None
_get_previous(self)
Retreaves the object directly before this object with the same parent.		 source code
NVDAObject or None
_get_firstChild(self)
Retreaves the first object that this object contains.		 source code
NVDAObject or None
_get_lastChild(self)
Retreaves the last object that this object contains.		 source code
list of NVDAObject
_get_children(self)
Retreaves a list of all the objects directly contained by this object (who's parent is this object).		 source code
 
_get_IA2Attributes(self) source code
 
event_IA2AttributeChange(self) source code
int
_get_rowNumber(self)
Retreaves the row number of this object if it is in a table.		 source code
int
_get_columnNumber(self)
Retreaves the column number of this object if it is in a table.		 source code
int
_get_rowCount(self)
Retreaves the number of rows this object contains if its a table.		 source code
int
_get_columnCount(self)
Retreaves the number of columns this object contains if its a table.		 source code
NVDAObject
_get_table(self)
Retreaves the object that represents the table that this object is contained in, if this object is a table cell.		 source code
NVDAObject or None
_get_activeChild(self)
Retreaves the child of this object that currently has, or contains, the focus.		 source code
 
_get_hasFocus(self) source code
 
setFocus(self)
Tries to force this object to take the focus.		 source code
 
scrollIntoView(self)
Scroll this object into view on the screen if possible.		 source code
 
_get_allowIAccessibleChildIDAndChildCountForPositionInfo(self)
if true position info should fall back to using the childID and the parent's accChildCount for position information if there is nothing better available.		 source code
dict
_get_positionInfo(self)
Retreaves position information for this object such as its level, its index with in a group, and the number of items in that group.		 source code
int
_get_indexInParent(self)
The index of this object in its parent object.		 source code
 
_get__IA2Relations(self) source code
 
_getIA2RelationFirstTarget(self, relationType) source code
NVDAObject
_get_flowsTo(self)
The object to which content flows from this object.		 source code
NVDAObject
_get_flowsFrom(self)
The object from which content flows to this object.		 source code
textInfos.TextInfo
_get_embeddingTextInfo(self)
Retrieve the parent text range which embeds this object.		 source code
 
event_valueChange(self) source code
 
event_alert(self) source code
 
event_caret(self) source code
 
_get_groupName(self) source code
 
event_selection(self) source code
 
event_selectionAdd(self) source code
 
event_selectionRemove(self) source code
 
event_selectionWithIn(self) source code
 
_get_presentationType(self) source code
bool
_get_isPresentableFocusAncestor(self)
Determine if this object should be presented to the user in the focus ancestry.		 source code
list of str
_get_devInfo(self)
Information about this object useful to developers.		 source code

Inherited from window.Window: correctAPIForRelation, redraw

Inherited from window.Window (private): _get_displayText, _get_isInForeground, _get_isWindowUnicode, _get_processHandle, _get_processID, _get_windowClassName, _get_windowControlID, _get_windowStyle, _get_windowText, _get_windowThreadID

Inherited from NVDAObject: __eq__, __ne__, event_becomeNavigatorObject, event_descriptionChange, event_focusEntered, event_foreground, event_gainFocus, event_mouseMove, event_nameChange, event_stateChange, event_typedCharacter, makeTextInfo, reportFocus

Inherited from NVDAObject (private): _findSimpleNext, _get_appModule, _get_basicText, _get_container, _get_defaultActionIndex, _get_flatReviewPosition, _get_isProtected, _get_recursiveDescendants, _get_simpleFirstChild, _get_simpleLastChild, _get_simpleNext, _get_simpleParent, _get_simplePrevious, _get_statusBar, _get_treeInterceptor, _get_treeInterceptorClass, _set_treeInterceptor

Inherited from baseObject.ScriptableObject: bindGesture, bindGestures, clearGestureBindings, getScript

Inherited from baseObject.AutoPropertyObject: invalidateCache

Inherited from baseObject.AutoPropertyObject (private): _getPropertyViaCache

Inherited from object: __delattr__, __format__, __getattribute__, __hash__, __new__, __reduce__, __reduce_ex__, __repr__, __setattr__, __sizeof__, __str__, __subclasshook__

Class Methods [hide private]
generator
getPossibleAPIClasses(cls, kwargs, relation=None)
Provides a generator which can generate all the possible API classes (in priority order) that inherit directly from the class it was called on.		 source code
boolean
kwargsFromSuper(cls, kwargs, relation=None)
Finds out if this class can be instanciated from the given super kwargs.		 source code
 
windowHasExtraIAccessibles(cls, windowHandle)
Finds out whether this window has things such as a system menu / titleBar / scroll bars, which would be represented as extra IAccessibles		 source code

Inherited from window.Window: normalizeWindowClassName

Inherited from NVDAObject: findBestAPIClass

Inherited from baseObject.AutoPropertyObject: invalidateCaches

Static Methods [hide private]

Inherited from NVDAObject: objectFromPoint, objectInForeground, objectWithFocus

Class Variables [hide private]
  IAccessibleTableUsesTableCellIndexAttrib = False
Should the table-cell-index IAccessible2 object attribute be used rather than indexInParent?
  IA2UniqueID = None
The cached IAccessible2::uniqueID if its implemented
  re_positionInfoEncodedAccDescription = re.compile(r"L(?P<level...
  hasEncodedAccDescription = False
If true, accDescription contains info such as level, and number of items etc.

Inherited from window.Window: normalizedWindowClassNameCache

Inherited from NVDAObject: beTransparentToMouse, cachePropertiesByDefault, presType_content, presType_layout, presType_unavailable, tableCellCoordsInName

Instance Variables [hide private]
int IAccessibleChildID
the IAccessible object's child ID

Inherited from window.Window: windowClassName, windowControlID, windowHandle, windowProcessID, windowText

Inherited from NVDAObject: textRepresentationLineLength

Inherited from NVDAObject (private): _mouseEntered

Properties [hide private]

Inherited from object: __class__

Method Details [hide private]

getPossibleAPIClasses(cls, kwargs, relation=None)
Class Method

source code 

Provides a generator which can generate all the possible API classes (in priority order) that inherit directly from the class it was called on.

Parameters:
  • relation - the relationship of a possible new object of this type to another object creating it (e.g. parent).
  • type - string
  • kwargs - the arguments necessary to construct an object of the class this method was called on.
Returns: generator
a generator
Overrides: NVDAObject.getPossibleAPIClasses
(inherited documentation)

kwargsFromSuper(cls, kwargs, relation=None)
Class Method

source code 

Finds out if this class can be instanciated from the given super kwargs. If so it updates the kwargs to contain everything it will need to instanciate this class, and returns True. If this class can not be instanciated, it returns False and kwargs is not touched.

Parameters:
  • relation - why is this class being instanciated? parent, focus, foreground etc...
  • kwargs - the kwargs for constructing this class's super class.
Returns: boolean
Overrides: NVDAObject.kwargsFromSuper
(inherited documentation)

findOverlayClasses(self, clsList)

source code 

Chooses overlay classes which should be added to this object's class structure after the object has been initially instantiated. After an NVDAObject class (normally an API-level class) is instantiated, this method is called on the instance to choose appropriate overlay classes. This method may use properties, etc. on the instance to make this choice. The object's class structure is then mutated to contain these classes. initOverlayClass is then called for each class which was not part of the initially instantiated object. This process allows an NVDAObject to be dynamically created using the most appropriate NVDAObject subclass at each API level. Classes should be listed with subclasses first. That is, subclasses should generally call super and then append their own classes to the list. For example: Called on an IAccessible NVDAObjectThe list might contain DialogIaccessible (a subclass of IAccessible), Edit (a subclass of Window).

Parameters:
  • clsList - The list of classes, which will be modified by this method if appropriate.
Overrides: NVDAObject.findOverlayClasses
(inherited documentation)

__init__(self, windowHandle=None, IAccessibleObject=None, IAccessibleChildID=None, event_windowHandle=None, event_objectID=None, event_childID=None)
(Constructor)

source code 

x.__init__(...) initializes x; see help(type(x)) for signature

Parameters:
  • pacc (ctypes.POINTER(IAccessible)) - a pointer to an IAccessible object
  • child (int) - A child ID that will be used on all methods of the IAccessible pointer
  • hwnd (int) - the window handle, if known
  • objectID (int) - the objectID for the IAccessible Object, if known
Overrides: object.__init__

_get_shouldAllowIAccessibleFocusEvent(self)

source code 

Determine whether a focus event should be allowed for this object. Normally, this checks for the focused state to help eliminate redundant or invalid focus events. However, some implementations do not correctly set the focused state, so this must be overridden.

Returns: bool
True if the focus event should be allowed.

_isEqual(self, other)

source code 

Calculates if this object is equal to another object. Used by NVDAObject.__eq__.

Parameters:
  • other - the other object to compare with.
Returns: boolean
True if equal, false otherwise.
Overrides: NVDAObject._isEqual
(inherited documentation)

_get_name(self)

source code 

The name or label of this object (example: the text of a button).

Returns: basestring
Overrides: NVDAObject._get_name
(inherited documentation)

_get_value(self)

source code 

The value of this object (example: the current percentage of a scrollbar, the selected option in a combo box).

Returns: basestring
Overrides: NVDAObject._get_value
(inherited documentation)

_get_actionCount(self)

source code 

Retreaves the number of actions supported by this object.

Overrides: NVDAObject._get_actionCount
(inherited documentation)

getActionName(self, index=None)

source code 

Retreaves the name of an action supported by this object. If index is not given then the default action will be used if it exists.

Parameters:
  • index - the optional 0-based index of the wanted action.
Returns: basestring
the action's name
Overrides: NVDAObject.getActionName
(inherited documentation)

doAction(self, index=None)

source code 

Performs an action supported by this object. If index is not given then the default action will be used if it exists.

Overrides: NVDAObject.doAction
(inherited documentation)

_get_role(self)

source code 

The role or type of control this object represents (example: button, list, dialog).

Returns: int
a ROLE_* constant from controlTypes
Overrides: NVDAObject._get_role
(inherited documentation)

_get_states(self)

source code 

Retreaves the current states of this object (example: selected, focused).

Returns: set of int
a set of STATE_* constants from controlTypes.
Overrides: NVDAObject._get_states
(inherited documentation)

_get_description(self)

source code 

The description or help text of this object.

Returns: basestring
Overrides: NVDAObject._get_description
(inherited documentation)

_get_keyboardShortcut(self)

source code 

The shortcut key that activates this object(example: alt+t).

Returns: basestring
Overrides: NVDAObject._get_keyboardShortcut
(inherited documentation)

_get_childCount(self)

source code 

Retreaves the number of children this object contains.

Returns: int
Overrides: NVDAObject._get_childCount
(inherited documentation)

_get_location(self)

source code 

The location of this object on the screen.

Returns: tuple of int
left, top, width and height of the object.
Overrides: NVDAObject._get_location
(inherited documentation)

_get_labeledBy(self)

source code 

Retreaves the object that this object is labeled by (example: the static text label beside an edit field).

Returns: NVDAObject or None
the label object if it has one else None.
Overrides: NVDAObject._get_labeledBy
(inherited documentation)

_get_parent(self)

source code 

Retreaves this object's parent (the object that contains this object).

Returns: NVDAObject or None
the parent object if it exists else None.
Overrides: NVDAObject._get_parent
(inherited documentation)

_get_next(self)

source code 

Retreaves the object directly after this object with the same parent.

Returns: NVDAObject or None
the next object if it exists else None.
Overrides: NVDAObject._get_next
(inherited documentation)

_get_previous(self)

source code 

Retreaves the object directly before this object with the same parent.

Returns: NVDAObject or None
the previous object if it exists else None.
Overrides: NVDAObject._get_previous
(inherited documentation)

_get_firstChild(self)

source code 

Retreaves the first object that this object contains.

Returns: NVDAObject or None
the first child object if it exists else None.
Overrides: NVDAObject._get_firstChild
(inherited documentation)

_get_lastChild(self)

source code 

Retreaves the last object that this object contains.

Returns: NVDAObject or None
the last child object if it exists else None.
Overrides: NVDAObject._get_lastChild
(inherited documentation)

_get_children(self)

source code 

Retreaves a list of all the objects directly contained by this object (who's parent is this object).

Returns: list of NVDAObject
Overrides: NVDAObject._get_children
(inherited documentation)

_get_rowNumber(self)

source code 

Retreaves the row number of this object if it is in a table.

Returns: int
Overrides: NVDAObject._get_rowNumber
(inherited documentation)

_get_columnNumber(self)

source code 

Retreaves the column number of this object if it is in a table.

Returns: int
Overrides: NVDAObject._get_columnNumber
(inherited documentation)

_get_rowCount(self)

source code 

Retreaves the number of rows this object contains if its a table.

Returns: int
Overrides: NVDAObject._get_rowCount
(inherited documentation)

_get_columnCount(self)

source code 

Retreaves the number of columns this object contains if its a table.

Returns: int
Overrides: NVDAObject._get_columnCount
(inherited documentation)

_get_table(self)

source code 

Retreaves the object that represents the table that this object is contained in, if this object is a table cell.

Returns: NVDAObject
Overrides: NVDAObject._get_table
(inherited documentation)

_get_activeChild(self)

source code 

Retreaves the child of this object that currently has, or contains, the focus.

Returns: NVDAObject or None
the active child if it has one else None
Overrides: NVDAObject._get_activeChild
(inherited documentation)

setFocus(self)

source code 

Tries to force this object to take the focus.

Overrides: NVDAObject.setFocus
(inherited documentation)

scrollIntoView(self)

source code 

Scroll this object into view on the screen if possible.

Overrides: NVDAObject.scrollIntoView
(inherited documentation)

_get_positionInfo(self)

source code 

Retreaves position information for this object such as its level, its index with in a group, and the number of items in that group.

Returns: dict
a dictionary containing any of level, groupIndex and similarItemsInGroup.
Overrides: NVDAObject._get_positionInfo
(inherited documentation)

_get_indexInParent(self)

source code 

The index of this object in its parent object.

Returns: int
The 0 based index, None if there is no parent.
Raises:
  • NotImplementedError - If not supported by the underlying object.
Overrides: NVDAObject._get_indexInParent
(inherited documentation)

_get_flowsTo(self)

source code 

The object to which content flows from this object.

Returns: NVDAObject
The object to which this object flows, None if none.
Raises:
  • NotImplementedError - If not supported by the underlying object.
Overrides: NVDAObject._get_flowsTo
(inherited documentation)

_get_flowsFrom(self)

source code 

The object from which content flows to this object.

Returns: NVDAObject
The object from which this object flows, None if none.
Raises:
  • NotImplementedError - If not supported by the underlying object.
Overrides: NVDAObject._get_flowsFrom
(inherited documentation)

_get_embeddingTextInfo(self)

source code 

Retrieve the parent text range which embeds this object. The returned text range will have its start positioned on the embedded object character associated with this object. That is, calling textInfos.TextInfo.getEmbeddedObject() on the returned text range will return this object.

Returns: textInfos.TextInfo
The text range for the embedded object character associated with this object or None if this is not an embedded object.
Raises:
  • NotImplementedError - If not supported.
Overrides: NVDAObject._get_embeddingTextInfo
(inherited documentation)

event_valueChange(self)

source code 
Overrides: NVDAObject.event_valueChange

event_caret(self)

source code 
Overrides: NVDAObject.event_caret

_get_presentationType(self)

source code 
Overrides: NVDAObject._get_presentationType

_get_isPresentableFocusAncestor(self)

source code 

Determine if this object should be presented to the user in the focus ancestry.

Returns: bool
True if it should be presented in the focus ancestry, False if not.
Overrides: NVDAObject._get_isPresentableFocusAncestor
(inherited documentation)

_get_devInfo(self)

source code 

Information about this object useful to developers. Subclasses may extend this, calling the superclass property first.

Returns: list of str
A list of text strings providing information about this object useful to developers.
Overrides: NVDAObject._get_devInfo
(inherited documentation)

Class Variable Details [hide private]

re_positionInfoEncodedAccDescription

Value:
re.compile(r"L(?P<level>\d+)(?:, (?P<indexInGroup>\d+) of (?P<similarI\
temsInGroup>\d+))?")

   Trees       Indices       Help   
Generated by Epydoc 3.0.1 on Fri Nov 18 17:45:51 2011 http://epydoc.sourceforge.net