Ticket #228: 228-2.patch

source/NVDAObjects/IAccessible/__init__.py

@@ -1 +1 @@
 #NVDAObjects/IAccessible.py
 #A part of NonVisual Desktop Access (NVDA)
-#Copyright (C) 2006-2007 NVDA Contributors <http://www.nvda-project.org/>
+#Copyright (C) 2006-2011 NVDA Contributors <http://www.nvda-project.org/>
 #This file is covered by the GNU General Public License.
 #See the file COPYING for more details.
 
@@ -1173 +1173 @@
                 if self in api.getFocusAncestors():
                         return
                 speech.cancelSpeech()
-                speech.speakObject(self, reason=speech.REASON_FOCUS)
+                speech.speakObject(self, reason=controlTypes.REASON_FOCUS)
                 for child in self.recursiveDescendants:
                         if controlTypes.STATE_FOCUSABLE in child.states:
-                                speech.speakObject(child, reason=speech.REASON_FOCUS)
+                                speech.speakObject(child, reason=controlTypes.REASON_FOCUS)
 
         def event_caret(self):
                 super(IAccessible, self).event_caret()
@@ -1227 +1227 @@
                         h=hash(child)
                         if h not in hashList:
                                 hashList.append(h)
-                                speech.speakObject(child,reason=speech.REASON_FOCUS)
+                                speech.speakObject(child,reason=controlTypes.REASON_FOCUS)
                                 child.speakDescendantObjects(hashList=hashList)
                         child=child.next
 
@@ -1376 +1376 @@
         def event_show(self):
                 # TODO: Abstract this somehow.
                 if (config.conf["presentation"]["reportTooltips"] and (self.IAccessibleRole==oleacc.ROLE_SYSTEM_TOOLTIP)) or (config.conf["presentation"]["reportHelpBalloons"] and (self.IAccessibleRole==oleacc.ROLE_SYSTEM_HELPBALLOON)):
-                        speech.speakObject(self,reason=speech.REASON_FOCUS)
+                        speech.speakObject(self,reason=controlTypes.REASON_FOCUS)
                         # TODO: Don't use getBrailleTextForProperties directly.
                         braille.handler.message(braille.getBrailleTextForProperties(name=self.name, role=self.role))
 
@@ -1388 +1388 @@
         def speakDescendantObjects(self,hashList=None):
                 child=self.activeChild
                 if child:
-                        speech.speakObject(child,reason=speech.REASON_FOCUS)
+                        speech.speakObject(child,reason=controlTypes.REASON_FOCUS)
 
 class ComboBox(IAccessible):
 
         def speakDescendantObjects(self,hashList=None):
                 child=self.activeChild
                 if child:
-                        speech.speakObject(child,reason=speech.REASON_FOCUS)
+                        speech.speakObject(child,reason=controlTypes.REASON_FOCUS)
 
 class Outline(IAccessible):
 
         def speakDescendantObjects(self,hashList=None):
                 child=self.activeChild
                 if child:
-                        speech.speakObject(child,reason=speech.REASON_FOCUS)
+                        speech.speakObject(child,reason=controlTypes.REASON_FOCUS)
 
 class SysLinkClient(IAccessible):
 

source/NVDAObjects/UIA/__init__.py

@@ +1 @@
+#NVDAObjects/UIA.py
+#A part of NonVisual Desktop Access (NVDA)
+#Copyright (C) 2006-2011 NVDA Contributors <http://www.nvda-project.org/>
+#This file is covered by the GNU General Public License.
+#See the file COPYING for more details.
+
 from ctypes.wintypes import POINT
 from comtypes import COMError
 import weakref
@@ -500 +506 @@
         def event_valueChange(self):
                 focusParent=api.getFocusObject().parent
                 if self==focusParent:
-                        speech.speakObjectProperties(self,value=True,reason=speech.REASON_CHANGE)
+                        speech.speakObjectProperties(self,value=True,reason=controlTypes.REASON_CHANGE)
                 else:
                         super(SensitiveSlider,self).event_valueChange()
 

source/NVDAObjects/__init__.py

@@ -1 +1 @@
 #NVDAObjects/baseType.py
 #A part of NonVisual Desktop Access (NVDA)
-#Copyright (C) 2006-2007 NVDA Contributors <http://www.nvda-project.org/>
+#Copyright (C) 2006-2011 NVDA Contributors <http://www.nvda-project.org/>
 #This file is covered by the GNU General Public License.
 #See the file COPYING for more details.
 
@@ -726 +726 @@
         def reportFocus(self):
                 """Announces this object in a way suitable such that it gained focus.
                 """
-                speech.speakObject(self,reason=speech.REASON_FOCUS)
+                speech.speakObject(self,reason=controlTypes.REASON_FOCUS)
 
         def event_typedCharacter(self,ch):
                 speech.speakTypedCharacters(ch)
@@ -768 +768 @@
 
         def event_stateChange(self):
                 if self is api.getFocusObject():
-                        speech.speakObjectProperties(self,states=True, reason=speech.REASON_CHANGE)
+                        speech.speakObjectProperties(self,states=True, reason=controlTypes.REASON_CHANGE)
                 braille.handler.handleUpdate(self)
 
         def event_focusEntered(self):
@@ -776 +776 @@
                         speech.cancelSpeech()
                         return
                 if self.isPresentableFocusAncestor:
