On ALVA BC640/BC680 braille displays, NVDA no longer disregards display keys that are still held down after another key is released.

alvaBC6 driver: When terminating, drop the ctypes function instance for the key callback, as it is holding a reference to an instance method, which causes a reference cycle.
This doesn't currently cause a memory leak because there is no __del__, but it does mean that it takes a lot longer to be garbage collected than it should.

Reload app modules from user config directory as well.

Especially:
 * appModuleHandler.reloadAppModules(): gracefully call terminate() and initialize()
 * globalPluginHandler.reloadGlobalPlugins(): add code doc

Fix a bug, where 'reload plugins' command caused NVDA to not load global plugins from user config directory.

Details:
 * The bug was caused by the fact, that config.addConfigDirsToPythonPackagePath() was not called from within reloadGlobalPlugins
 * Refactor code a bit, esp. eliminate loadGlobalPlugins(), as reloadGlobalPlugins() now calls initialize() directly and it becomes retundant

What's new: list recent fixes to dialogs in bug fixes.

Speech dictionary dialog: provide a hardcoded sizes in pixels for each of the columns in the list, as well as the over all size of the list. It would be good if this could be avoided, but for now this seems to be the only way to make sure all the columns are shown. Also put the Add, Edit and remove buttons horizontally together rather than leaving them under one another. This all makes sure that  the content in this dialog is viewable by sighted users. Related to #90.

Elements list for virtualBuffers: use proportional sizing for the radio group, tree, filter edit, and buttons. Give the tree a proportion of 7, and everything else a proportion of 1. This makes sure that nothing goes off the screen, and that the tree still takes up most of the vertical space in the dialog. Hopefully addresses #1321.

What's New: Add bug fix entry for last commit, as it's definitely a notable bug.

Fix typo

The hotkey for the Review Cursor item in the NVDA Preferences menu has been changed from r to c to eliminate the conflict with the Braille Settings item.

freedomScientific braille display driver: Make description translatable.

sconstruct: If building a release, we use optimised Python. This means that generateComInterfaces.py needs to be run with optimised Python as well. Otherwise, it will generate .pyc files instead of .pyo files.
Not only will this break, but setup.py will also completely skip the files, so the comInterfaces directory in dist will be completely empty.

sconstruct: When signing the program executables, don't create SCons file nodes for them, as otherwise, SCons seems to get confused about dependencies. It's better for SCons to just not know about anything in the dist directory at all.

winConsoleHandler: Queue the typedCharacter event instead of queuing speech.speakTypedCharacter directly. This means that the functionality to beep if lower case letters are typed while caps lock is on now works in text consoles.
Fixes #1333.

Fix a comment.

sconstruct: If a certificate is provided, sign portable executables as well, even though they don't get uiAccess.

What's New: Change release blurb a little.

Update copyright end year to 2011 in documentation and installer. Also, change Non-Visual to NonVisual in installer, since we use NonVisual everywhere else.

What's New: Add release blurb. Fix spelling mistakes and minor linguistic and spacing errors.

On the Windows XP logon screen, the user name is once again reported when the selected user is changed.

sconstruct: Quote the publisher when passing it to makensis. Fixes failure when supplying a publisher containing a space.

baum driver: Fix byte order for braille keys. The correct order seems illogical to me, but nevertheless, I really should learn to read.

English User Guide: Baum display: Some rewording, plus mention that USB mode must be set to serial for Refreshabraille.

The Baum driver definitely supports more than just the Brailliant now, so document it as such.

baum driver: Ack. Apparently there is a b11 on some displays.

baum driver: Detect BrailleConnect via bluetooth as well.

baum driver: Change next line to d3 to be more consistent with key maps in other products.

Remove pointless debugging.

baum driver: Map the joystick to the arrow and enter keys on the system keyboard.

I am a moron.

baum driver: Update to perhaps recognise more keys on displays other than the SuperVario.
This also removes duplication in the key handling code.
In addition, try to detect Refreshabraille and VarioConnect via bluetooth.

Add braille display driver for Baum SuperVario/HumanWare Brailliant.
This driver may work to some extent with other Baum and HumanWare displays as well, but this isn't officially supported yet.
The source now depends on pyserial; see readme.txt for details.
Fixes #937.

