Package NVDAObjects :: Package window :: Module excel :: Class ExcelWorksheet

Class ExcelWorksheet

                   object --+                    
                            |                    
baseObject.AutoPropertyObject --+                
                                |                
      baseObject.ScriptableObject --+            
                                    |            
                           NVDAObject --+        
                                        |        
                                   Window --+    
                                            |    
                                    ExcelBase --+
                                                |
                                               ExcelWorksheet

Nested Classes

[hide private]

Inherited from NVDAObject: TextInfo, __metaclass__

Instance Methods

[hide private]

__init__(self, windowHandle=None, excelWindowObject=None, excelWorksheetObject=None)
x.__init__(...) initializes x; see help(type(x)) for signature

source code

basestring

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

source code

boolean

_isEqual(self, other)
Calculates if this object is equal to another object.

source code

NVDAObject or None

_get_firstChild(self)
Retreaves the first object that this object contains.

source code

script_changeSelection(self, gesture)

source code

Inherited from ExcelBase: fireFocusOnSelection

Inherited from Window: correctAPIForRelation, findOverlayClasses, redraw

Inherited from Window (private): _get_devInfo, _get_displayText, _get_isInForeground, _get_isWindowUnicode, _get_lastChild, _get_location, _get_next, _get_parent, _get_previous, _get_processHandle, _get_processID, _get_role, _get_states, _get_windowClassName, _get_windowControlID, _get_windowStyle, _get_windowText, _get_windowThreadID

Inherited from NVDAObject: __eq__, __ne__, doAction, event_becomeNavigatorObject, event_caret, event_descriptionChange, event_focusEntered, event_foreground, event_gainFocus, event_mouseMove, event_nameChange, event_stateChange, event_typedCharacter, event_valueChange, 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_description, _get_embeddingTextInfo, _get_flatReviewPosition, _get_flowsFrom, _get_flowsTo, _get_indexInParent, _get_isPresentableFocusAncestor, _get_isProtected, _get_keyboardShortcut, _get_labeledBy, _get_positionInfo, _get_presentationType, _get_recursiveDescendants, _get_rowCount, _get_rowNumber, _get_simpleFirstChild, _get_simpleLastChild, _get_simpleNext, _get_simpleParent, _get_simplePrevious, _get_statusBar, _get_table, _get_treeInterceptor, _get_treeInterceptorClass, _get_value, _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]

Inherited from Window: getPossibleAPIClasses, kwargsFromSuper, normalizeWindowClassName

Inherited from NVDAObject: findBestAPIClass

Inherited from baseObject.AutoPropertyObject: invalidateCaches

Static Methods

[hide private]

Inherited from ExcelBase: excelWindowObjectFromWindow, getCellAddress

Inherited from NVDAObject: objectFromPoint, objectInForeground, objectWithFocus

Class Variables

[hide private]

role = 28

__changeSelectionGestures = "kb:tab", "kb:shift+tab", "kb:upAr...

Inherited from Window: normalizedWindowClassNameCache

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

Instance Variables

[hide private]

Inherited from 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]

init(self, windowHandle=None, excelWindowObject=None, excelWorksheetObject=None)
(Constructor)

source code

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

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

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

Class Variable Details

[hide private]

__changeSelectionGestures

Value:

"kb:tab", "kb:shift+tab", "kb:upArrow", "kb:downArrow", "kb:leftArrow"
, "kb:rightArrow", "kb:control+upArrow", "kb:control+downArrow", "kb:c
ontrol+leftArrow", "kb:control+rightArrow", "kb:home", "kb:end", "kb:c
ontrol+home", "kb:control+end", "kb:shift+upArrow", "kb:shift+downArro
w", "kb:shift+leftArrow", "kb:shift+rightArrow", "kb:shift+control+upA
rrow", "kb:shift+control+downArrow", "kb:shift+control+leftArrow", "kb
:shift+control+rightArrow", "kb:shift+home", "kb:shift+end", "kb:shift
+control+home", "kb:shift+control+end", "kb:shift+space", "kb:control+
...

Class ExcelWorksheet

__init__(self, windowHandle=None, excelWindowObject=None, excelWorksheetObject=None) (Constructor)

_get_name(self)

_isEqual(self, other)

_get_firstChild(self)

__changeSelectionGestures

init(self, windowHandle=None, excelWindowObject=None, excelWorksheetObject=None)
(Constructor)