-                        speech.speakObject(self,reason=speech.REASON_FOCUSENTERED)
+                        speech.speakObject(self,reason=controlTypes.REASON_FOCUSENTERED)
 
         def event_gainFocus(self):
                 """
@@ -799 +799 @@
 
         def event_valueChange(self):
                 if self is api.getFocusObject():
-                        speech.speakObjectProperties(self, value=True, reason=speech.REASON_CHANGE)
+                        speech.speakObjectProperties(self, value=True, reason=controlTypes.REASON_CHANGE)
                 braille.handler.handleUpdate(self)
 
         def event_nameChange(self):
                 if self is api.getFocusObject():
-                        speech.speakObjectProperties(self, name=True, reason=speech.REASON_CHANGE)
+                        speech.speakObjectProperties(self, name=True, reason=controlTypes.REASON_CHANGE)
                 braille.handler.handleUpdate(self)
 
         def event_descriptionChange(self):
                 if self is api.getFocusObject():
-                        speech.speakObjectProperties(self, description=True, reason=speech.REASON_CHANGE)
+                        speech.speakObjectProperties(self, description=True, reason=controlTypes.REASON_CHANGE)
                 braille.handler.handleUpdate(self)
 
         def event_caret(self):

source/NVDAObjects/window/winword.py

@@ -1 +1 @@
 #appModules/winword.py
 #A part of NonVisual Desktop Access (NVDA)
-#Copyright (C) 2006-2007 NVDA Contributors <http://www.nvda-project.org/>
+#Copyright (C) 2006-2011 NVDA Contributors <http://www.nvda-project.org/>
 #This file is covered by the GNU General Public License.
 #See the file COPYING for more details.
 
@@ -386 +386 @@
                 info=self.makeTextInfo(textInfos.POSITION_CARET)
                 if info._rangeObj.tables.count>0:
                         info.expand(textInfos.UNIT_LINE)
-                        speech.speakTextInfo(info,reason=speech.REASON_CARET)
+                        speech.speakTextInfo(info,reason=controlTypes.REASON_CARET)
 
         def script_nextRow(self,gesture):
                 info=self.makeTextInfo("caret")
@@ -396 +396 @@
                 if info._moveInTable(0,1):
                         info.updateCaret()
                         info.expand(textInfos.UNIT_CELL)
-                        speech.speakTextInfo(info,reason=speech.REASON_CARET)
+                        speech.speakTextInfo(info,reason=controlTypes.REASON_CARET)
                 else:
                         speech.speakMessage(_("edge of table"))
 
@@ -408 +408 @@
                 if info._moveInTable(0,-1):
                         info.updateCaret()
                         info.expand(textInfos.UNIT_CELL)
-                        speech.speakTextInfo(info,reason=speech.REASON_CARET)
+                        speech.speakTextInfo(info,reason=controlTypes.REASON_CARET)
                 else:
                         speech.speakMessage(_("edge of table"))
 
@@ -420 +420 @@
                 if info._moveInTable(1,0):
                         info.updateCaret()
                         info.expand(textInfos.UNIT_CELL)
-                        speech.speakTextInfo(info,reason=speech.REASON_CARET)
+                        speech.speakTextInfo(info,reason=controlTypes.REASON_CARET)
                 else:
                         speech.speakMessage(_("edge of table"))
 
@@ -432 +432 @@
                 if info._moveInTable(-1,0):
                         info.updateCaret()
                         info.expand(textInfos.UNIT_CELL)
-                        speech.speakTextInfo(info,reason=speech.REASON_CARET)
+                        speech.speakTextInfo(info,reason=controlTypes.REASON_CARET)
                 else:
                         speech.speakMessage(_("edge of table"))
 

source/api.py

@@ -1 +1 @@
 #api.py
 #A part of NonVisual Desktop Access (NVDA)
-#Copyright (C) 2006-2007 NVDA Contributors <http://www.nvda-project.org/>
+#Copyright (C) 2006-2011 NVDA Contributors <http://www.nvda-project.org/>
 #This file is covered by the GNU General Public License.
 #See the file COPYING for more details.
 
@@ -78 +78 @@
                         safetyCount+=1
                 else:
                         try:
-                                log.error("Never ending focus ancestry: last object: %s, %s, window class %s, application name %s"%(tempObj.name,controlTypes.speechRoleLabels[tempObj.role],tempObj.windowClassName,tempObj.appModule.appName))
+                                log.error("Never ending focus ancestry: last object: %s, %s, window class %s, application name %s"%(tempObj.name,controlTypes.labels[tempObj.role],tempObj.windowClassName,tempObj.appModule.appName))
                         except:
                                 pass
                         tempObj=getDesktopObject()

source/appModules/firefox.py

@@ -1 +1 @@
 #appModules/firefox.py
 #A part of NonVisual Desktop Access (NVDA)
-#Copyright (C) 2006-2008 NVDA Contributors <http://www.nvda-project.org/>
+#Copyright (C) 2006-2011 NVDA Contributors <http://www.nvda-project.org/>
 #This file is covered by the GNU General Public License.
 #See the file COPYING for more details.
 
@@ -18 +18 @@
                         if statusBar:
                                 statusText = api.getStatusBarText(statusBar)
                                 speech.cancelSpeech()
-                                speech.speakMessage(controlTypes.speechStateLabels[controlTypes.STATE_BUSY])
+                                speech.speakMessage(controlTypes.stateLabels[controlTypes.STATE_BUSY])
                                 speech.speakMessage(statusText)
                                 return
                 nextHandler()

source/appModules/miranda32.py

@@ -1 +1 @@
 #appModules/miranda32.py
 #A part of NonVisual Desktop Access (NVDA)
-#Copyright (C) 2006-2007 NVDA Contributors <http://www.nvda-project.org/>
+#Copyright (C) 2006-2011 NVDA Contributors <http://www.nvda-project.org/>
 #This file is covered by the GNU General Public License.
 #See the file COPYING for more details.
 
@@ -161 +161 @@
                 gesture.send()
                 if not isScriptWaiting():
                         api.processPendingEvents()
-                        speech.speakObject(self,reason=speech.REASON_FOCUS)
+                        speech.speakObject(self,reason=controlTypes.REASON_FOCUS)
                         braille.handler.handleGainFocus(self)
 
         __changeItemGestures = (

source/appModules/msimn.py

@@ -1 +1 @@
 #appModules/msimn.py - Outlook Express appModule
 #A part of NonVisual Desktop Access (NVDA)
-#Copyright (C) 2006-2010 NVDA Contributors <http://www.nvda-project.org/>
+#Copyright (C) 2006-2011 NVDA Contributors <http://www.nvda-project.org/>
 #This file is covered by the GNU General Public License.
 #See the file COPYING for more details.
 
@@ -87 +87 @@
                 nameList=[]
                 imageState=winUser.sendMessage(self.windowHandle,sysListView32.LVM_GETITEMSTATE,self.IAccessibleChildID-1,sysListView32.LVIS_STATEIMAGEMASK)>>12
                 if imageState==5:
-                        nameList.append(controlTypes.speechStateLabels[controlTypes.STATE_COLLAPSED])
+                        nameList.append(controlTypes.stateLabels[controlTypes.STATE_COLLAPSED])
                 elif imageState==6:
-                        nameList.append(controlTypes.speechStateLabels[controlTypes.STATE_EXPANDED])
+                        nameList.append(controlTypes.stateLabels[controlTypes.STATE_EXPANDED])
                 if self.isUnread:
                         nameList.append(_("unread"))
                 name=super(MessageListItem,self).name

source/appModules/thunderbird.py

@@ -1 +1 @@
 #appModules/thunderbird.py
 #A part of NonVisual Desktop Access (NVDA)
-#Copyright (C) 2006-2008 NVDA Contributors <http://www.nvda-project.org/>
+#Copyright (C) 2006-2011 NVDA Contributors <http://www.nvda-project.org/>
 #This file is covered by the GNU General Public License.
 #See the file COPYING for more details.
 
@@ -22 +22 @@
                                 except:
                                         # Fall back to reading the entire status bar.
                                         statusText = api.getStatusBarText(statusBar)
-                                speech.speakMessage(controlTypes.speechStateLabels[controlTypes.STATE_BUSY])
+                                speech.speakMessage(controlTypes.stateLabels[controlTypes.STATE_BUSY])
                                 speech.speakMessage(statusText)
                                 return
                 nextHandler()

source/appModules/totalcmd.py

@@ -1 +1 @@
 #appModules/totalcmd.py
 #A part of NonVisual Desktop Access (NVDA)
-#Copyright (C) 2006-2008 NVDA Contributors <http://www.nvda-project.org/>
+#Copyright (C) 2006-2011 NVDA Contributors <http://www.nvda-project.org/>
 #This file is covered by the GNU General Public License.
 #See the file COPYING for more details.
 
@@ -41 +41 @@
                 if self.name:
                         speakList=[]
                         if controlTypes.STATE_SELECTED in self.states:
-                                speakList.append(controlTypes.speechStateLabels[controlTypes.STATE_SELECTED])
+                                speakList.append(controlTypes.stateLabels[controlTypes.STATE_SELECTED])
                         speakList.append(self.name.split("\\")[-1])
                         speech.speakMessage(" ".join(speakList))
                 else:

source/appModules/winamp.py

@@ -1 +1 @@
 #appModules/winamp.py
 #A part of NonVisual Desktop Access (NVDA)
-#Copyright (C) 2006-2010 NVDA Contributors <http://www.nvda-project.org/>
+#Copyright (C) 2006-2011 NVDA Contributors <http://www.nvda-project.org/>
 #This file is covered by the GNU General Public License.
 #See the file COPYING for more details.
 
@@ -115 +115 @@
                 gesture.send()
                 if not isScriptWaiting():
                         api.processPendingEvents()
-                        speech.speakObject(self,reason=speech.REASON_FOCUS)
+                        speech.speakObject(self,reason=controlTypes.REASON_FOCUS)
 
         def event_nameChange(self):
                 return super(winampMainWindow,self).event_nameChange()

source/braille.py

@@ -73 +73 @@
         ("zh-tw.ctb", _("Chinese (Taiwan, Mandarin)")),
 )
 
-roleLabels = {
+labels = {
         controlTypes.ROLE_EDITABLETEXT: _("edt"),
         controlTypes.ROLE_LIST: _("lst"),
         controlTypes.ROLE_MENUBAR: _("mnubar"),
@@ -209 +209 @@
                 textList.append(name)
         role = propertyValues.get("role")
         if role is not None:
-                if name and role in speech.silentRolesOnFocus:
+                if name and role in controlTypes.ignoreRolesOnFocus:
                         roleText = None
                 else:
-                        roleText = roleLabels.get(role, controlTypes.speechRoleLabels[role])
+                        roleText = labels.get(role, controlTypes.labels[role])
         else:
                 role = propertyValues.get("_role")
                 roleText = None
         value = propertyValues.get("value")
-        if value and role not in speech.silentValuesForRoles:
+        if value and role not in controlTypes.ignoreValuesForRoles:
                 textList.append(value)
         states = propertyValues.get("states")
         if states:
-                positiveStates = speech.processPositiveStates(role, states, speech.REASON_FOCUS, states)
-                textList.extend(positiveStateLabels.get(state, controlTypes.speechStateLabels[state]) for state in positiveStates)
-                negativeStates = speech.processNegativeStates(role, states, speech.REASON_FOCUS, None)
-                textList.extend(negativeStateLabels.get(state, _("not %s") % controlTypes.speechStateLabels[state]) for state in negativeStates)
+                positiveStates = controlTypes.processPositiveStates(role, states, controlTypes.REASON_FOCUS, states)
+                textList.extend(positiveStateLabels.get(state, controlTypes.stateLabels[state]) for state in positiveStates)
+                negativeStates = controlTypes.processNegativeStates(role, states, controlTypes.REASON_FOCUS, None)
+                textList.extend(negativeStateLabels.get(state, _("not %s") % controlTypes.stateLabels[state]) for state in negativeStates)
         if roleText:
                 textList.append(roleText)
         description = propertyValues.get("description")

source/compoundDocuments.py

@@ -2 +2 @@
 #A part of NonVisual Desktop Access (NVDA)
 #This file is covered by the GNU General Public License.
 #See the file COPYING for more details.
-#Copyright (C) 2010 James Teh <jamie@jantrid.net>
+#Copyright (C) 2010-2011 James Teh <jamie@jantrid.net>
 
 import winUser
 import textInfos
@@ -388 +388 @@
                 return eventHandler.lastQueuedFocusObject
 
         def event_treeInterceptor_gainFocus(self):
-                speech.speakObject(self.rootNVDAObject, reason=speech.REASON_FOCUS)
+                speech.speakObject(self.rootNVDAObject, reason=controlTypes.REASON_FOCUS)
                 try:
                         info = self.makeTextInfo(textInfos.POSITION_SELECTION)
                 except RuntimeError:

source/controlTypes.py

@@ +1 @@
+#controlTypes.py
+#A part of NonVisual Desktop Access (NVDA)
+#Copyright (C) 2006-2011 NVDA Contributors <http://www.nvda-project.org/>
+#This file is covered by the GNU General Public License.
+#See the file COPYING for more details.
 
 ROLE_UNKNOWN=0
 ROLE_WINDOW=1
@@ -178 +183 @@
 STATE_SORTED_DESCENDING=0x200000000
 STATES_SORTED=frozenset([STATE_SORTED,STATE_SORTED_ASCENDING,STATE_SORTED_DESCENDING])
 
-speechRoleLabels={
+labels={
         ROLE_UNKNOWN:_("unknown"),
         ROLE_WINDOW:_("window"),
         ROLE_TITLEBAR:_("title bar"),
@@ -323 +328 @@
         ROLE_CALENDAR:_("calendar"),
 }
 
-speechStateLabels={
+stateLabels={
         STATE_UNAVAILABLE:_("unavailable"),
         STATE_FOCUSED:_("focused"),
         STATE_SELECTED:_("selected"),
@@ -359 +364 @@
         STATE_SORTED_ASCENDING:_("sorted ascending"),
         STATE_SORTED_DESCENDING:_("sorted descending"),
 }
+
+ignoreRolesOnFocus=set([
+        ROLE_PANE,
+        ROLE_ROOTPANE,
+        ROLE_FRAME,
+        ROLE_UNKNOWN,
+        ROLE_APPLICATION,
+        ROLE_TABLECELL,
+        ROLE_LISTITEM,
+        ROLE_MENUITEM,
+        ROLE_CHECKMENUITEM,
+        ROLE_TREEVIEWITEM,
+])
+
+ignoreValuesForRoles=set([
+        ROLE_CHECKBOX,
+        ROLE_RADIOBUTTON,
+        ROLE_LINK,
+        ROLE_MENUITEM,
+        ROLE_APPLICATION,
+])
+
+# Reason constants, to determine why information is required, enables us to provide different information depending 
+# on an object is being focused, the user specifically requested information via a query etc.
+REASON_FOCUS=1
+REASON_MOUSE=2
+REASON_QUERY=3
+REASON_CHANGE=4
+REASON_MESSAGE=5
+REASON_SAYALL=6
+REASON_CARET=7
+REASON_DEBUG=8
+REASON_ONLYCACHE=9
+REASON_FOCUSENTERED=10
+
+def processPositiveStates(role, states, reason, positiveStates):
+        positiveStates = positiveStates.copy()
+        # The user never cares about certain states.
+        if role==ROLE_EDITABLETEXT:
+                positiveStates.discard(STATE_EDITABLE)
+        if role!=ROLE_LINK:
+                positiveStates.discard(STATE_VISITED)
+        positiveStates.discard(STATE_SELECTABLE)
+        positiveStates.discard(STATE_FOCUSABLE)
+        positiveStates.discard(STATE_CHECKABLE)
+        if STATE_DRAGGING in positiveStates:
+                # It's obvious that the control is draggable if it's being dragged.
+                positiveStates.discard(STATE_DRAGGABLE)
+        if role == ROLE_COMBOBOX:
+                # Combo boxes inherently have a popup, so don't report it.
+                positiveStates.discard(STATE_HASPOPUP)
+        if reason == REASON_QUERY:
+                return positiveStates
+        positiveStates.discard(STATE_DEFUNCT)
+        positiveStates.discard(STATE_MODAL)
+        positiveStates.discard(STATE_FOCUSED)
+        positiveStates.discard(STATE_OFFSCREEN)
+        positiveStates.discard(STATE_INVISIBLE)
+        if reason != REASON_CHANGE:
+                positiveStates.discard(STATE_LINKED)
+                if role in (ROLE_LISTITEM, ROLE_TREEVIEWITEM, ROLE_MENUITEM, ROLE_TABLEROW) and STATE_SELECTABLE in states:
+                        positiveStates.discard(STATE_SELECTED)
+        if role != ROLE_EDITABLETEXT:
+                positiveStates.discard(STATE_READONLY)
+        if role == ROLE_CHECKBOX:
+                positiveStates.discard(STATE_PRESSED)
+        if role == ROLE_MENUITEM:
+                # The user doesn't usually care if a menu item is expanded or collapsed.
+                positiveStates.discard(STATE_COLLAPSED)
+                positiveStates.discard(STATE_EXPANDED)
+        return positiveStates
+
+def processNegativeStates(role, states, reason, negativeStates):
+        presentNegatives = set()
+        # Add the negative selected state if the control is selectable,
+        # but only if it is either focused or this is something other than a change event.
+        # The condition stops "not selected" from being presented in some broken controls
+        # when the state change for the previous focus is issued before the focus change.
+        if role in (ROLE_LISTITEM, ROLE_TREEVIEWITEM, ROLE_TABLEROW) and STATE_SELECTABLE in states and (reason != REASON_CHANGE or STATE_FOCUSED in states):
+                presentNegatives.add(STATE_SELECTED)
+        # Restrict "not checked" in a similar way to "not selected".
+        if (role in (ROLE_CHECKBOX, ROLE_RADIOBUTTON, ROLE_CHECKMENUITEM) or STATE_CHECKABLE in states)  and (STATE_HALFCHECKED not in states) and (reason != REASON_CHANGE or STATE_FOCUSED in states):
+                presentNegatives.add(STATE_CHECKED)
+        if reason == REASON_CHANGE:
+                # We want to present this state only if it is changing to negative.
+                presentNegatives.add(STATE_DROPTARGET)
+                # We were given states which have changed to negative.
+                # Return only those supplied negative states which should be presented;
+                # i.e. the states in both sets.
+                presentNegatives &= negativeStates
+                if STATES_SORTED & negativeStates and not STATES_SORTED & states:
+                        # If the object has just stopped being sorted, just report not sorted.
+                        # The user doesn't care how it was sorted before.
+                        presentNegatives.add(STATE_SORTED)
+                return presentNegatives
+        else:
+                # This is not a state change; only positive states were supplied.
+                # Return all negative states which should be presented, excluding the positive states.
+                return presentNegatives - states
+

source/cursorManager.py

@@ -1 +1 @@
 #cursorManager.py
 #A part of NonVisual Desktop Access (NVDA)
-#Copyright (C) 2006-2008 NVDA Contributors <http://www.nvda-project.org/>
+#Copyright (C) 2006-2011 NVDA Contributors <http://www.nvda-project.org/>
 #This file is covered by the GNU General Public License.
 #See the file COPYING for more details.
 
@@ -17 +17 @@
 import speech
 import config
 import braille
+import controlTypes
 
 class CursorManager(baseObject.ScriptableObject):
         """
