Package NVDAObjects :: Module behaviors :: Class Dialog

[frames] | no frames]

Class Dialog

                   object --+            
                            |            
baseObject.AutoPropertyObject --+        
                                |        
      baseObject.ScriptableObject --+    
                                    |    
                           NVDAObject --+
                                        |
                                       Dialog

Overrides the description property to obtain dialog text.

Nested Classes

Inherited from NVDAObject: TextInfo, __metaclass__

Instance Methods

basestring

_get_description(self)
The description or help text of this object.

source code

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

Inherited from NVDAObject (private): _findSimpleNext, _get_actionCount, _get_activeChild, _get_appModule, _get_basicText, _get_childCount, _get_children, _get_columnCount, _get_columnNumber, _get_container, _get_defaultActionIndex, _get_devInfo, _get_embeddingTextInfo, _get_firstChild, _get_flatReviewPosition, _get_flowsFrom, _get_flowsTo, _get_indexInParent, _get_isInForeground, _get_isPresentableFocusAncestor, _get_isProtected, _get_keyboardShortcut, _get_labeledBy, _get_lastChild, _get_location, _get_name, _get_next, _get_parent, _get_positionInfo, _get_presentationType, _get_previous, _get_processID, _get_recursiveDescendants, _get_role, _get_rowCount, _get_rowNumber, _get_simpleFirstChild, _get_simpleLastChild, _get_simpleNext, _get_simpleParent, _get_simplePrevious, _get_states, _get_statusBar, _get_table, _get_treeInterceptor, _get_treeInterceptorClass, _get_value, _isEqual, _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

getDialogText(cls, obj)
This classmethod walks through the children of the given object, and collects up and returns any text that seems to be part of a dialog's message text.

source code

Inherited from NVDAObject: findBestAPIClass, getPossibleAPIClasses, kwargsFromSuper

Inherited from baseObject.AutoPropertyObject: invalidateCaches

Static Methods

Inherited from NVDAObject: objectFromPoint, objectInForeground, objectWithFocus

Class Variables

value = None
hash(x)

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

Instance Variables

Inherited from NVDAObject: textRepresentationLineLength

Inherited from NVDAObject (private): _mouseEntered

Properties

Inherited from object: __class__

Method Details

getDialogText(cls, obj)
Class Method

This classmethod walks through the children of the given object, and collects up and returns any text that seems to be part of a dialog's message text.

Parameters:

obj (IAccessible) - the object who's children you want to collect the text from

_get_description(self)

The description or help text of this object.

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