Add support for boolean synth settings.

Make bzr ignore build.t2tConf.

Update What's New.

sconstruct: Oops. Use version variable when generating build.t2tConf, not versionInfo.version.
This means that the documentation correctly uses the version from the command line if it is overridden.

t2t docs: Move the NVDA_VERSION, NVDA_URL and NVDA_COPYRIGHT_YEARS macros out of global.t2tConf and instead have scons generate a file containing them using the versionInfo module.
This means that we no longer need to manually update global.t2tConf when one of these changes.
No change is required anywhere else, as global.t2tConf includes the build include (build.t2tConf).
Fixes #1450.

versionInfo: Split copyright years into separate copyrightYears variable, which will allow us to use it in the documentation, etc.
Fixes #1449.

You can now configure whether table cell coordinates are reported from the Document Formatting preferences dialog.
Fixes #719.

base NVDAObject: Treat table rows/columns/cells as layout if reporting of table cell coordinates is disabled.

Added polish symbols,
Updated portuguese language file,
Updated turkish language file and user guide,
Updated brazilian language file, user guide,
Updated finnish language file, symbols, user guide and changes.

Merged in changes to the arabic, swedish and dutch translations

ar: updated Arabic user guide, changes, nvda.po langstrings.txt, (Arabic Translation Team).

nl: Updated Dutch userguide, nvda.po and corrected contributers file to include correct email address for Dutch translation team (Bram Duvigneau).

sv: updated Swedish langstrings.txt.

Announce the cell moved to when navigating tables in Microsoft Word with the tab key. Fixes #159

NVDAObjects.UIA.UIA.__init__:  allow the UIAElement's window handle to override the windowHandle argument as in some situations  there was a contridiction between the window handle values, which caused some strangeness when navigating from one of these objects. Its still odd that getting a UIAelement from a window  has a different windowHandle, but its better that we choose to use just one of them.
This seems to fix the issue where NVDA would not announce the dialog/caption for the UAC dialog sometimes... though not really sure.

Move comment to more appropriate place.

speech:
* getSpeechTextForProperties: Rename includeCoords to includeTableCellCoords for clarity and default it to True.
* speakObject: Fix error which caused table cell coordinates not to be reported when it should be and vice versa.
* getControlFieldSpeech: Don't return a space if reporting of table cell coordinates is disabled and there are no headers, which was breaking blank detection in speakTextInfo.
* Cosmetic fixes.

DocumentFormattingDialog: Change accelerator for Report table cell coordinates to o instead of c, as c conflicts with colours.

Rephrase What's New entry.

Initial code to make reporting of table cell coordinates configurable from Mesar Hameed.

NVDAObjects.window.edit.ITextdocumentTextInfo._getEmbeddedObjectLabel:  It seems that Windows Live Mail still needs  to use IDataObject.getData to get a useful label for its embedded objects, so reinstate that code, but only  if  we can't get useful text from display model. also it now just queryInterfaces directly to IDataObject rather than queryInterface to IOleObject and then calling getclipboardData.

Update what's new

Improve NVDA's support for announcing embedded objects in rich text. This most importantly allows NVDA to announce the recipiants in the To/CC/BCC fields in Microsoft Outlook. Specific changes:
* NVDAObjects.window.edit.ITextDocumentTextInfo: split out the code that tries to get a label for an embedded object in to its own _getEmbeddedObjectLabel method to make code cleaner.
 * NVDAObjects.window.edit.ITextdocumentTextInfo:  completely rewrite how we get a label for an embedded object. The rule is now: 1. try queryInterface to IAccessible on the embeded object and if  successful use accName as the label. This works in MS Outlook 2007 and above. 2. Use displayModel to get the screen text within the bounding rectangle of the embedded object range. 3.  QueryInterface to IOleObject and use getUserType to make the label. No longer at all try using IDataObject.getData and friends as it is too unpredictable and does not work everywhere.