@@ -72 +73 @@
                         info.move(unit,direction)
                 self.selection=info
                 info.expand(unit)
-                speech.speakTextInfo(info,unit=unit,reason=speech.REASON_CARET)
+                speech.speakTextInfo(info,unit=unit,reason=controlTypes.REASON_CARET)
                 if not oldInfo.isCollapsed:
                         speech.speakSelectionChange(oldInfo,self.selection)
 
@@ -93 +94 @@
                         self.selection=info
                         speech.cancelSpeech()
                         info.move(textInfos.UNIT_LINE,1,endPoint="end")
-                        speech.speakTextInfo(info,reason=speech.REASON_CARET)
+                        speech.speakTextInfo(info,reason=controlTypes.REASON_CARET)
                 else:
                         wx.CallAfter(gui.messageBox,_('text "%s" not found')%text,_("Find Error"),wx.OK|wx.ICON_ERROR)
                 CursorManager._lastFindText=text

source/editableText.py

@@ -2 +2 @@
 #A part of NonVisual Desktop Access (NVDA)
 #This file is covered by the GNU General Public License.
 #See the file COPYING for more details.
-#Copyright (C) 2006-2010 Michael Curran <mick@kulgan.net>, James Teh <jamie@jantrid.net>
+#Copyright (C) 2006-2011 Michael Curran <mick@kulgan.net>, James Teh <jamie@jantrid.net>
 
 """Common support for editable text.
 """
@@ -13 +13 @@
 import braille
 import speech
 import config
+import controlTypes
 import eventHandler
 from scriptHandler import isScriptWaiting
 import textInfos
@@ -65 +66 @@
                         api.setReviewPosition(info.copy())
                 if speakUnit:
                         info.expand(speakUnit)
-                        speech.speakTextInfo(info, unit=speakUnit, reason=speech.REASON_CARET)
+                        speech.speakTextInfo(info, unit=speakUnit, reason=controlTypes.REASON_CARET)
 
         def _caretMovementScriptHelper(self, gesture, unit):
                 try:

source/globalCommands.py

@@ -2 +2 @@
 #A part of NonVisual Desktop Access (NVDA)
 #This file is covered by the GNU General Public License.
 #See the file COPYING for more details.
-#Copyright (C) 2006-2010 Michael Curran <mick@kulgan.net>, James Teh <jamie@jantrid.net>, Peter Vágner <peter.v@datagate.sk>, Aleksey Sadovoy <lex@onm.su>, Rui Batista<ruiandrebatista@gmail.com>
+#Copyright (C) 2006-2011 Michael Curran <mick@kulgan.net>, James Teh <jamie@jantrid.net>, Peter Vágner <peter.v@datagate.sk>, Aleksey Sadovoy <lex@onm.su>, Rui Batista<ruiandrebatista@gmail.com>
 
 import time
 import tones
@@ -65 +65 @@
                         info=obj.makeTextInfo(textInfos.POSITION_FIRST)
                 info.expand(textInfos.UNIT_LINE)
                 if scriptHandler.getLastScriptRepeatCount()==0:
-                        speech.speakTextInfo(info,unit=textInfos.UNIT_LINE,reason=speech.REASON_CARET)
+                        speech.speakTextInfo(info,unit=textInfos.UNIT_LINE,reason=controlTypes.REASON_CARET)
                 else:
                         speech.speakSpelling(info.text)
         script_reportCurrentLine.__doc__=_("Reports the current line under the application cursor. Pressing this key twice will spell the current line")
@@ -287 +287 @@
                                         if api.copyToClip(text):
                                                 speech.speakMessage(_("%s copied to clipboard")%text)
                 else:
-                        speech.speakObject(curObject,reason=speech.REASON_QUERY)
+                        speech.speakObject(curObject,reason=controlTypes.REASON_QUERY)
         script_navigatorObject_current.__doc__=_("Reports the current navigator object. Pressing twice spells this information,and pressing three times Copies name and value of this  object to the clipboard")
 
         def script_navigatorObject_currentDimensions(self,gesture):
@@ -317 +317 @@
                         pos=obj.makeTextInfo(textInfos.POSITION_FIRST)
                 api.setReviewPosition(pos)
                 speech.speakMessage(_("move to focus"))
-                speech.speakObject(obj,reason=speech.REASON_QUERY)
+                speech.speakObject(obj,reason=controlTypes.REASON_QUERY)
         script_navigatorObject_toFocus.__doc__=_("Sets the navigator object to the current focus, and the review cursor to the position of the caret inside it, if possible.")
 
         def script_navigatorObject_moveFocus(self,gesture):