Fix regression where the build version was not reported in the About dialog.

Updated portuguese language file and the language strings for the NVDA installer.

Updated turkish language file,
Updated french language file,
Updated italian language file,
Updated slovak language file, user guide and changes.

Support numpadDelete like the other delete key in documents / edit fields. Fixes #286

Update changes file.

alvaBC6 driver: Remove some annoying/unnecessary logging.

Updated italian language file.

Implement a configuration setting that can again restore the old functionality of announcing position information even if it is rather inaccurate (i.e. resorting to MSAA child ID and parent's accChildCount). Fixes #966. Specifically:
* Added a guessObjectPositionInformationWhenUnavailable boolean to the presentation section of nvda.ini (set to false by default).
* Added a checkbox to the Object Presentation dialog for toggling this setting.
* Made the 'allowIAccessibleChildIDAndChildCountForPositionInfo' IAccessible NVDAObject class variable in to a property guetter, and return the value of the guessObjectPositionInformationWhenUnavailable setting.
* Updated the user guide to mention this setting.

User Guide: Some rewording. Also, split sentences onto separate lines.

English User guide: added an Advanced Topics section at the end, which includes so far une subsection which talks about how users can remap input gestures to scripts in gestures.ini.

English user guide: add a section within setting up NVDA portable, that explains how to place it on a USB thumb drive. It also mentions limitations of auto starting and an article which users should read for more info.

Code doc.

Enable Handy Tech displays to be used without installing the Handy Tech universal driver.
This only works for binary builds.
You will need to copy some files from the Handy Tech SDK to make this work. See readme.txt for details.
Fixes #854.

Fix for #1326 (Link destinations exposed as links in MSHTML virtual buffers). Specifically:
* MSHTML VBufBackend: for "A" tags that have no HREF attribute, remove STATE_SYSTEM_LINKED and STATE_SYSTEM_FOCUSABLE from the IAccessible states if they exist as IE should not do this. This then makes sure that NVDA will not list the anchor in the elements list, nor jump to it with k/u/v, nor should it insert space for the anchor if it contains no children.
* MSHTML virtualBuffer: when normalizing the controlField information for an destination anchor (nodeName is "A" but linked is not in states), change the role to textFrame. This makes sure that NVDA will not announce "link" for these destination anchors, even if they are used around another tag.

Fix handling of standard Windows groupbox windows found in dialogs such as System Properties etc.  As these groupboxews actually appear at the same level as (are a sibling of) the given control, In the past we overrode IAccessible NVDAObject's parent to find the cloest groupbox and return that so that focus changes would report the groupbox as an ancestor. However, this made object navigation rather non-semetrical, in fact the addition of simple review made it worse.  Instead, now there is a 'container' property on NVDAObjects. This container property by default just returns parent. But in special cases it could be overridden to first return a sibling that should be reported as part of the context. Container on IAccessible window root NVDAObject has been overridden to first return a groupbox for this object if it exists. Finally, api.setFocusObject now uses the container property rather than parent when generating the focus ancestors.

Reinstate the key press counter as keyboardHandler.keyCounter. This means braille messages are again dismissed when a key press causes braille to update.
Fixes #1324.

Installer: remove the initial message box that alerts the user that their current copy of NVDA will be quit. The main reason for this is that if their current copy of NVDA is not UAC enabled the dialog will not be able to be interacted with at all correctly. Plus, although the user is alerted, there is no choice, all they can do is press ok anyway. Now thir current copy of NVDA is simply quit and the new NVDA is started. Also  a variable and some checks have been removed which are no longer, and have never really, been necessary (to do with checking if its the old or new NVDA when the installer exits).

lilli braille display driver: Oops. Forgot to rename _display to display.

Updated thai language file,
Updated hebrew language file,
Updated turkish language file,
Updated slovak language file and changes.

Remove readme, as it is useless and unlikely to be updated.
Users should read the User Guide instead.

GUI changes:
* Move the entire About NVDA message into versionInfo.aboutMessage, rather than generating some of it in the gui module.
* Update copyright year.
* Add info about NV Access and request for donations.
* Add Donate item to NVDA menu.
* Linguistic fixes.

NVDA now remembers the position you were at when returning to a previously visited web page. This applies until either the browser or NVDA is exited.
Fixes #132.

English User Guide: Fix indentation error.

VirtualBuffer: Don't set the initial caret position if in focus mode.
If in focus mode, the document must have forced the focus somewhere, so we don't want to override it.

virtual buffers: Remember the position of the caret across loads of web browser documents.
This is done by saving the caret position associated with the document's URL when the buffer is terminated and restoring that position when a document with that URL gains focus.
This is only done for http*, ftp* and file URLs, as we don't want to remember the caret position for email messages, etc.
In practical terms, this is intended to make NVDA stay in the previous position when pressing back in a web browser.

VirtualBuffer: Change _setInitialCaretPos to _getInitialCaretPos. Rather than setting the caret position directly, the new method returns a TextInfo position, which will avoid duplicate code in future.

Updated traditional chinese language file,
Updated thai language file,
Updated turkish language file,
Updated slovak user guide.

Add dist_installer to bzr ignores.

English User Guide: Add Handy Tech key bindings.

Updated Handy Tech driver to use input framework, adding new bindings in the process.

Ooops, hebrew rather than hebrev. I'm sorry.

Updated french language file,
Updated polish language file and user guide,
Updated slovak language file, user guide and changes.

Userguide: also change mention of self voicing mode to sleep mode

braille: Move cursor management code (including blinking) into BrailleHandler.
Braille display drivers no longer handle the cursor at all.
This means that BrailleDisplayDriverWithCursor has been removed. Drivers that used it need only subclass BrailleDisplayDriver instead and rename their _display method to display.
All existing braille display drivers relied on NVDA to manage the cursor and we think all future drivers will as well, so there was no point in keeping this functionality separate. (The handyTech driver initially relied on the Handy Tech COM server to manage the cursor, but we found this to be very buggy/unreliable.)
This greatly simplifies the BrailleDisplayDriver class. Among other things, this should make it easier for developers writing new braille display drivers.

api.setFocusObject: remove the recently added message that notifies the user when hitting a sleep mode application... it was not that popular.

event_appLoseFocus and event_appGainFocus have now been renamed to event_appModule_loseFocus and event_appModule_gainFocus respectivly. This is to keep the naming sintax compatible between appModules and treeInterceptors etc. Custom appModules using these events must be updated.

Self voicing mode has now been renamed to Sleepmode, as this name is much more accurate to what it does. Note that as the 'selfVoicing' property on appModules is now also called 'sleepMode' any custom appModules must be updated to reflect this change.

For the convenience of third party developers, app modules as well as global plugins can now be reloaded without restarting NVDA. Use tools -> Reload plugins in the NVDA menu or NVDA+control+f3.
Fixes #544.

Cosmetic.

Clear the NVDAObject dynamic class cache when reloading plugins so that any used overlay classes in plugins can be garbage collected.

Update English User Guide.

Merge main.

Updated hebrev language file,
updated thai language file.

Allow braille display drivers to bind buttons, wheels and other controls to scripts in NVDA using the new input framework.
Braille display drivers should now provide all input as a braille.BrailleDisplayGesture instance.
They can provide a global input gesture map to add bindings for scripts anywhere in NVDA.
They can also provide their own scripts to perform display specific functions.
See braille.BrailleDisplayDriver for details.
Note that the handyTech and lilli modules have not yet been updated, though they will still work as they did previously.

Fixes #209.

Update/add braille display key binding info in English documentation.

Update braille key bindings in English documentation.

IA2 live region support and Gecko_ia2 vbufBackend: support IA2_EVENT_TEXT_UPDATED as we would for IA2_EVENT_TEXT_INSERTED. Needed for Gecko 2 (Firefox 4 etc).

Update English What's New.

Merge main.

braille_scrollBack, braille_scrollForward scripts: Bypass input help. This allows a braille user to scroll back and forward through input help text.

Remove InputGesture.bypassInputHelp, as it doesn't serve the purpose for which it was intended. Instead, allow scripts to specify that they should bypass input help using the boolean bypassInputHelp attribute on the script function.

braille_previousLine script: Move to the start of the previous line instead of the end.
This required changes to the previousLine() method of braille Region classes.

Freedom Scientific braille driver: allow toggling between line scrolling and display scrolling (panning) with the wiz wheels, by pressing the left or right wiz wheels. The wiz wheels can be configured independently of each other, meaning that you could for instance have the left set to display scrolling and the right set to line scrolling.

inputCore.GlobalGestureMap.add: add a 'replace' boolean keyword argument, which if true, forces add to replace any existing bindings for the given gesture  with a new binding to the given script, otherwize it just appends the new binding as normal.

braille.BrailleDisplayDriverWithCursor's __init__ method: make sure to call super.

Delay reporting of toggle keys by 30 ms, as it seems that the key state sometimes takes a while to change.
This is probably due to keyboard hooks still running when the main thread reports the state.
Should fix intermittent incorrect reporting of toggle keys (caps lock, num lock, etc.).
Fixes #1284.

versionInfo: A version containing "dev" is a test version, so make isTestVersion True in this case.

Allow the silence synth driver to be used again. Fixes #1294

global commands moveMouseToNavigatorObject script: if trying to fetch the point at the start of the current review position causes a LookupError (the TextInfo is currently not specifically on a valid point... e.g. no actual text in the displayModel if its a DisplayModel textInfo), fall back to using the navigator object's location, just as it would if there was a NotImplementedError. Fixes #1270

Freedom Scientific braille driver: Convert to using gestures and inputCore. Now all possible inputs from the braille display are represented by a gesture, and executed appropriately by inputCore. The most user visible change will be the fact that when in Input help mode, pressing any key, button, whizwheel) on the display will cause NVDA to announce the gesture and its script's description if it has one. As like previously, the bottom routing row is used for cursor routing, and the left and right wiz wheels pan forward and back. Eventually some way of configuring the wiz wheels to do either panning or line will be added. No other script mapping have been added at this time. However all possible keys and buttons exisiting on any pacmate or Focus display are now known to NVDA, thus it is possible to map any of these things in future.