So as said above: Outlook 2007 and above should use IAccessible::accName. Outlook Express / Outlook pre 2007 will use displayModel. And any other embedded object that does not actually have detectable screen text will use getUserType, which is a description of the object type (e.g. Outlook recipiant).
 * NVDAObjects.window.edit.Edit.TextInfo: if the editAPI is greater than 1 and the window class name ends with 'PT'  its safe to use ITextDocument, even if useITextDocumentSupport is false. Outlook uses RichEdit20WPT and probably other versions, but most likely they all end in PT.
Fixes #864.

speech: Stop reporting the read only state when it changes to positive except on editable text fields.

speech.processPositiveStates: Rather than using a condition which checks for a list of reasons, change the condition to check for any reason other than REASON_CHANGE, since this is probably more what we want and covers REASON_FOCUSENTERED as well. (REASON_QUERY has already been handled at this point.)

speech: Don't report submenu for combo boxes. Don't report collapsed/expanded for combo boxes unless explicitly queried.

speech.getControlFieldSpeech: Don't report descriptions if the user has disabled this.

User Guide: Further clarification of Flat Review reviewing objects inside objects.

Don't use the terms "first child" and "parent" with respect to object navigation, as these are confusing for many users. Instead, use container terminology.

Update What's New.

Outlook Express appModule: make sure the NVDAObject overlay class for supporting message rule checkboxes is only used for SysListview32 controls. It was previously not checking the window class and therefore was also being used for the ListBox control found in the Apply now dialog in the message rules dialog. This change means that NVDA will no longer class the rule list items in the apply now dialog as checkboxes. Thus, you can now just listen to their selected/not selected state to tell if they're active or not. The other checkboxes in the message rules dialog should continue to work appropriately. Completely fixes #576

UIA focus event handler: return if  obj is None after NVDAObject instanciation. The other events already did this, just not focus.

UIATextInfo: support initializing with a position of all

Updated what's new

UIATextInfo: allow initializing with positions of first, last, and a UIATextInfo instance (what bookmark returns). also implement __eq__ so that bookmarks can be compared. finally also make textInfos.UNIT_READINGCHUNK to UIA's line unit. these changes allow for sayall to correctly work in UIA text fields that support all needed methods. E.g. its now possible to perform sayall with review cursor in xPS viewer.

User Guide and globalCommands: Clarify that flat review is just an object, not a mode.

speech dictionary entries dialog: address  some issues noted in #357. specifically:  Move the label for the entries list from beside it to above it, and  make the first letter of the Edit button be uppercase to match the other buttons.

What's New: Add release blurb, fix typos/spelling errors.

Update what's new

espeak synthDriver: if an unknown variant is requested, choose max rather than none. Fixes #1548

Fixes bug(s): http://nvda-project.org/ticket/719

User Guide: Fix link for more info about Python Console, as it has now been moved to the Developer Guide.

speech.speakObject:  states are now announced if the reason is focusEntered. this is especially useful if focus moves to a control inside a document that is busy, NVDA will now announce this fact.

VirtualBuffer.event_treeInterceptor_gainFocus: when announcing the document name, also announce states as well, so that busy is announced when the document is busy.

VBufBackend_t::cancelPendingUpdate: reset renderThreadTimerID to 0 after killing the timer. This will stop any possible pending updates from happening that were still possibly in the windows message queue after KillTimer was called. This more importantly also fixes  a problem introduced by r4356 where after a text change and focus change happen in quick succession only focus changes will update the buffer after that point. E.g. after changing the value in a combo box, edit fields would never update their content again.

textInfos.offsets.OffsetsTextInfo._getLineNumFromOffset: return None instead of raising NotImplementedError. this is an optional method to implement and  the code that uses it already checks for None. Stops errors when  announcing lines  in controls that use NVDAObjectTextInfo or other offset-based TextInfos that do not implement a _getLineNumFromOffset while report line numbers is enabled.

MSHTML NVDAObject: add a HTMLNodeUniqueNumber property, and use instead of HTMLNode.uniqueNumber / HTMLNode.uniqueID. As this will be cashed for the core cycle, this now will especially make equality checks of MSHTML NVDAObjects in loops faster (i.e. constnatly checking against rootNVDAObject in the MSHTML virtualBuffer).