@@ -336 +336 @@
                                 return
                         info=review.copy()
                         info.expand(textInfos.UNIT_LINE)
-                        speech.speakTextInfo(info,reason=speech.REASON_CARET)
+                        speech.speakTextInfo(info,reason=controlTypes.REASON_CARET)
         script_navigatorObject_moveFocus.__doc__=_("Pressed once Sets the keyboard focus to the navigator object, pressed twice sets the system caret to the position of the review cursor")
 
         def script_navigatorObject_parent(self,gesture):
@@ -348 +348 @@
                 curObject=curObject.simpleParent if simpleReviewMode else curObject.parent
                 if curObject is not None:
                         api.setNavigatorObject(curObject)
-                        speech.speakObject(curObject,reason=speech.REASON_QUERY)
+                        speech.speakObject(curObject,reason=controlTypes.REASON_QUERY)
                 else:
                         speech.speakMessage(_("No parents"))
         script_navigatorObject_parent.__doc__=_("Moves the navigator object to the object containing it")
@@ -362 +362 @@
                 curObject=curObject.simpleNext if simpleReviewMode else curObject.next
                 if curObject is not None:
                         api.setNavigatorObject(curObject)
-                        speech.speakObject(curObject,reason=speech.REASON_QUERY)
+                        speech.speakObject(curObject,reason=controlTypes.REASON_QUERY)
                 else:
                         speech.speakMessage(_("No next"))
         script_navigatorObject_next.__doc__=_("Moves the navigator object to the next object")
@@ -376 +376 @@
                 curObject=curObject.simplePrevious if simpleReviewMode else curObject.previous
                 if curObject is not None:
                         api.setNavigatorObject(curObject)
-                        speech.speakObject(curObject,reason=speech.REASON_QUERY)
+                        speech.speakObject(curObject,reason=controlTypes.REASON_QUERY)
                 else:
                         speech.speakMessage(_("No previous"))
         script_navigatorObject_previous.__doc__=_("Moves the navigator object to the previous object")
@@ -390 +390 @@
                 curObject=curObject.simpleFirstChild if simpleReviewMode else curObject.firstChild
                 if curObject is not None:
                         api.setNavigatorObject(curObject)
-                        speech.speakObject(curObject,reason=speech.REASON_QUERY)
+                        speech.speakObject(curObject,reason=controlTypes.REASON_QUERY)
                 else:
                         speech.speakMessage(_("No children"))
         script_navigatorObject_firstChild.__doc__=_("Moves the navigator object to the first object it contains")
@@ -418 +418 @@
                 api.setReviewPosition(info.copy())
                 info.expand(textInfos.UNIT_LINE)
                 speech.speakMessage(_("top"))
-                speech.speakTextInfo(info,unit=textInfos.UNIT_LINE,reason=speech.REASON_CARET)
+                speech.speakTextInfo(info,unit=textInfos.UNIT_LINE,reason=controlTypes.REASON_CARET)
         script_review_top.__doc__=_("Moves the review cursor to the top line of the current navigator object and speaks it")
 
         def script_review_previousLine(self,gesture):
@@ -430 +430 @@
                 info.expand(textInfos.UNIT_LINE)
                 if res==0:
                         speech.speakMessage(_("top"))
-                speech.speakTextInfo(info,unit=textInfos.UNIT_LINE,reason=speech.REASON_CARET)
+                speech.speakTextInfo(info,unit=textInfos.UNIT_LINE,reason=controlTypes.REASON_CARET)
         script_review_previousLine.__doc__=_("Moves the review cursor to the previous line of the current navigator object and speaks it")
 
         def script_review_currentLine(self,gesture):
@@ -438 +438 @@
                 info.expand(textInfos.UNIT_LINE)
                 scriptCount=scriptHandler.getLastScriptRepeatCount()
                 if scriptCount==0:
-                        speech.speakTextInfo(info,unit=textInfos.UNIT_LINE,reason=speech.REASON_CARET)
+                        speech.speakTextInfo(info,unit=textInfos.UNIT_LINE,reason=controlTypes.REASON_CARET)
                 else:
                         speech.speakSpelling(info.text,useCharacterDescriptions=bool(scriptCount>1))
         script_review_currentLine.__doc__=_("Reports the line of the current navigator object where the review cursor is situated. If this key is pressed twice, the current line will be spelled. Pressing three times will spell the line using character descriptions.")
@@ -452 +452 @@
                 info.expand(textInfos.UNIT_LINE)
                 if res==0:
                         speech.speakMessage(_("bottom"))
-                speech.speakTextInfo(info,unit=textInfos.UNIT_LINE,reason=speech.REASON_CARET)
+                speech.speakTextInfo(info,unit=textInfos.UNIT_LINE,reason=controlTypes.REASON_CARET)
         script_review_nextLine.__doc__=_("Moves the review cursor to the next line of the current navigator object and speaks it")
 
         def script_review_bottom(self,gesture):
@@ -460 +460 @@
                 api.setReviewPosition(info.copy())
                 info.expand(textInfos.UNIT_LINE)
                 speech.speakMessage(_("bottom"))
-                speech.speakTextInfo(info,unit=textInfos.UNIT_LINE,reason=speech.REASON_CARET)
+                speech.speakTextInfo(info,unit=textInfos.UNIT_LINE,reason=controlTypes.REASON_CARET)
         script_review_bottom.__doc__=_("Moves the review cursor to the bottom line of the current navigator object and speaks it")
 
         def script_review_previousWord(self,gesture):
@@ -472 +472 @@
                 info.expand(textInfos.UNIT_WORD)
                 if res==0:
                         speech.speakMessage(_("top"))
-                speech.speakTextInfo(info,reason=speech.REASON_CARET,unit=textInfos.UNIT_WORD)
+                speech.speakTextInfo(info,reason=controlTypes.REASON_CARET,unit=textInfos.UNIT_WORD)
         script_review_previousWord.__doc__=_("Moves the review cursor to the previous word of the current navigator object and speaks it")
 
         def script_review_currentWord(self,gesture):
@@ -480 +480 @@
                 info.expand(textInfos.UNIT_WORD)
                 scriptCount=scriptHandler.getLastScriptRepeatCount()
                 if scriptCount==0:
-                        speech.speakTextInfo(info,reason=speech.REASON_CARET,unit=textInfos.UNIT_WORD)
+                        speech.speakTextInfo(info,reason=controlTypes.REASON_CARET,unit=textInfos.UNIT_WORD)
                 else:
                         speech.speakSpelling(info.text,useCharacterDescriptions=bool(scriptCount>1))
         script_review_currentWord.__doc__=_("Speaks the word of the current navigator object where the review cursor is situated. If this key is pressed twice, the word will be spelled")
@@ -494 +494 @@
                 info.expand(textInfos.UNIT_WORD)
                 if res==0:
                         speech.speakMessage(_("bottom"))
-                speech.speakTextInfo(info,reason=speech.REASON_CARET,unit=textInfos.UNIT_WORD)
+                speech.speakTextInfo(info,reason=controlTypes.REASON_CARET,unit=textInfos.UNIT_WORD)
         script_review_nextWord.__doc__=_("Moves the review cursor to the next word of the current navigator object and speaks it")
 
         def script_review_startOfLine(self,gesture):
@@ -504 +504 @@
                 api.setReviewPosition(info.copy())
                 info.expand(textInfos.UNIT_CHARACTER)
                 speech.speakMessage(_("left"))
-                speech.speakTextInfo(info,unit=textInfos.UNIT_CHARACTER,reason=speech.REASON_CARET)
+                speech.speakTextInfo(info,unit=textInfos.UNIT_CHARACTER,reason=controlTypes.REASON_CARET)
         script_review_startOfLine.__doc__=_("Moves the review cursor to the first character of the line where it is situated in the current navigator object and speaks it")
 
         def script_review_previousCharacter(self,gesture):
@@ -518 +518 @@
                         speech.speakMessage(_("left"))
                         reviewInfo=api.getReviewPosition().copy()
                         reviewInfo.expand(textInfos.UNIT_CHARACTER)
-                        speech.speakTextInfo(reviewInfo,unit=textInfos.UNIT_CHARACTER,reason=speech.REASON_CARET)
+                        speech.speakTextInfo(reviewInfo,unit=textInfos.UNIT_CHARACTER,reason=controlTypes.REASON_CARET)
                 else:
                         api.setReviewPosition(charInfo.copy())
                         charInfo.expand(textInfos.UNIT_CHARACTER)
-                        speech.speakTextInfo(charInfo,unit=textInfos.UNIT_CHARACTER,reason=speech.REASON_CARET)
+                        speech.speakTextInfo(charInfo,unit=textInfos.UNIT_CHARACTER,reason=controlTypes.REASON_CARET)
         script_review_previousCharacter.__doc__=_("Moves the review cursor to the previous character of the current navigator object and speaks it")
 
         def script_review_currentCharacter(self,gesture):
@@ -530 +530 @@
                 info.expand(textInfos.UNIT_CHARACTER)
                 scriptCount=scriptHandler.getLastScriptRepeatCount()
                 if scriptCount==0:
-                        speech.speakTextInfo(info,unit=textInfos.UNIT_CHARACTER,reason=speech.REASON_CARET)
+                        speech.speakTextInfo(info,unit=textInfos.UNIT_CHARACTER,reason=controlTypes.REASON_CARET)
                 elif scriptCount==1:
                         speech.speakSpelling(info.text,useCharacterDescriptions=True)
                 else:
@@ -539 +539 @@
                                 speech.speakMessage("%d," % c)
                                 speech.speakSpelling(hex(c))
                         except:
