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

Class MSHTML

source code

                   object --+                    
                            |                    
baseObject.AutoPropertyObject --+                
                                |                
      baseObject.ScriptableObject --+            
                                    |            
                           NVDAObject --+        
                                        |        
                            window.Window --+    
                                            |    
                                  IAccessible --+
                                                |
                                               MSHTML
Nested Classes [hide private]

Inherited from NVDAObject: TextInfo, __metaclass__

Instance Methods [hide private]
 
suspendCaretEvents(self)
Suspends caret events while you need to move the caret to calculate things.		 source code
 
event_caret(self) source code
 
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
 
_get_treeInterceptorClass(self)
If this NVDAObject should use a treeInterceptor, then this property provides the treeInterceptorHandler.TreeInterceptor class it should use.		 source code
 
_get_HTMLAttributes(self) source code
 
__init__(self, HTMLNode=None, IAccessibleObject=None, IAccessibleChildID=None, **kwargs)
x.__init__(...) initializes x; see help(type(x)) for signature		 source code
 
_get_TextInfo(self) 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
boolean
_isEqual(self, other)
Calculates if this object is equal to another object.		 source code
 
_get_presentationType(self) source code
bool
_get_shouldAllowIAccessibleFocusEvent(self)
Determine whether a focus event should be allowed for this 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
basestring
_get_description(self)
The description or help text of this object.		 source code
 
_get_basicText(self) source code
int
_get_role(self)
The role or type of control this object represents (example: button, list, dialog).		 source code
set of int
_get_states(self)
Retreaves the current states of this object (example: selected, focused).		 source code
 
_get_isContentEditable(self) 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_previous(self)
Retreaves the object directly before this object with the same parent.		 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_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
int
_get_columnNumber(self)
Retreaves the column number of this object if it is in a table.		 source code
int
_get_rowNumber(self)
Retreaves the row 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
 
scrollIntoView(self)
Scroll this object into view on the screen if possible.		 source code
 
doAction(self, index=None)
Performs an action supported by this object.		 source code
 
setFocus(self)
Tries to force this object to take the focus.		 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
 
_get_HTMLNodeUniqueNumber(self) source code
 
_get_HTMLNodeName(self) source code

Inherited from IAccessible: event_IA2AttributeChange, event_alert, event_selection, event_selectionAdd, event_selectionRemove, event_selectionWithIn, event_valueChange, getActionName, isPointInObject

Inherited from IAccessible (private): _getIA2RelationFirstTarget, _get_IA2Attributes, _get_IAccessibleIdentity, _get_IAccessibleRole, _get_IAccessibleStates, _get__IA2Relations, _get_actionCount, _get_activeChild, _get_allowIAccessibleChildIDAndChildCountForPositionInfo, _get_childCount, _get_children, _get_columnCount, _get_decodedAccDescription, _get_devInfo, _get_embeddingTextInfo, _get_flowsFrom, _get_flowsTo, _get_groupName, _get_hasFocus, _get_indexInParent, _get_isPresentableFocusAncestor, _get_keyboardShortcut, _get_labeledBy, _get_location, _get_positionInfo

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_container, _get_defaultActionIndex, _get_flatReviewPosition, _get_isProtected, _get_recursiveDescendants, _get_simpleFirstChild, _get_simpleLastChild, _get_simpleNext, _get_simpleParent, _get_simplePrevious, _get_statusBar, _get_treeInterceptor, _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]
boolean
kwargsFromSuper(cls, kwargs, relation=None)
Finds out if this class can be instanciated from the given super kwargs.		 source code

Inherited from IAccessible: getPossibleAPIClasses, windowHasExtraIAccessibles

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]
  HTMLNodeNameNavSkipList = ['#comment', 'SCRIPT', 'HEAD', 'HTML...
  HTMLNodeNameEmbedList = ['OBJECT', 'EMBED', 'APPLET', 'FRAME',...
  _ignoreCaretEvents = False
Set to true when moving the caret to calculate lines, event_caret will be disabled.

Inherited from IAccessible: IA2UniqueID, IAccessibleTableUsesTableCellIndexAttrib, hasEncodedAccDescription, re_positionInfoEncodedAccDescription

Inherited from window.Window: normalizedWindowClassNameCache

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

Instance Variables [hide private]

Inherited from IAccessible: IAccessibleChildID

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]

suspendCaretEvents(self)

source code 

Suspends caret events while you need to move the caret to calculate things.

Decorators:
  • @contextlib.contextmanager

event_caret(self)

source code 
Overrides: NVDAObject.event_caret

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)

_get_treeInterceptorClass(self)

source code 

If this NVDAObject should use a treeInterceptor, then this property provides the treeInterceptorHandler.TreeInterceptor class it should use. If not then it should be not implemented.

Overrides: NVDAObject._get_treeInterceptorClass
(inherited documentation)

__init__(self, HTMLNode=None, IAccessibleObject=None, IAccessibleChildID=None, **kwargs)
(Constructor)

source code 

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

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

_get_TextInfo(self)

source code 
Overrides: IAccessible._get_TextInfo

isDuplicateIAccessibleEvent(self, obj)

source code 

Compaires the object of an event to self to see if the event should be treeted as duplicate.

Overrides: IAccessible.isDuplicateIAccessibleEvent
(inherited documentation)

_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_presentationType(self)

source code 
Overrides: NVDAObject._get_presentationType

_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.
Overrides: IAccessible._get_shouldAllowIAccessibleFocusEvent
(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_description(self)

source code 

The description or help text of this object.

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

_get_basicText(self)

source code 
Overrides: NVDAObject._get_basicText

_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_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_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_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_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_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_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_rowCount(self)

source code 

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

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

scrollIntoView(self)

source code 

Scroll this object into view on the screen if possible.

Overrides: NVDAObject.scrollIntoView
(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)

setFocus(self)

source code 

Tries to force this object to take the focus.

Overrides: NVDAObject.setFocus
(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)

Class Variable Details [hide private]

HTMLNodeNameNavSkipList

Value:
['#comment', 'SCRIPT', 'HEAD', 'HTML', 'PARAM', 'STYLE']

HTMLNodeNameEmbedList

Value:
['OBJECT', 'EMBED', 'APPLET', 'FRAME', 'IFRAME']

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