brltty driver: Update to use input gesture framework.
In the process, I also mapped previous line and next line to lnup and lndn, respectively.

Remove unnecessary import.

English User Guide: Add key commands for Alva BC640/680.
alvaBC6 driver: Reorganise gesture map to include braille navigation commands first. This is likely to be info that users want first, so I've done this in the User Guide and the driver may as well use the same order. This is entirely cosmetic; no functional change.

Merge main.

source readme: Clarify that wxPython 2.8.x is required; i.e. not 2.9.x.

NVDAObjects.behaviors.Dialog.getDialogText: recurse in to grouping objects to find text. Adobe Reader X (and possibly previous versions) need this to read some dialogs properly.

Some more self voicing fixes:
*treeInterceptorHandler.update: do not create treeInterceptors if  the given object's appModule is self voicing.
*eventHandler.executeEvent: if the object's appModule is self voicing, allow running of doPreGainFocus, but not preDodocLoadComplete or the rest of any other event.
*eventHandler.doPreGainFocus: if the object's appModule is self voicing, do setFocusObject and management of foreground, but not anything else (i.e. do not do focus entered loop etc).
*api.setFocusObject: if an appModule is self voicing, do not run the appModule's loseFocus or gainFocus events.
 Fixes #208 (treeInterceptors being created and receiving gainFocus in self voicing applications).

Add script_toggleCurAppSelfVoicing to global commands bound as NVDA+shift+s. This allows the user to toggle self voicing mode for the active application. Also report when a self voicing application becomes active in both speech and braille. Specific changes:
*scriptHandler.findScript: remove check for self voicing. I'm confused as to what this did anyway as self voicing would have been checked in inputCore before this point anyway. Plus due to following changes findScript must still work with selfVoicing.
*inputCore.InputManager.executeGesture: fetch the gesture's script before any self voicing check. As well as an appModule having the selfVoicing property as true, a script also either must not have a 'allowInSelfVoicing' property, or this property must be set to False, for the gesture action not to take place. In otherwords, this means that if a script has an allowInSelfVoicing property set to true, then the script can still be executed while in a self voicing app.
*Add a script_toggleCurrentAppSelfVoicing (NVDA+shift+s) to global commands. This script goggles the state of the selfVoicing property on the focus object's appModule. It also reports the new state in speech and braille. This script also has the allowInSelfVoicing property set to true, so that this script can be executed again to disable self voicing.