-                                speech.speakTextInfo(info,unit=textInfos.UNIT_CHARACTER,reason=speech.REASON_CARET)
+                                speech.speakTextInfo(info,unit=textInfos.UNIT_CHARACTER,reason=controlTypes.REASON_CARET)
         script_review_currentCharacter.__doc__=_("Reports the character of the current navigator object where the review cursor is situated. If this key is pressed twice, ascii and hexadecimal values are spoken for the character")
 
         def script_review_nextCharacter(self,gesture):
@@ -553 +553 @@
                         speech.speakMessage(_("right"))
                         reviewInfo=api.getReviewPosition().copy()
                         reviewInfo.expand(textInfos.UNIT_CHARACTER)
-                        speech.speakTextInfo(reviewInfo,unit=textInfos.UNIT_CHARACTER,reason=speech.REASON_CARET)
+                        speech.speakTextInfo(reviewInfo,unit=textInfos.UNIT_CHARACTER,reason=controlTypes.REASON_CARET)
                 else:
                         api.setReviewPosition(charInfo.copy())
                         charInfo.expand(textInfos.UNIT_CHARACTER)
-                        speech.speakTextInfo(charInfo,unit=textInfos.UNIT_CHARACTER,reason=speech.REASON_CARET)
+                        speech.speakTextInfo(charInfo,unit=textInfos.UNIT_CHARACTER,reason=controlTypes.REASON_CARET)
         script_review_nextCharacter.__doc__=_("Moves the review cursor to the next character of the current navigator object and speaks it")
 
         def script_review_endOfLine(self,gesture):
@@ -568 +568 @@
                 api.setReviewPosition(info.copy())
                 info.expand(textInfos.UNIT_CHARACTER)
                 speech.speakMessage(_("right"))
-                speech.speakTextInfo(info,unit=textInfos.UNIT_CHARACTER,reason=speech.REASON_CARET)
+                speech.speakTextInfo(info,unit=textInfos.UNIT_CHARACTER,reason=controlTypes.REASON_CARET)
         script_review_endOfLine.__doc__=_("Moves the review cursor to the last character of the line where it is situated in the current navigator object and speaks it")
 
         def script_speechMode(self,gesture):
@@ -666 +666 @@
                 focusObject=api.getFocusObject()
                 if isinstance(focusObject,NVDAObject):
                         if scriptHandler.getLastScriptRepeatCount()==0:
-                                speech.speakObject(focusObject, reason=speech.REASON_QUERY)
+                                speech.speakObject(focusObject, reason=controlTypes.REASON_QUERY)
                         else:
                                 speech.speakSpelling(focusObject.name)
                 else:
@@ -717 +717 @@
         def script_speakForeground(self,gesture):
                 obj=api.getForegroundObject()
                 if obj:
-                        speech.speakObject(obj,reason=speech.REASON_QUERY)
+                        speech.speakObject(obj,reason=controlTypes.REASON_QUERY)
                         obj.speakDescendantObjects()
         script_speakForeground.__doc__ = _("speaks the current foreground object")
 

source/inputCore.py

@@ -2 +2 @@
 #A part of NonVisual Desktop Access (NVDA)
 #This file is covered by the GNU General Public License.
 #See the file COPYING for more details.
-#Copyright (C) 2010 James Teh <jamie@jantrid.net>
+#Copyright (C) 2010-2011 James Teh <jamie@jantrid.net>
 
 import sys
 import os
@@ -15 +15 @@
 import speech
 import characterProcessing
 import config
+import controlTypes
 import watchdog
 from logHandler import log
 import globalVars
@@ -337 +338 @@
                 import braille
                 braille.handler.message("\t\t".join(textList))
                 # Punctuation must be spoken for the gesture name (the first chunk) so that punctuation keys are spoken.
-                speech.speakText(textList[0], reason=speech.REASON_MESSAGE, symbolLevel=characterProcessing.SYMLVL_ALL)
+                speech.speakText(textList[0], reason=controlTypes.REASON_MESSAGE, symbolLevel=characterProcessing.SYMLVL_ALL)
                 for text in textList[1:]:
                         speech.speakMessage(text)
 

source/sayAllHandler.py

@@ -1 +1 @@
 #sayAllHandler.py
 #A part of NonVisual Desktop Access (NVDA)
-#Copyright (C) 2006-2007 NVDA Contributors <http://www.nvda-project.org/>
+#Copyright (C) 2006-2011 NVDA Contributors <http://www.nvda-project.org/>
 #This file is covered by the GNU General Public License.
 #See the file COPYING for more details.
 
 import queueHandler
 import config
+import controlTypes
 import speech
 import textInfos
 import globalVars
@@ -58 +59 @@
                         yield
                         continue
                 if keepReading:
-                        speech.speakObject(obj,index=indexCount,reason=speech.REASON_SAYALL)
+                        speech.speakObject(obj,index=indexCount,reason=controlTypes.REASON_SAYALL)
                         up=[]
                         down=[]
                         obj=obj.getNextInFlow(up=up,down=down)
@@ -117 +118 @@
                                         speech.speakWithoutPauses(None)
                                         keepReading=False
                                         continue
-                                speech.speakTextInfo(reader,unit=textInfos.UNIT_READINGCHUNK,reason=speech.REASON_SAYALL,index=index)
+                                speech.speakTextInfo(reader,unit=textInfos.UNIT_READINGCHUNK,reason=controlTypes.REASON_SAYALL,index=index)
                                 sendCount+=1
                                 cursorIndexMap[index]=bookmark
                                 reader.collapse(end=True)

source/speech.py

@@ -34 +34 @@
 isPaused=False
 curWordChars=[]
 
-REASON_FOCUS=1
-REASON_MOUSE=2
-REASON_QUERY=3
-REASON_CHANGE=4
-REASON_MESSAGE=5
-REASON_SAYALL=6
-REASON_CARET=7
-REASON_DEBUG=8
-REASON_ONLYCACHE=9
-REASON_FOCUSENTERED=10
 
 #: The string used to separate distinct chunks of text when multiple chunks should be spoken without pauses.
 CHUNK_SEPARATOR = "  "
@@ -122 +112 @@
 @param index: the index to mark this current text with, its best to use the character position of the text if you know it 
 @type index: int
 """
-        speakText(text,index=index,reason=REASON_MESSAGE)
+        speakText(text,index=index,reason=controlTypes.REASON_MESSAGE)
 
 _speakSpellingGenID = None
 
@@ -188 +178 @@
                 if uppercase and  synthConfig["beepForCapitals"]:
                         tones.beep(2000,50)
 
-def speakObjectProperties(obj,reason=REASON_QUERY,index=None,**allowedProperties):
+def speakObjectProperties(obj,reason=controlTypes.REASON_QUERY,index=None,**allowedProperties):
         if speechMode==speechMode_off:
                 return
         #Fetch the values for all wanted properties
@@ -216 +206 @@
         cachedPropertyValues.update(newPropertyValues)
         obj._speakObjectPropertiesCache=cachedPropertyValues
         #If we should only cache we can stop here
-        if reason==REASON_ONLYCACHE:
+        if reason==controlTypes.REASON_ONLYCACHE:
                 return
         #If only speaking change, then filter out all values that havn't changed
-        if reason==REASON_CHANGE:
+        if reason==controlTypes.REASON_CHANGE:
                 for name in set(newPropertyValues)&set(oldCachedPropertyValues):
                         if newPropertyValues[name]==oldCachedPropertyValues[name]:
                                 del newPropertyValues[name]
@@ -237 +227 @@
         if text:
                 speakText(text,index=index)
 
-def speakObject(obj,reason=REASON_QUERY,index=None):
+def speakObject(obj,reason=controlTypes.REASON_QUERY,index=None):
         from NVDAObjects import NVDAObjectTextInfo
-        isEditable=(reason!=REASON_FOCUSENTERED and obj.TextInfo!=NVDAObjectTextInfo and (obj.role in (controlTypes.ROLE_EDITABLETEXT,controlTypes.ROLE_TERMINAL) or controlTypes.STATE_EDITABLE in obj.states))
+        isEditable=(reason!=controlTypes.REASON_FOCUSENTERED and obj.TextInfo!=NVDAObjectTextInfo and (obj.role in (controlTypes.ROLE_EDITABLETEXT, controlTypes.ROLE_TERMINAL) or controlTypes.STATE_EDITABLE in obj.states))
         allowProperties={'name':True,'role':True,'states':True,'value':True,'description':True,'keyboardShortcut':True,'positionInfo_level':True,'positionInfo_indexInGroup':True,'positionInfo_similarItemsInGroup':True,"rowNumber":True,"columnNumber":True,"columnCount":True,"rowCount":True}
 
-        if reason==REASON_FOCUSENTERED:
+        if reason==controlTypes.REASON_FOCUSENTERED:
                 allowProperties["value"]=False
                 allowProperties["keyboardShortcut"]=False
                 allowProperties["positionInfo_level"]=False
                 # Aside from excluding some properties, focus entered should be spoken like focus.
-                reason=REASON_FOCUS
+                reason=controlTypes.REASON_FOCUS
 
         if not config.conf["presentation"]["reportObjectDescriptions"]:
                 allowProperties["description"]=False
@@ -257 +247 @@
                 allowProperties["positionInfo_level"]=False
                 allowProperties["positionInfo_indexInGroup"]=False
                 allowProperties["positionInfo_similarItemsInGroup"]=False
-        if reason!=REASON_QUERY:
+        if reason!=controlTypes.REASON_QUERY:
                 allowProperties["rowCount"]=False
                 allowProperties["columnCount"]=False
                 if (not config.conf["documentFormatting"]["reportTables"]
@@ -269 +259 @@
                 allowProperties['value']=False
 
         speakObjectProperties(obj,reason=reason,index=index,**allowProperties)
-        if reason!=REASON_ONLYCACHE and isEditable:
+        if reason!=controlTypes.REASON_ONLYCACHE and isEditable:
                 try:
                         info=obj.makeTextInfo(textInfos.POSITION_SELECTION)
                         if not info.isCollapsed:
@@ -281 +271 @@
                         newInfo=obj.makeTextInfo(textInfos.POSITION_ALL)
                         speakTextInfo(newInfo,unit=textInfos.UNIT_PARAGRAPH,reason=reason)
 
-def speakText(text,index=None,reason=REASON_MESSAGE,symbolLevel=None):
+def speakText(text,index=None,reason=controlTypes.REASON_MESSAGE,symbolLevel=None):
         """Speaks some text.
         @param text: The text to speak.
         @type text: str
         @param index: The index to mark this text with, which can be used later to determine whether this piece of text has been spoken.
         @type index: int