Revert accidentilly committed code within r4392. Fixes #1552 and probably other things -- No MSAA annotation was being used so it seems

_UIAHandler.isNativeUIAelement: When looking at providerDescription to detect an MSAA proxy, use a regexp to look for either an Annotation or MSAA proxy.  It seems that pretty much all MSAA proxy UIA elements will also be wrapped in an annotation proxy, except for menus, which use the standard MSAA proxy anyway. Its possible we may still need to add some extra names to this regexp in future. But we must be careful to not ad things like HWND or non-client as these are used even with native UIA elements. This fix seems to stop all the unwanted UI automation focus events

gecko_ia2 vbuf: For Gecko >= 2 (e.g. Firefox >= 4), allow the document to be rendered even if the busy state is set (i.e. it hasn't fully finished loading).
Unfortunately, this isn't safe in Gecko 1.9, as we don't receive events while the document is busy.

UI Automation support: make it again possible to run NVDA after preparing/building with out access to the UI Automation client library.  This was done by moving UIAHandler.py to _UIAHandler.py, and then making a new UIAHandler.py which checks config as to whether it should use UIA or not, and if so then try to imports all of _UIAHandler in to its global namespace and set isUIAAvailable to true. Initialize and terminate are moved from _UIAHandler to UIAHandler, and initialize now throws NotImplementedError if isUIAAvailable is False, but other wize tries to create the handler etc. So for other modules using UIAHandler, the rule is, if isUIAAvailable then  it is guaranteed that all constants, interfaces and code exists in UIAHandler. However, only if handler is not None, does it mean that UIA has actually been initialized.

UIAHandler.UIAHandler.isNativeUIAElement: improve logic to handle the situation where the element has been reparented in to a window that does not natively support UIA (i.e. controls in the IE9 downloads window).
Specifically: if the UIA element definitly has a window handle, then check that window handle to see if the window supports native UIA, and if so then its a native element. We used to use nearest window handle if the element itself did not have a window handle, but the issue was that the nearest window handle may not be native UIA when clearly the element itself was.  If it does not have a window handle, instead look at its providerDescription property to see if its an MSAA proxy, and only treet the element as native if its not. Note that although we cannot detect the element's real window handle, its 99% sure that if the IAccessible it proxies fires an event, that event will come from the real (not reparented) window, and therefore  IAccessibleHandler will filter out the event as it saw that window supported UIA natively.  Fixes #1280.

What's New: Minor fixes.

User Guide: Browse Mode Quick Navigation: Clarify heading level commands.

User guide: Add further explanation to Flat Review section.

User Guide: Improve sections about Navigating with NVDA.

Fix minor knit in last commit; no functional change.

braille: Handle the case where an update causes a region to shrink or disappear entirely so that the start position of the window no longer exists.
BrailleBuffer.restoreWindow() no longer takes an ignoreErrors option and will never leave the window in a broken state. To facilitate this, regionPosToBufferPos() takes an allowNearest option to return the nearest position if the requested position does not exist.
Also fixed a bug in regionPosToBufferPos() so that allowNearest can work. :)

Fix typo

cosmetic: Remove unnecessary pass statements.

Fix for #1455 (Hyphenated words reported incorrectly in standard Windows Edit controls). for now just revert changeset:main,4148 as although this was correct for XP edit controls with out uniscribe support, it was incorrect for all later Operating systems and most likely xP with unicscribe support (east asian language pack installed). An alternative way this could be implemented in the future is to first detect whether uniscribe is being used (not sure how), and if it is, then use ScriptItemize / ScriptBreak to generate an array of script logic attribute structures, and check for which characters allow  word stop on. We could also consider using this inside offsetstextInfo at a low level so that virtualBuffers can make use of better word navigation.

If the OS supports it, detect windows that have a ghost window (they have hung) and skip them when navigating by window, when checking for a higher API on Window NVDAObjects, and when processing MSAA winEvents. This will stop some lags / freezes when navigating top-level windows with object navigatin while a window has hung. It may also stop some other freezes as UIAHasServerSideProvider also would freeze on this ghosted windows.

