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

Class UIA

source code

                   object --+                
                            |                
baseObject.AutoPropertyObject --+            
                                |            
      baseObject.ScriptableObject --+        
                                    |        
                           NVDAObject --+    
                                        |    
                            window.Window --+
                                            |
                                           UIA
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
a new object with type S, a subtype of T
__new__(cls, relation=None, windowHandle=None, UIAElement=None) source code
 
__init__(self, windowHandle=None, UIAElement=None)
x.__init__(...) initializes x; see help(type(x)) for signature		 source code
boolean
_isEqual(self, other)
Calculates if this object is equal to another object.		 source code
 
_get_UIAInvokePattern(self) source code
 
_get_UIATextPattern(self) source code
 
setFocus(self)
Tries to force this object to take the focus.		 source code
list of str
_get_devInfo(self)
Information about this object useful to developers.		 source code
basestring
_get_name(self)
The name or label of this object (example: the text of a button).		 source code
int
_get_role(self)
The role or type of control this object represents (example: button, list, dialog).		 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
set of int
_get_states(self)
Retreaves the current states of this object (example: selected, focused).		 source code
 
correctAPIForRelation(self, obj, relation=None) 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_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
int
_get_processID(self)
Retreaves an identifyer of the process this object is a part of.		 source code
tuple of int
_get_location(self)
The location of this object on the screen.		 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_hasFocus(self) source code

Inherited from window.Window: redraw

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

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

Inherited from NVDAObject (private): _findSimpleNext, _get_activeChild, _get_appModule, _get_basicText, _get_childCount, _get_children, _get_container, _get_defaultActionIndex, _get_embeddingTextInfo, _get_flatReviewPosition, _get_flowsFrom, _get_flowsTo, _get_indexInParent, _get_isPresentableFocusAncestor, _get_isProtected, _get_labeledBy, _get_positionInfo, _get_presentationType, _get_recursiveDescendants, _get_simpleFirstChild, _get_simpleLastChild, _get_simpleNext, _get_simpleParent, _get_simplePrevious, _get_statusBar, _get_table, _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__, __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 window.Window: getPossibleAPIClasses, normalizeWindowClassName

Inherited from NVDAObject: findBestAPIClass

Inherited from baseObject.AutoPropertyObject: invalidateCaches

Static Methods [hide private]

Inherited from NVDAObject: objectFromPoint, objectInForeground, objectWithFocus

Class Variables [hide private]
  liveNVDAObjectTable = weakref.WeakValueDictionary()

Inherited from window.Window: normalizedWindowClassNameCache

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

Instance Variables [hide private]

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]

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)

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)

__new__(cls, relation=None, windowHandle=None, UIAElement=None)

source code 
Returns: a new object with type S, a subtype of T
Overrides: object.__new__
(inherited documentation)

__init__(self, windowHandle=None, UIAElement=None)
(Constructor)

source code 

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

Overrides: object.__init__
(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)

setFocus(self)

source code 

Tries to force this object to take the focus.

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

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

correctAPIForRelation(self, obj, relation=None)

source code 
Overrides: window.Window.correctAPIForRelation

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

source code 

Retreaves an identifyer of the process this object is a part of.

Returns: int
Overrides: NVDAObject._get_processID
(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_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)

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