-        @param reason: The reason for this speech; one of the REASON_* constants.
+        @param reason: The reason for this speech; one of the controlTypes.REASON_* constants.
         @param symbolLevel: The symbol verbosity level; C{None} (default) to use the user's configuration.
         """
         speechSequence=[]
@@ -425 +415 @@
         if config.conf["keyboard"]["speakTypedCharacters"] and ord(ch)>=32:
                 speakSpelling(realChar)
 
-silentRolesOnFocus=set([
-        controlTypes.ROLE_PANE,
-        controlTypes.ROLE_ROOTPANE,
-        controlTypes.ROLE_FRAME,
-        controlTypes.ROLE_UNKNOWN,
-        controlTypes.ROLE_APPLICATION,
-        controlTypes.ROLE_TABLECELL,
-        controlTypes.ROLE_LISTITEM,
-        controlTypes.ROLE_MENUITEM,
-        controlTypes.ROLE_CHECKMENUITEM,
-        controlTypes.ROLE_TREEVIEWITEM,
-])
-
-silentValuesForRoles=set([
-        controlTypes.ROLE_CHECKBOX,
-        controlTypes.ROLE_RADIOBUTTON,
-        controlTypes.ROLE_LINK,
-        controlTypes.ROLE_MENUITEM,
-        controlTypes.ROLE_APPLICATION,
-])
-
-def processPositiveStates(role, states, reason, positiveStates):
-        positiveStates = positiveStates.copy()
-        # The user never cares about certain states.
-        if role==controlTypes.ROLE_EDITABLETEXT:
-                positiveStates.discard(controlTypes.STATE_EDITABLE)
-        if role!=controlTypes.ROLE_LINK:
-                positiveStates.discard(controlTypes.STATE_VISITED)
-        positiveStates.discard(controlTypes.STATE_SELECTABLE)
-        positiveStates.discard(controlTypes.STATE_FOCUSABLE)
-        positiveStates.discard(controlTypes.STATE_CHECKABLE)
-        if controlTypes.STATE_DRAGGING in positiveStates:
-                # It's obvious that the control is draggable if it's being dragged.
-                positiveStates.discard(controlTypes.STATE_DRAGGABLE)
-        if role == controlTypes.ROLE_COMBOBOX:
-                # Combo boxes inherently have a popup, so don't report it.
-                positiveStates.discard(controlTypes.STATE_HASPOPUP)
-        if reason == REASON_QUERY:
-                return positiveStates
-        positiveStates.discard(controlTypes.STATE_DEFUNCT)
-        positiveStates.discard(controlTypes.STATE_MODAL)
-        positiveStates.discard(controlTypes.STATE_FOCUSED)
-        positiveStates.discard(controlTypes.STATE_OFFSCREEN)
-        positiveStates.discard(controlTypes.STATE_INVISIBLE)
-        if reason != REASON_CHANGE:
-                positiveStates.discard(controlTypes.STATE_LINKED)
-                if role in (controlTypes.ROLE_LISTITEM, controlTypes.ROLE_TREEVIEWITEM, controlTypes.ROLE_MENUITEM, controlTypes.ROLE_TABLEROW) and controlTypes.STATE_SELECTABLE in states:
-                        positiveStates.discard(controlTypes.STATE_SELECTED)
-        if role != controlTypes.ROLE_EDITABLETEXT:
-                positiveStates.discard(controlTypes.STATE_READONLY)
-        if role == controlTypes.ROLE_CHECKBOX:
-                positiveStates.discard(controlTypes.STATE_PRESSED)
-        if role == controlTypes.ROLE_MENUITEM:
-                # The user doesn't usually care if a menu item is expanded or collapsed.
-                positiveStates.discard(controlTypes.STATE_COLLAPSED)
-                positiveStates.discard(controlTypes.STATE_EXPANDED)
-        return positiveStates
-
-def processNegativeStates(role, states, reason, negativeStates):
-        speakNegatives = set()
-        # Add the negative selected state if the control is selectable,
-        # but only if it is either focused or this is something other than a change event.
-        # The condition stops "not selected" from being spoken in some broken controls
-        # when the state change for the previous focus is issued before the focus change.
-        if role in (controlTypes.ROLE_LISTITEM, controlTypes.ROLE_TREEVIEWITEM, controlTypes.ROLE_TABLEROW) and controlTypes.STATE_SELECTABLE in states and (reason != REASON_CHANGE or controlTypes.STATE_FOCUSED in states):
-                speakNegatives.add(controlTypes.STATE_SELECTED)
-        # Restrict "not checked" in a similar way to "not selected".
-        if (role in (controlTypes.ROLE_CHECKBOX, controlTypes.ROLE_RADIOBUTTON, controlTypes.ROLE_CHECKMENUITEM) or controlTypes.STATE_CHECKABLE in states)  and (controlTypes.STATE_HALFCHECKED not in states) and (reason != REASON_CHANGE or controlTypes.STATE_FOCUSED in states):
-                speakNegatives.add(controlTypes.STATE_CHECKED)
-        if reason == REASON_CHANGE:
-                # We want to speak this state only if it is changing to negative.
-                speakNegatives.add(controlTypes.STATE_DROPTARGET)
-                # We were given states which have changed to negative.
-                # Return only those supplied negative states which should be spoken;
-                # i.e. the states in both sets.
-                speakNegatives &= negativeStates
-                if controlTypes.STATES_SORTED & negativeStates and not controlTypes.STATES_SORTED & states:
-                        # If the object has just stopped being sorted, just report not sorted.
-                        # The user doesn't care how it was sorted before.
-                        speakNegatives.add(controlTypes.STATE_SORTED)
-                return speakNegatives
-        else:
-                # This is not a state change; only positive states were supplied.
-                # Return all negative states which should be spoken, excluding the positive states.
-                return speakNegatives - states
-
-def speakTextInfo(info,useCache=True,formatConfig=None,unit=None,extraDetail=False,reason=REASON_QUERY,index=None):
+def speakTextInfo(info,useCache=True,formatConfig=None,unit=None,extraDetail=False,reason=controlTypes.REASON_QUERY,index=None):
         if unit in (textInfos.UNIT_CHARACTER,textInfos.UNIT_WORD):
                 extraDetail=True
         if not formatConfig:
@@ -651 +555 @@
                                 textList.append(text)
 
         # If there is nothing  that should cause the TextInfo to be considered non-blank, blank should be reported, unless we are doing a say all.
-        if reason != REASON_SAYALL and len(textList)==textListBlankLen:
+        if reason != controlTypes.REASON_SAYALL and len(textList)==textListBlankLen:
                 textList.append(_("blank"))
 
         #Cache a copy of the new controlFieldStack for future use
@@ -667 +571 @@
         if text:
                 speechSequence.append(text)
         if speechSequence:
-                if reason==REASON_SAYALL:
+                if reason==controlTypes.REASON_SAYALL:
                         speakWithoutPauses(speechSequence)
                 else:
                         speak(speechSequence)
 
-def getSpeechTextForProperties(reason=REASON_QUERY,**propertyValues):
+def getSpeechTextForProperties(reason=controlTypes.REASON_QUERY,**propertyValues):
         global oldTreeLevel, oldTableID, oldRowNumber, oldColumnNumber
         textList=[]
         name=propertyValues.get('name')
@@ -687 +591 @@
         else:
                 speakRole=False
                 role=controlTypes.ROLE_UNKNOWN
-        value=propertyValues.get('value') if role not in silentValuesForRoles else None
+        value=propertyValues.get('value') if role not in controlTypes.ignoreValuesForRoles else None
         rowNumber=propertyValues.get('rowNumber')
         columnNumber=propertyValues.get('columnNumber')
         includeTableCellCoords=propertyValues.get('includeTableCellCoords',True)
-        if speakRole and (reason not in (REASON_SAYALL,REASON_CARET,REASON_FOCUS) or not (name or value or rowNumber or columnNumber) or role not in silentRolesOnFocus):
-                textList.append(controlTypes.speechRoleLabels[role])
+        if speakRole and (reason not in (controlTypes.REASON_SAYALL, controlTypes.REASON_CARET, controlTypes.REASON_FOCUS) or not (name or value or rowNumber or columnNumber) or role not in controlTypes.ignoreRolesOnFocus):
+                textList.append(controlTypes.labels[role])
         if value:
                 textList.append(value)
         states=propertyValues.get('states')
         realStates=propertyValues.get('_states',states)
         if states is not None:
-                positiveStates=processPositiveStates(role,realStates,reason,states)
-                textList.extend([controlTypes.speechStateLabels[x] for x in positiveStates])
+                positiveStates=controlTypes.processPositiveStates(role,realStates,reason,states)
+                textList.extend([controlTypes.stateLabels[x] for x in positiveStates])
         if 'negativeStates' in propertyValues:
                 negativeStates=propertyValues['negativeStates']
         else:
                 negativeStates=None
-        if negativeStates is not None or (reason != REASON_CHANGE and states is not None):
-                negativeStates=processNegativeStates(role, realStates, reason, negativeStates)
+        if negativeStates is not None or (reason != controlTypes.REASON_CHANGE and states is not None):
+                negativeStates=controlTypes.processNegativeStates(role, realStates, reason, negativeStates)
                 if controlTypes.STATE_DROPTARGET in negativeStates:
                         # "not drop target" doesn't make any sense, so use a custom message.
                         textList.append(_("done dragging"))
                         negativeStates.discard(controlTypes.STATE_DROPTARGET)
-                textList.extend([_("not %s")%controlTypes.speechStateLabels[x] for x in negativeStates])
+                textList.extend([_("not %s")%controlTypes.stateLabels[x] for x in negativeStates])
         if 'description' in propertyValues:
                 textList.append(propertyValues['description'])
         if 'keyboardShortcut' in propertyValues:
@@ -722 +626 @@
         if 'positionInfo_level' in propertyValues:
                 level=propertyValues.get('positionInfo_level',None)
                 role=propertyValues.get('role',None)
-                if level is not None and role in (controlTypes.ROLE_TREEVIEWITEM,controlTypes.ROLE_LISTITEM) and level!=oldTreeLevel:
+                if level is not None and role in (controlTypes.ROLE_TREEVIEWITEM, controlTypes.ROLE_LISTITEM) and level!=oldTreeLevel:
                         textList.insert(0,_("level %s")%level)
                         oldTreeLevel=level
                 elif level:
@@ -766 +670 @@
                 formatConfig=config.conf["documentFormatting"]
 
         childCount=int(attrs.get('_childcount',"0"))
-        if reason==REASON_FOCUS or attrs.get('alwaysReportName',False):
+        if reason==controlTypes.REASON_FOCUS or attrs.get('alwaysReportName',False):
                 name=attrs.get('name',"")
         else:
                 name=""
-        role=attrs.get('role',controlTypes.ROLE_UNKNOWN)
+        role=attrs.get('role', controlTypes.ROLE_UNKNOWN)
         states=attrs.get('states',set())
         keyboardShortcut=attrs.get('keyboardShortcut', "")
-        if reason==REASON_FOCUS or attrs.get('alwaysReportDescription',False):
+        if reason==controlTypes.REASON_FOCUS or attrs.get('alwaysReportDescription',False):
                 description=attrs.get('description',"")
         else:
                 description=""
         level=attrs.get('level',None)
 
         #Remove the clickable state from controls that are clearly clickable according to their role
-        if role in (controlTypes.ROLE_LINK,controlTypes.ROLE_BUTTON,controlTypes.ROLE_CHECKBOX,controlTypes.ROLE_RADIOBUTTON):
+        if role in (controlTypes.ROLE_LINK, controlTypes.ROLE_BUTTON, controlTypes.ROLE_CHECKBOX, controlTypes.ROLE_RADIOBUTTON):
                 states=states.copy()
                 states.discard(controlTypes.STATE_CLICKABLE)
 
@@ -806 +710 @@
                 tableID=None
 
         # Honour verbosity configuration.
-        if reason in (REASON_CARET,REASON_SAYALL,REASON_FOCUS) and (
+        if reason in (controlTypes.REASON_CARET, controlTypes.REASON_SAYALL, controlTypes.REASON_FOCUS) and (
                 (role==controlTypes.ROLE_LINK and not formatConfig["reportLinks"]) or 
                 (role==controlTypes.ROLE_HEADING and not formatConfig["reportHeadings"]) or
                 (role==controlTypes.ROLE_BLOCKQUOTE and not formatConfig["reportBlockQuotes"]) or
-                (role in (controlTypes.ROLE_TABLE,controlTypes.ROLE_TABLECELL,controlTypes.ROLE_TABLEROWHEADER,controlTypes.ROLE_TABLECOLUMNHEADER) and not formatConfig["reportTables"]) or
-                (role in (controlTypes.ROLE_LIST,controlTypes.ROLE_LISTITEM) and controlTypes.STATE_READONLY in states and not formatConfig["reportLists"])
+                (role in (controlTypes.ROLE_TABLE, controlTypes.ROLE_TABLECELL, controlTypes.ROLE_TABLEROWHEADER, controlTypes.ROLE_TABLECOLUMNHEADER) and not formatConfig["reportTables"]) or
+                (role in (controlTypes.ROLE_LIST, controlTypes.ROLE_LISTITEM) and controlTypes.STATE_READONLY in states and not formatConfig["reportLists"])
         ):
                 return ""
 
@@ -830 +734 @@
         # speakExitForOther: When moving by word or character, speak when the user exits the control.
         speakEntry=speakWithinForLine=speakExitForLine=speakExitForOther=False
         if (
-                role in (controlTypes.ROLE_LINK,controlTypes.ROLE_HEADING,controlTypes.ROLE_BUTTON,controlTypes.ROLE_RADIOBUTTON,controlTypes.ROLE_CHECKBOX,controlTypes.ROLE_GRAPHIC,controlTypes.ROLE_MENUITEM,controlTypes.ROLE_TAB,controlTypes.ROLE_COMBOBOX,controlTypes.ROLE_SLIDER,controlTypes.ROLE_SPINBUTTON,controlTypes.ROLE_COMBOBOX,controlTypes.ROLE_PROGRESSBAR)
+                role in (controlTypes.ROLE_LINK, controlTypes.ROLE_HEADING, controlTypes.ROLE_BUTTON, controlTypes.ROLE_RADIOBUTTON, controlTypes.ROLE_CHECKBOX, controlTypes.ROLE_GRAPHIC, controlTypes.ROLE_MENUITEM, controlTypes.ROLE_TAB, controlTypes.ROLE_COMBOBOX, controlTypes.ROLE_SLIDER, controlTypes.ROLE_SPINBUTTON, controlTypes.ROLE_COMBOBOX, controlTypes.ROLE_PROGRESSBAR)
                 or (role==controlTypes.ROLE_EDITABLETEXT and controlTypes.STATE_MULTILINE not in states and (controlTypes.STATE_READONLY not in states or controlTypes.STATE_FOCUSABLE in states))
                 or (role==controlTypes.ROLE_LIST and controlTypes.STATE_READONLY not in states)
         ):
@@ -838 +742 @@
                 speakEntry=True
                 speakWithinForLine=True
                 speakExitForOther=True
-        elif role in (controlTypes.ROLE_SEPARATOR,controlTypes.ROLE_EMBEDDEDOBJECT):
+        elif role in (controlTypes.ROLE_SEPARATOR, controlTypes.ROLE_EMBEDDEDOBJECT):
                 # This node is only ever a marker; i.e. single character.
                 speakEntry=True
         elif (
-                role in (controlTypes.ROLE_BLOCKQUOTE,controlTypes.ROLE_FRAME,controlTypes.ROLE_INTERNALFRAME,controlTypes.ROLE_TOOLBAR,controlTypes.ROLE_MENUBAR,controlTypes.ROLE_POPUPMENU)
+                role in (controlTypes.ROLE_BLOCKQUOTE, controlTypes.ROLE_FRAME, controlTypes.ROLE_INTERNALFRAME, controlTypes.ROLE_TOOLBAR, controlTypes.ROLE_MENUBAR, controlTypes.ROLE_POPUPMENU)
                 or (role==controlTypes.ROLE_EDITABLETEXT and (controlTypes.STATE_READONLY not in states or controlTypes.STATE_FOCUSABLE in states) and controlTypes.STATE_MULTILINE in states)
                 or (role==controlTypes.ROLE_LIST and controlTypes.STATE_READONLY in states)
                 or (role==controlTypes.ROLE_DOCUMENT and controlTypes.STATE_EDITABLE in states)
@@ -855 +759 @@
 
         # Determine the order of speech.
         # speakContentFirst: Speak the content before the control field info.
-        speakContentFirst=reason==REASON_FOCUS and role not in (controlTypes.ROLE_EDITABLETEXT,controlTypes.ROLE_COMBOBOX) and controlTypes.STATE_EDITABLE not in states
+        speakContentFirst=reason==controlTypes.REASON_FOCUS and role not in (controlTypes.ROLE_EDITABLETEXT, controlTypes.ROLE_COMBOBOX) and controlTypes.STATE_EDITABLE not in states
         # speakStatesFirst: Speak the states before the role.
         speakStatesFirst=role==controlTypes.ROLE_LINK
 
@@ -871 +775 @@
         elif fieldType=="start_addedToControlFieldStack" and role==controlTypes.ROLE_TABLE and tableID:
                 # Table.
                 return " ".join((roleText, getSpeechTextForProperties(_tableID=tableID, rowCount=attrs.get("table-rowcount"), columnCount=attrs.get("table-columncount"))))
-        elif fieldType=="start_addedToControlFieldStack" and role in (controlTypes.ROLE_TABLECELL,controlTypes.ROLE_TABLECOLUMNHEADER,controlTypes.ROLE_TABLEROWHEADER) and tableID:
+        elif fieldType=="start_addedToControlFieldStack" and role in (controlTypes.ROLE_TABLECELL, controlTypes.ROLE_TABLECOLUMNHEADER, controlTypes.ROLE_TABLEROWHEADER) and tableID:
                 # Table cell.
                 reportTableHeaders = formatConfig["reportTableHeaders"]
                 reportTableCellCoords = formatConfig["reportTableCellCoords"]

source/virtualBuffers/__init__.py

@@ +1 @@
+#VirtualBuffer.py
+#A part of NonVisual Desktop Access (NVDA)
+#Copyright (C) 2006-2011 NVDA Contributors <http://www.nvda-project.org/>
+#This file is covered by the GNU General Public License.
+#See the file COPYING for more details.
+
 import time
 import threading
 import ctypes
@@ -488 +494 @@
 
         def _reportElement(self, element):
                 speech.cancelSpeech()
-                speech.speakTextInfo(element,reason=speech.REASON_FOCUS)
+                speech.speakTextInfo(element,reason=controlTypes.REASON_FOCUS)
 
 class VirtualBuffer(cursorManager.CursorManager, treeInterceptorHandler.TreeInterceptor):
 
@@ -647 +653 @@
                                         self.selection = self.makeTextInfo(initialPos)
                                 speech.cancelSpeech()
                                 reportPassThrough(self)
-                                speech.speakObjectProperties(self.rootNVDAObject,name=True,states=True,reason=speech.REASON_FOCUS)
+                                speech.speakObjectProperties(self.rootNVDAObject,name=True,states=True,reason=controlTypes.REASON_FOCUS)
                                 info=self.makeTextInfo(textInfos.POSITION_CARET)
                                 sayAllHandler.readText(info,sayAllHandler.CURSOR_CARET)
                         self._hadFirstGainFocus = True
@@ -656 +662 @@
                         # This buffer has had focus before.
                         if not self.passThrough:
                                 # Speak it like we would speak focus on any other document object.
-                                speech.speakObject(self.rootNVDAObject, reason=speech.REASON_FOCUS)
+                                speech.speakObject(self.rootNVDAObject, reason=controlTypes.REASON_FOCUS)
                                 info = self.selection
                                 if not info.isCollapsed:
                                         speech.speakSelectionMessage(_("selected %s"), info.text)
                                 else:
                                         info.expand(textInfos.UNIT_LINE)
-                                        speech.speakTextInfo(info, reason=speech.REASON_CARET)
+                                        speech.speakTextInfo(info, reason=controlTypes.REASON_CARET)
 
                 reportPassThrough(self)
                 braille.handler.handleGainFocus(self)
@@ -692 +698 @@
                         reportPassThrough(self)
                 elif obj.role == controlTypes.ROLE_EMBEDDEDOBJECT:
                         obj.setFocus()
-                        speech.speakObject(obj, reason=speech.REASON_FOCUS)
+                        speech.speakObject(obj, reason=controlTypes.REASON_FOCUS)
                 else:
                         self._activateNVDAObject(obj)
 
-        def _set_selection(self, info, reason=speech.REASON_CARET):
+        def _set_selection(self, info, reason=controlTypes.REASON_CARET):
                 super(VirtualBuffer, self)._set_selection(info)
                 if isScriptWaiting() or not info.isCollapsed:
                         return
                 if config.conf['reviewCursor']['followCaret'] and api.getNavigatorObject() is self.rootNVDAObject:
                         api.setReviewPosition(info)
-                if reason == speech.REASON_FOCUS:
+                if reason == controlTypes.REASON_FOCUS:
                         focusObj = api.getFocusObject()
                         if focusObj==self.rootNVDAObject:
                                 return
@@ -800 +806 @@
                         if info.compareEndPoints(fieldInfo, "endToEnd") > 0:
                                 # We've expanded past the end of the field, so limit to the end of the field.
                                 info.setEndPoint(fieldInfo, "endToEnd")
-                speech.speakTextInfo(info, reason=speech.REASON_FOCUS)
+                speech.speakTextInfo(info, reason=controlTypes.REASON_FOCUS)
                 info.collapse()
                 self._set_selection(info, reason=self.REASON_QUICKNAV)
 
@@ -837 +843 @@
                 """Determine whether pass through mode should be enabled or disabled for a given object.
                 @param obj: The object in question.
                 @type obj: L{NVDAObjects.NVDAObject}