IAccessibleHandler: add a useful utility function 'isMarshalledIAccessible' which can tell if the given IAccessible COM object is marshalled or local. It does this by looking at the location of its IUnknown::AddRef (first function in its vtable). If its located in oleacc.dll then its a local IAccessible proxy, if its located in ole32.dll, then its marshalled

gecko_ia2 vbuf backend: Handle the encoded accDescriptions used in Gecko 1.
Fixes reporting of encoded position info when reporting focus/quick navigation in browse mode; e.g. "l1" for heading level 1.
Fixes #1542.

Fix misspellings of "NonVisual Desktop Access".
Fixes #1215.

service: Change display name to "NVDA", as we don't use the unabbreviated name as the product name anywhere else and it presents localisation issues.

service: Fix cases where handles were closed twice and some where handles weren't closed at all.
The former caused the service to crash intermittently, while the latter probably caused a slight memory leak.
To make this easier (and to avoid similar mistakes in future), create an AutoHANDLE class which closes the handle automatically when the object is no longer in use.

Updated the list of contributors

QT: code cleaning QT table columns support

Updated galician language file,
Updated spanish language file,
Updated finnish language file, changes, user guide and symbols.

Excel NVDAObjects:
* Move duplicate code used to fire a focus event on the active selection into ExcelBase.
* ExcelBase.getCellAddress: Don't use a regexp to strip the dollar signs. Instead, just request non-absolute references from Excel.
* Implement equality check for ExcelWorksheet and fix equality check for ExcelCell so that these objects are correctly identified as being unequal if the sheet is different.
* Bind control+pageUp/pageDown to changeSelection script so that changing sheets is reported.
* Remove doc string from changeSelection script, as it is an application provided command and the text didn't cover all cases in which it is used.

Fixes #760.

ExcelWorksheet NVDAObject changeSelection script: Return early if a script is waiting, which prevents lag when holding down or rapidly pressing these keys.

ExcelWorksheet NVDAObject: Don't implement initOverlayClass, as this is never used as an overlay class.
ExcelCell NVDAObject: Use __gestures instead of binding in initOverlayClass, as this is never used as an overlay class, so initOverlayClass is never called. (We could just bind in the constructor, but __gestures looks nicer.)

Excel NVDAObjects: Rename ExcelWindow to ExcelBase to avoid confusion with Excel7Window.

Fixes/tweaks to What's New.

nvda app module: Fix code that was supposed to silence invisible clients. This hasn't worked for a while because these clients now get ROLE_UNKNOWN, not ROLE_PANE.

gui: Remove appTitle constant and instead use versionInfo.name.

gui: Code cleanup:
* Remove our custom external execute event code (including gui.execute) and instead just use wx.CallAfter.
* Remove scriptUI. The code is very old and was designed for the time when the GUI ran in a separate thread. Also, we use custom dialogs in many places already anyway.
* Add gui.runScriptModalDialog to simplify using modal dialogs from scripts.

Don't allow NVDA settings dialogs to be shown while a message dialog is being shown.
Previously, you could open the settings dialog, but it would be frozen until the message dialog was dismissed, which was impossible in some configurations.
To do this (and to clean up the code somewhat), introduce gui.messageBox, which should be used for all message dialogs.
Also removed gui.scriptUI.MessageDialog, as it was only used in a couple of places and the eventual aim is to get rid of (or at least majorly refactor) scriptUI.
Fixes #1451.

Remove test line.

SCons: proply check for any unknown commandline variables, and alert the user if there are any. this meant moving all nvdahelper variable definitions in to the main sconstruct, and moving the unknown variables check to after the creation of the base environment.

Updated what's new

Add two new config options to nvda.ini under [UIA]. "enabled" is a boolean that allows you to state whether UIA should be used (default is true). "minWindowsVersion" is a float specifying the minimum windows version (major.minor) where NVDA should be allowed to use UIA. Its default is 6.1 (Windows 7). This means that UIA by default is no longer going to be used in XP. This is due to the fact that there are just to  many freezes, crashes and other performance hits when using the UIAutomation client library available in XP with the platform update. Fixes #1437.

service: Only start/stop NVDA on the Winlogon and InfoCard* desktops (known to be secure desktops).
This means it no longer starts/stops NVDA on user input desktops.

UIAHandler:
* Merge the UIAEventListener class into the UIAHandler class. This stops us from having to keep and dereferencing a weakref to the UIAHandler instance from the event listener. One class is also cleaner.
* No longer dynamically generate the UIAutomation typelib interfaces on import, instead just rely on NVDA already having them in comInterfaces. This certainly is now always true, though may not have been during Windows 7 betas when UIAutomation was still changing.
* As we can now assume we always have the UIAutomation COM interfaces, no longer condissionaly define all our UIA-to-NVDA mappings and classes. Instead just define them no matter what. Takes out one level of indenting.
* Create all needed global UIAutomation COM object instances (IUIAutomation, base cache requests, treeWarkers etc) and register UIAutomation events, in an MTA thread.
* Finally allow NVDA to unregister UIAutomation events on exit, inside the MTA thread. This used to cause a freeze if done in our main thread so we never bothered.

having events now in an MTA may speed up NVDA a touch as the events will no longer be interupting our main thread. As we now cexplicitly unregister all UIAutomation events on exit, this may stop Windows explorer becoming very sluggish after hours of use and NVDA restarts (though not sure). And finally as we now register for UIAutomation events in an MTA, this will stop the freeze at NVDA start up that occures on Windows 7 if another app has crashed and its crash dialog is still up. (UIAutomation tried calling NtUserGetComboBoxInfo on the crashed window and it does not timeout).

Added nvdahelperLocal.def which should have been added a few commits ago.

Updated turkish language file.

Updated georgian language file,
Added georgian characters descriptions and symbols.

Fixes for #1367 and #720. Now the tab key is always overridden in browse mode if focus is directly on any kind of non-editable document. This better fixes the issue where tab would take you to the address bar in Internet Explorer when first focused on the document, and also fixes the issue when focus hits the document of an iframe and then tabbing causes you to go to the first focusable in the iframe, rather than the next one after the cursor position.

Gecko_ia2 VirtualBuffer's _activateNVDAObject method: if the if doAction failed and we need to click using the object's location, move up the ancestors until we get to an object that does not have the offscreen state. Fixes #801

nvdaHelper: remove all remaining uses of __declspec(dllexport) including from RPC interface idl files, and provide a .def file for nvdahelperLocal.dll.  This stops nvdahelperRemote.dll from exporting all vbuf and displayModel interface server stubs (which it does not have to do), and it may also allow the compiler to optimize a bit more as these functions are no longer able to be called from outside the dll (all calls are now predictable.

Fix memory leak for copy settings success/failure message dialog.

Fix memory leak for warning dialog when copying user settings to the system profile.

MSHTML vbufBackend: fix LOG_DEBUG statement so it compiles again with log level of debug

Gecko_ia2 vbufBackend: fix indenting

MSHTML vbufBackend: force nodes with an aria role of "search" to have an accRole of staticText (IE gave them edit). This stops search nodes from being picked up in quicknav for f and e. Also map aria role of "search" to an nvda role of section in aria.py.

NVDAObjects.IAccessible.MSHTML.HTMLNodeFromIAccessible: no longer refuse to queryService if the accRole is 0 or client. This was to stop a crash in IE8 (changeset:main,3471) but the particular testcase where this happens no longer exists, plus it was causing problems on other sites where IE chose to use a role of client within a document tree, such as a div on us.yahoo.com. If the crash clearly comes back because of this commit, we'll fix it more correctly at that point.

speech: Report the selected state of selectable table rows the same way it is reported for list and tree view items.

Gecko vbufBackend's winEvent callback: also listen for focus and alert events, but instead of locating the node and invalidating it, just force an update, just incase there were any invalid nodes that may have contained the current focus/alert. Fixes some focus issues on sites like wohnquartier-am-osterbekkanal.de/ausstattung.html where when a node gains focus, it or one of its ancestors is rerendered. but NVDA sees the event before the delayed virtualBuffer update is complete.

VBufBackend_t: add a forceUpdate public method, which updates any currently invalid nodes right now, and cancels any other pending update.