-                @param reason: The reason for this query; one of the speech reasons, L{REASON_QUICKNAV}, or C{None} for manual pass through mode activation by the user.
+                @param reason: The reason for this query; one of the reasons in controlTypes, L{REASON_QUICKNAV}, or C{None} for manual pass through mode activation by the user.
                 @return: C{True} if pass through mode should be enabled, C{False} if it should be disabled.
                 """
                 if reason and (
                         self.disableAutoPassThrough
-                        or (reason == speech.REASON_FOCUS and not config.conf["virtualBuffers"]["autoPassThroughOnFocusChange"])
-                        or (reason == speech.REASON_CARET and not config.conf["virtualBuffers"]["autoPassThroughOnCaretMove"])
+                        or (reason == controlTypes.REASON_FOCUS and not config.conf["virtualBuffers"]["autoPassThroughOnFocusChange"])
+                        or (reason == controlTypes.REASON_CARET and not config.conf["virtualBuffers"]["autoPassThroughOnCaretMove"])
                 ):
                         # This check relates to auto pass through and auto pass through is disabled, so don't change the pass through state.
                         return self.passThrough
@@ -855 +861 @@
                 role = obj.role
                 if controlTypes.STATE_READONLY in states and role != controlTypes.ROLE_EDITABLETEXT:
                         return False
-                if reason == speech.REASON_CARET:
+                if reason == controlTypes.REASON_CARET:
                         return role == controlTypes.ROLE_EDITABLETEXT or (role == controlTypes.ROLE_DOCUMENT and controlTypes.STATE_EDITABLE in states)
-                if reason == speech.REASON_FOCUS and role in (controlTypes.ROLE_LISTITEM, controlTypes.ROLE_RADIOBUTTON):
+                if reason == controlTypes.REASON_FOCUS and role in (controlTypes.ROLE_LISTITEM, controlTypes.ROLE_RADIOBUTTON):
                         return True
                 if role in (controlTypes.ROLE_COMBOBOX, controlTypes.ROLE_EDITABLETEXT, controlTypes.ROLE_LIST, controlTypes.ROLE_SLIDER, controlTypes.ROLE_TABCONTROL, controlTypes.ROLE_TAB, controlTypes.ROLE_MENUBAR, controlTypes.ROLE_POPUPMENU, controlTypes.ROLE_MENUITEM, controlTypes.ROLE_TREEVIEW, controlTypes.ROLE_TREEVIEWITEM, controlTypes.ROLE_SPINBUTTON) or controlTypes.STATE_EDITABLE in states:
                         return True
@@ -942 +948 @@
                         # This node is already focused, so we need to move to and speak this node here.
                         newCaret = newInfo.copy()
                         newCaret.collapse()
-                        self._set_selection(newCaret,reason=speech.REASON_FOCUS)
+                        self._set_selection(newCaret,reason=controlTypes.REASON_FOCUS)
                         if self.passThrough:
                                 obj.event_gainFocus()
                         else:
-                                speech.speakTextInfo(newInfo,reason=speech.REASON_FOCUS)
+                                speech.speakTextInfo(newInfo,reason=controlTypes.REASON_FOCUS)
                 else:
                         # This node doesn't have the focus, so just set focus to it. The gainFocus event will handle the rest.
                         obj.setFocus()
@@ -1008 +1014 @@
                 except:
                         # This object is not in the virtual buffer, even though it resides beneath the document.
                         # Automatic pass through should be enabled in certain circumstances where this occurs.
-                        if not self.passThrough and self.shouldPassThrough(obj,reason=speech.REASON_FOCUS):
+                        if not self.passThrough and self.shouldPassThrough(obj,reason=controlTypes.REASON_FOCUS):
                                 self.passThrough=True
                                 reportPassThrough(self)
                                 self._replayFocusEnteredEvents()
@@ -1025 +1031 @@
                                 # If pass-through is disabled, cancel speech, as a focus change should cause page reading to stop.
                                 # This must be done before auto-pass-through occurs, as we want to stop page reading even if pass-through will be automatically enabled by this focus change.
                                 speech.cancelSpeech()
-                        self.passThrough=self.shouldPassThrough(obj,reason=speech.REASON_FOCUS)
+                        self.passThrough=self.shouldPassThrough(obj,reason=controlTypes.REASON_FOCUS)
                         if not self.passThrough:
                                 # We read the info from the buffer instead of the control itself.
-                                speech.speakTextInfo(focusInfo,reason=speech.REASON_FOCUS)
+                                speech.speakTextInfo(focusInfo,reason=controlTypes.REASON_FOCUS)
                                 # However, we still want to update the speech property cache so that property changes will be spoken properly.
-                                speech.speakObject(obj,speech.REASON_ONLYCACHE)
+                                speech.speakObject(obj,controlTypes.REASON_ONLYCACHE)
                         else:
                                 if not oldPassThrough:
                                         self._replayFocusEnteredEvents()
                                 nextHandler()
                         focusInfo.collapse()
-                        self._set_selection(focusInfo,reason=speech.REASON_FOCUS)
+                        self._set_selection(focusInfo,reason=controlTypes.REASON_FOCUS)
                 else:
                         # The virtual buffer caret was already at the focused node.
                         if not self.passThrough:
                                 # This focus change was caused by a virtual caret movement, so don't speak the focused node to avoid double speaking.
                                 # However, we still want to update the speech property cache so that property changes will be spoken properly.
-                                speech.speakObject(obj,speech.REASON_ONLYCACHE)
+                                speech.speakObject(obj,controlTypes.REASON_ONLYCACHE)
                         else:
                                 return nextHandler()
 
@@ -1076 +1082 @@
                 if not scrollInfo.isOverlapping(caretInfo):
                         if scrollInfo.isCollapsed:
                                 scrollInfo.expand(textInfos.UNIT_LINE)
-                        speech.speakTextInfo(scrollInfo,reason=speech.REASON_CARET)
+                        speech.speakTextInfo(scrollInfo,reason=controlTypes.REASON_CARET)
                         scrollInfo.collapse()
                         self.selection = scrollInfo
                         return True
@@ -1192 +1198 @@
                         # Retrieve the cell on which we started.
                         info = next(self._iterTableCells(tableID, row=origRow, column=origCol))
 
-                speech.speakTextInfo(info,formatConfig=formatConfig,reason=speech.REASON_CARET)
+                speech.speakTextInfo(info,formatConfig=formatConfig,reason=controlTypes.REASON_CARET)
                 info.collapse()
                 self.selection = info