forked from nvaccess/nvda
-
Notifications
You must be signed in to change notification settings - Fork 0
/
changes.t2t
4742 lines (4157 loc) · 446 KB
/
changes.t2t
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
What's New in NVDA
%!includeconf: ../changes.t2tconf
%!includeconf: ./locale.t2tconf
= 2024.1 =
== New Features ==
- Added support for Bluetooth Low Energy HID Braille displays. (#15470)
- The Add-on Store now supports bulk actions (e.g. installing, enabling add-ons) by selecting multiple add-ons. (#15350, #15623, @CyrilleB79)
- From the add-on store, it's possible to open a dedicated webpage to see or provide feedback about the selected add-on. (#15576, @nvdaes)
- A new "on-demand" speech mode has been added.
When speech is on-demand, NVDA does not speak automatically (e.g. when moving the cursor) but still speaks when calling commands whose goal is explicitly to report something (e.g. report window title). (#481, @CyrilleB79)
-
== Changes ==
- NVDA no longer supports Windows 7 and Windows 8.
Windows 8.1 is the minimum Windows version supported. (#15544)
- Component updates:
- Updated LibLouis braille translator to 3.28.0. (#15435, #15876, @codeofdusk)
- Added new Thai, Romanian, and Filipino Braille tables.
-
- eSpeak NG has been updated to 1.52-dev commit ``530bf0abf``. (#15036)
- CLDR emoji and symbol annotations has been updated to version 44.0. (#15712, @OzancanKaratas)
- Updated Java Access Bridge to 17.0.9+8Zulu (17.46.19). (#15744)
-
- The following commands now support two and three presses to spell the reported information and spell with character descriptions: report selection, report clipboard text and report focused object. (#15449, @CyrilleB79)
- The option "Report role when mouse enters object" in NVDA's mouse settings category has been renamed to "Report object when mouse enters it".
This option now announces additional relevant information about an object when the mouse enters it, such as states (checked/pressed) or cell coordinates in a table. (#15420, @LeonarddeR)
- When requesting formatting information on Excel cells, borders and background will only be reported if there is such formatting. (#15560, @CyrilleB79)
- The command to toggle the screen curtain now has a default gesture: ``NVDA+control+escape``. (#10560, @CyrilleB79)
- NVDA will again no longer report unlabelled groupings such as in recent versions of Microsoft Office 365 menus. (#15638)
- New items have beeen added to the Help menu for the NV Access "Get Help" page and Shop. (#14631)
- NVDA's support for [Poedit https://poedit.net] is overhauled for Poedit version 3 and above.
Users of Poedit 1 are encouraged to update to Poedit 3 if they want to rely on enhanced accessibility in Poedit, such as shortcuts to read translator notes and comments. (#15313, #7303, @LeonarddeR)
- Braille viewer and speech viewer are now disabled in secure mode. (#15680)
- During object navigation, disabled (unavailable) objects will not be ignored anymore. (#15477, @CyrilleB79)
-
== Bug Fixes ==
- Reporting of object shortcut keys has been improved. (#10807, #15816, @CyrilleB79)
- The SAPI4 synthesizer now properly supports volume, rate and pitch changes embedded in speech. (#15271, @LeonarddeR)
- Multi line state is now correctly reported in applications using Java Access Bridge. (#14609)
- In LibreOffice, words deleted using the ``control+backspace`` keyboard shortcut are now also properly announced when the deleted word is followed by whitespace (like spaces and tabs). (#15436, @michaelweghorn)
- In LibreOffice, announcement of the status bar using the ``NVDA+end`` keyboard shortcut now also works for dialogs in LibreOffice version 24.2 and newer. (#15591, @michaelweghorn)
- In LibreOffice, text attributes according to the [IAccessible2 text attributes specification https://wiki.linuxfoundation.org/accessibility/iaccessible2/textattributes] are supported, which is required to support announcement of text attributes in LibreOffice versions 24.2 and above.
This makes the announcement of spelling errors work when announcing a line in Writer. (#15648, @michaelweghorn)
- In Microsoft Excel with UIA disabled, braille is updated, and the active cell content is spoken, when ``control+y``, ``control+z`` or ``alt+backspace`` is pressed. (15547)
- In Microsoft Word with UIA disabled braille is updated when ``control+v``, ``control+x``, ``control+y``, ``control+z``, ``alt+backspace``, ``backspace`` or ``control+backspace`` is pressed.
It is also updated with UIA enabled, when typing text and braille is tethered to review and review follows caret. (#3276)
- Multi line braille displays will no longer crash the BRLTTY driver and are treated as one continuous display. (#15386)
- NVDA no longer sometimes freezes briefly when multiple sounds are played in rapid succession. (#15311)
- NVDA will announce dialog content for more Windows 10 and 11 dialogs. (#15729, @josephsl)
- NVDA will no longer fail to read a newly loaded page in Microsoft Edge when using UI Automation. (#15736)
- When using say all or commands which spell text, pauses between sentences or characters no longer gradually decrease over time. (#15739, @jcsteh)
- NVDA no longer sometimes freezes when speaking a large amount of text. (#15752, @jcsteh)
- More objects which contain useful text are detected, and text content is displayed in braille. (#15605)
- When reinstalling an incompatible add-on it is no longer forcefully disabled. (#15584, @lukaszgo1)
- When accessing Microsoft Edge using UI Automation, NVDA is able to activate more controls in browse mode. (#14612)
- NVDA no longer freezes briefly when multiple sounds are played in rapid succession. (#15757, @jcsteh)
- NVDA will not fail to start anymore when the configuration file is corrupted, but it will restore the configuration to default as it did in the past. (#15690, @CyrilleB79)
- Fixed support for System List view (``SysListView32``) controls in Windows Forms applications. (#15283, @LeonarddeR)
- If the audio output device is set to something other than the default and that device becomes available again after being unavailable, NVDA will now switch back to the configured device instead of continuing to use the default device. (#15759, @jcsteh)
- It is not possible anymore to overwrite NVDA's Python console history. (#15792, @CyrilleB79)
- In Word, the landing cell will now be correctly reported when using the native Word commands for table navigation ``alt+home``, ``alt+end``, ``alt+pageUp`` and ``alt+pageDown``. (#15805, @CyrilleB79)
- NVDA now resumes audio if the configuration of the output device changes or another application releases exclusive control of the device. (#15758, #15775, @jcsteh)
- NVDA should remain responsive when being flooded with many UI Automation events, e.g. large amounts of text in a terminal. (#14888)
- This new behavior can be disabled using the new Use enhanced event processing setting in NVDA's advanced settings.
-
- Contracted braille input works properly again. (#15773, @aaclause)
- NVDA is again able to track the focus in applications running within Windows Defender Application Guard (WDAG). (#15164)
- Braille is now updated when moving the navigator object between table cells in more situations (#15755, @Emil-18)
-
== Changes for Developers ==
Please refer to [the developer guide https://www.nvaccess.org/files/nvda/documentation/developerGuide.html#API] for information on NVDA's API deprecation and removal process.
- Note: this is an Add-on API compatibility breaking release.
Add-ons will need to be re-tested and have their manifest updated.
- Building NVDA now requires Visual Studio 2022.
Please refer to the [NVDA docs https://github.com/nvaccess/nvda/blob/release-2024.1/projectDocs/dev/createDevEnvironment.md] for the specific list of Visual Studio components. (#14313)
- Added the following extension points:
- ``treeInterceptorHandler.post_browseModeStateChange``. (#14969, @nvdaes)
- ``speech.speechCanceled``. (#15700, @LeonarddeR)
-
- It is now possible to use plural forms in an add-on's translations. (#15661, @beqabeqa473)
- Included python3.dll in the binary distribution for use by add-ons with external libraries utilizing the [stable ABI https://docs.python.org/3.11/c-api/stable.html]. (#15674, @mzanm)
- The ``BrailleDisplayDriver`` base class now has ``numRows`` and ``numCols`` properties to provide information about multi line braille displays.
Setting ``numCells`` is still supported for single line braille displays and ``numCells`` will return the total number of cells for multi line braille displays. (#15386)
- Updated BrlAPI for BRLTTY to version 0.8.5, and its corresponding python module to a Python 3.11 compatible build. (#15652, @LeonarddeR)
- Added the ``speech.speakSsml`` function, which allows you to write NVDA speech sequences using [SSML https://www.w3.org/TR/speech-synthesis11/]. (#15699, @LeonarddeR)
- The following tags are currently supported and translated to appropriate NVDA speech commands:
- ``Prosody`` (``pitch``, ``rate`` and ``volume``). Only multiplication (e.g. ``200%`` are supported.
- ``say-as`` with the ``interpret`` attribute set to ``characters``
- ``voice`` with the ``xml:lang`` set to an XML language
- ``break`` with the ``time`` attribute set to a value in milliseconds, e.g. ``200ms``
- ``mark`` with the ``name`` attribute set to a mark name, e.g. ``mark1``, requires providing a callback
-
- Example: ``speech.speakSsml('<speak><prosody pitch="200%">hello</prosody><break time="500ms" /><prosody rate="50%">John</prosody></speak>')``
- The SSML parsing capabilities are backed by the ``SsmlParser`` class in the ``speechXml`` module.
-
- Changes to the NVDA Controller Client library:
- The file names of the library no longer contain a suffix denoting the architecture, i.e. ``nvdaControllerClient32/64.dll`` are now called ``nvdaControllerClient.dll``. (#15718, #15717, @LeonarddeR)
- Added the following functions to the controller client: (#15734, #11028, #5638, @LeonarddeR)
- ``nvdaController_getProcessId``: To get the process id (PID) of the current instance of NVDA the controller client is using.
- ``nvdaController_speakSsml``: To instruct NVDA to speak according to the given SSML. This function also supports:
- Providing the symbol level.
- Providing the priority of speech to be spoken.
- Speaking both synchronously (blocking) and asynchronously (instant return).
-
- ``nvdaController_setOnSsmlMarkReachedCallback``: To register a callback of type ``onSsmlMarkReachedFuncType`` that is called in synchronous mode for every ``<mark />`` tag encountered in the SSML sequence provided to ``nvdaController_speakSsml``.
-
- Note: the new functions in the controller client only support NVDA 2024.1 and above.
-
- Updated ``include`` dependencies:
- detours to ``4b8c659f549b0ab21cf649377c7a84eb708f5e68``. (#15695)
- ia2 to ``3d8c7f0b833453f761ded6b12d8be431507bfe0b``. (#15695)
- sonic to ``8694c596378c24e340c09ff2cd47c065494233f1``. (#15695)
- w3c-aria-practices to ``9a5e55ccbeb0f1bf92b6127c9865da8426d1c864``. (#15695)
- wil to ``5e9be7b2d2fe3834a7107f430f7d4c0631f69833``. (#15695)
-
- Device info yielded by ``hwPortUtils.listUsbDevices`` now contain the bus reported description of the USB device (key ``busReportedDeviceDescription``). (#15764, @LeonarddeR)
- For USB serial devices, ``bdDetect.getConnectedUsbDevicesForDriver`` and ``bdDetect.getDriversForConnectedUsbDevices`` now yield device matches containing a ``deviceInfo`` dictionary enriched with data about the USB device, such as ``busReportedDeviceDescription``. (#15764, @LeonarddeR)
- When the configuration file ``nvda.ini`` is corrupted, a backup copy is saved before it is reinitialized. (#15779, @CyrilleB79)
- When defining a script with the script decorator, the ``speakOnDemand`` boolean argument can be specified to control if a script should speak while in "on-demand" speech mode. (#481, @CyrilleB79)
- Scripts that provide information (e.g. say window title, report time/date) should speak in the "on-demand" mode.
- Scripts that perform an action (e.g. move the cursor, change a parameter) should not speak in the "on-demand" mode.
-
-
=== API Breaking Changes ===
These are breaking API changes.
Please open a GitHub issue if your Add-on has an issue with updating to the new API.
- NVDA is now built with Python 3.11. (#12064)
- Updated pip dependencies:
- configobj to 5.1.0dev commit ``e2ba4457c4651fa54f8d59d8dcdd3da950e956b8``. (#15544)
- Comtypes to 1.2.0. (#15513, @codeofdusk)
- fast_diff_match_patch to 2.0.1. (#15514, @codeofdusk)
- Flake8 to 4.0.1. (#15636, @lukaszgo1)
- py2exe to 0.13.0.1dev commit ``4e7b2b2c60face592e67cb1bc935172a20fa371d``. (#15544)
- robotframework to 6.1.1. (#15544)
- SCons to 4.5.2. (#15529)
- sphinx to 7.2.6. (#15544)
- wxPython to 4.2.1. (#12551)
-
- Removed pip dependencies:
- typing_extensions, these should be supported natively in Python 3.11 (#15544)
- nose, instead unittest-xml-reporting is used to generate XML reports. (#15544)
-
- ``IAccessibleHandler.SecureDesktopNVDAObject`` has been removed.
Instead, when NVDA is running on the user profile, track the existence of the secure desktop with the extension point: ``winAPI.secureDesktop.post_secureDesktopStateChange``. (#14488)
- ``braille.BrailleHandler.handlePendingCaretUpdate`` has been removed with no public replacement. (#15163, @LeonarddeR)
- ``bdDetect.addUsbDevices and bdDetect.addBluetoothDevices`` have been removed.
Braille display drivers should implement the ``registerAutomaticDetection`` ``classmethod`` instead.
That method receives a ``DriverRegistrar`` object on which the ``addUsbDevices`` and ``addBluetoothDevices`` methods can be used. (#15200, @LeonarddeR)
- The default implementation of the check method on ``BrailleDisplayDriver`` now requires both the ``threadSafe`` and ``supportsAutomaticDetection`` attributes to be set to ``True``. (#15200, @LeonarddeR)
- Passing lambda functions to ``hwIo.ioThread.IoThread.queueAsApc`` is no longer possible, as functions should be weakly referenceable. (#14627, @LeonarddeR)
- ``IoThread.autoDeleteApcReference`` has been removed. (#14924, @LeonarddeR)
- To support capital pitch changes, synthesizers must now explicitly declare their support for the ``PitchCommand`` in the ``supportedCommands`` attribute on the driver. (#15433, @LeonarddeR)
- ``speechDictHandler.speechDictVars`` has been removed. Use ``NVDAState.WritePaths.speechDictsDir`` instead of ``speechDictHandler.speechDictVars.speechDictsPath``. (#15614, @lukaszgo1)
- ``languageHandler.makeNpgettext`` and ``languageHandler.makePgettext`` have been removed.
``npgettext`` and ``pgettext`` are supported natively now. (#15546)
- The app module for [Poedit https://poedit.net] has been changed significantly. The ``fetchObject`` function has been removed. (#15313, #7303, @LeonarddeR)
- The following redundant types and constants have been removed from ``hwPortUtils``: (#15764, @LeonarddeR)
- ``PCWSTR``
- ``HWND`` (replaced by ``ctypes.wintypes.HWND``)
- ``ULONG_PTR``
- ``ULONGLONG``
- ``NULL``
- ``GUID`` (replaced by ``comtypes.GUID``)
-
- ``gui.addonGui.AddonsDialog`` has been removed. (#15834)
% Insert new list items here as the alias appModule table should be kept at the bottom of this list
- The following app modules are removed.
Code which imports from one of them, should instead import from the replacement module. (#15618, @lukaszgo1)
-
|| Removed module name | Replacement module |
| ``azardi-2.0`` | ``azardi20`` |
| ``azuredatastudio`` | ``code`` |
| ``azuredatastudio-insiders`` | ``code`` |
| ``calculatorapp`` | ``calculator`` |
| ``code - insiders`` | ``code`` |
| ``commsapps`` | ``hxmail`` |
| ``dbeaver`` | ``eclipse`` |
| ``digitaleditionspreview`` | ``digitaleditions`` |
| ``esybraille`` | ``esysuite`` |
| ``hxoutlook`` | ``hxmail`` |
| ``miranda64`` | ``miranda32`` |
| ``mpc-hc`` | ``mplayerc`` |
| ``mpc-hc64`` | ``mplayerc`` |
| ``notepad++`` | ``notepadPlusPlus`` |
| ``searchapp`` | ``searchui`` |
| ``searchhost`` | ``searchui`` |
| ``springtoolsuite4`` | ``eclipse`` |
| ``sts`` | ``eclipse`` |
| ``teamtalk3`` | ``teamtalk4classic`` |
| ``textinputhost`` | ``windowsinternal_composableshell_experiences_textinput_inputapp`` |
| ``totalcmd64`` | ``totalcmd`` |
| ``win32calc`` | ``calc`` |
| ``winmail`` | ``msimn`` |
| ``zend-eclipse-php`` | ``eclipse`` |
| ``zendstudio`` | ``eclipse`` |
=== Deprecations ===
- Using ``watchdog.getFormattedStacksForAllThreads`` is deprecated - please use ``logHandler.getFormattedStacksForAllThreads`` instead. (#15616, @lukaszgo1)
- ``easeOfAccess.canConfigTerminateOnDesktopSwitch`` has been deprecated, as it became obsolete since Windows 7 is no longer supported. (#15644, @LeonarddeR)
- ``winVersion.isFullScreenMagnificationAvailable`` has been deprecated - use ``visionEnhancementProviders.screenCurtain.ScreenCurtainProvider.canStart`` instead. (#15664, @josephsl)
- The following Windows release constants has been deprecated from winVersion module (#15647, @josephsl):
- ``winVersion.WIN7``
- ``winVersion.WIN7_SP1``
- ``winVersion.WIN8``
-
- The ``bdDetect.KEY_*`` constants have been deprecated.
Use ``bdDetect.DeviceType.*`` instead. (#15772, @LeonarddeR).
- The ``bdDetect.DETECT_USB`` and ``bdDetect.DETECT_BLUETOOTH`` constants have been deprecated with no public replacement. (#15772, @LeonarddeR).
-
= 2023.3 =
This release includes improvements to performance, responsiveness and stability of audio output.
Options have been added to control the volume of NVDA sounds and beeps, or to have them follow the volume of the voice you are using.
NVDA can now periodically refresh OCR results, speaking new text as it appears.
This can be configured in the Windows OCR category of NVDA's settings dialog.
There's been several braille fixes, improving device detection and caret movement.
It is now possible to opt-out unwanted drivers from automatic detection, to improve autodetection performance.
There are also new BRLTTY commands.
There's also been bug fixes for the Add-on Store, Microsoft Office, Microsoft Edge context menus, and Windows Calculator.
== New Features ==
- Enhanced sound management:
- A new Audio Settings panel:
- This can be opened with ``NVDA+control+u``. (#15497)
- An option in Audio settings to have the volume of NVDA sounds and beeps follow the volume setting of the voice you are using. (#1409)
- An option in Audio settings to separately configure the volume of NVDA sounds. (#1409, #15038)
- The settings to change audio output device and toggle audio ducking have been moved to the new Audio settings panel from the Select Synthesizer dialog.
These options will be removed from the "select synthesizer" dialog in 2024.1. (#15486, #8711)
-
- NVDA will now output audio via the Windows Audio Session API (WASAPI), which may improve the responsiveness, performance and stability of NVDA speech and sounds. (#14697, #11169, #11615, #5096, #10185, #11061)
- Note: WASAPI is incompatible with some add-ons.
Compatible updates are available for these add-ons, please update them before updating NVDA.
Incompatible versions of these add-ons will be disabled when updating NVDA:
- Tony's Enhancements version 1.15 or older. (#15402)
- NVDA global commands extension 12.0.8 or older. (#15443)
-
-
- NVDA is now able to continually update the result when performing optical character recognition (OCR), speaking new text as it appears. (#2797)
- To enable this functionality, enable the option "Periodically refresh recognized content" in the Windows OCR category of NVDA's settings dialog.
- Once enabled, you can toggle speaking new text by toggling report dynamic content changes (pressing ``NVDA+5``).
-
- When using automatic detection of braille displays, it is now possible to opt-out drivers from detection from the braille display selection dialog. (#15196)
- A new option in Document Formatting settings, "Ignore blank lines for line indentation reporting". (#13394)
- Added an unassigned gesture to navigate by tab groupings in browse mode. (#15046)
-
== Changes ==
- Braille:
- When the text in a terminal changes without updating the caret, the text on a braille display will now properly update when positioned on a changed line.
This includes situations where braille is tethered to review. (#15115)
- More BRLTTY key bindings are now mapped to NVDA commands (#6483):
- ``learn``: toggle NVDA input help
- ``prefmenu``: open the NVDA menu
- ``prefload``/``prefsave``: Load/save NVDA configuration
- ``time``: Show time
- ``say_line``: Speak the current line where the review cursor is located
- ``say_below``: Say all using review cursor
-
- The BRLTTY driver is only available when a BRLTTY instance with BrlAPI enabled is running. (#15335)
- The advanced setting to enable support for HID braille has been removed in favor of a new option.
You can now disable specific drivers for braille display auto detection in the braille display selection dialog. (#15196)
-
- Add-on Store: Installed add-ons will now be listed in the Available Add-ons tab, if they are available in the store. (#15374)
- Some shortcut keys have been updated in the NVDA menu. (#15364)
-
== Bug Fixes ==
- Microsoft Office:
- Fixed crash in Microsoft Word when Document formatting options "report headings" and "report comments and notes" were not enabled. (#15019)
- In Word and Excel, text alignment will be correctly reported in more situations. (#15206, #15220)
- Fixes the announcement of some cell formatting shortcuts in Excel. (#15527)
-
- Microsoft Edge:
- NVDA will no longer jump back to the last browse mode position when opening the context menu in Microsoft Edge. (#15309)
- NVDA is once again able to read context menus of downloads in Microsoft Edge. (#14916)
-
- Braille:
- The braille cursor and selection indicators will now always be updated correctly after showing or hiding respective indicators with a gesture. (#15115)
- Fixed bug where Albatross braille displays try to initialize although another braille device has been connected. (#15226)
-
- Add-on Store:
- Fixed bug where unchecking "include incompatible add-ons" would result in incompatible add-ons still being listed in the store. (#15411)
- Add-ons blocked due to compatibility reasons should now be filtered correctly when toggling the filter for enabled/disabled status. (#15416)
- Fixed bug preventing overridden enabled incompatible add-ons being upgraded or replaced using the external install tool. (#15417)
- Fixed bug where NVDA would not speak until restarted after add-on installation. (#14525)
- Fixed bug where add-ons cannot be installed if a previous download failed or was cancelled. (#15469)
- Fixed issues with handling incompatible add-ons when upgrading NVDA. (#15414, #15412, #15437)
-
- NVDA once again announces calculation results in the Windows 32bit calculator on Server, LTSC and LTSB versions of Windows. (#15230)
- NVDA no longer ignores focus changes when a nested window (grand child window) gets focus. (#15432)
- Fixed a potential cause of crashing during NVDA startup. (#15517)
-
== Changes for Developers ==
Please refer to [the developer guide https://www.nvaccess.org/files/nvda/documentation/developerGuide.html#API] for information on NVDA's API deprecation and removal process.
- ``braille.handler.handleUpdate`` and ``braille.handler.handleReviewMove`` have been changed in order not to update instantly.
Before this change, when either of these methods was called very often, this would drain many resources.
These methods now queue an update at the end of every core cycle instead.
They should also be thread safe, making it possible to call them from background threads. (#15163)
- Added official support to register custom braille display drivers in the automatic braille display detection process.
Consult the ``braille.BrailleDisplayDriver`` class documentation for more details.
Most notably, the ``supportsAutomaticDetection`` attribute must be set to ``True`` and the ``registerAutomaticDetection`` ``classmethod`` must be implemented. (#15196)
-
=== Deprecations ===
- ``braille.BrailleHandler.handlePendingCaretUpdate`` is now deprecated with no public replacement.
It will be removed in 2024.1. (#15163)
- Importing the constants ``xlCenter``, ``xlJustify``, ``xlLeft``, ``xlRight``, ``xlDistributed``, ``xlBottom``, ``xlTop`` from ``NVDAObjects.window.excel`` is deprecated.
Use ``XlHAlign`` or ``XlVAlign`` enumerations instead. (#15205)
- The mapping ``NVDAObjects.window.excel.alignmentLabels`` is deprecated.
Use the ``displayString`` methods of ``XlHAlign`` or ``XlVAlign`` enumerations instead. (#15205)
- ``bdDetect.addUsbDevices`` and ``bdDetect.addBluetoothDevices`` have been deprecated.
Braille display drivers should implement the ``registerAutomaticDetection`` classmethod instead.
That method receives a ``DriverRegistrar`` object on which the ``addUsbDevices`` and ``addBluetoothDevices`` methods can be used. (#15200)
- The default implementation of the check method on ``BrailleDisplayDriver`` uses ``bdDetect.driverHasPossibleDevices`` for devices that are marked as thread safe.
Starting from NVDA 2024.1, in order for the base method to use ``bdDetect.driverHasPossibleDevices``, the ``supportsAutomaticDetection`` attribute must be set to ``True`` as well. (#15200)
-
= 2023.2 =
This release introduces the Add-on Store to replace the Add-ons Manager.
In the Add-on Store you can browse, search, install and update community add-ons.
You can now manually override incompatibility issues with outdated add-ons at your own risk.
There are new braille features, commands, and display support.
There are also new input gestures for OCR and flattened object navigation.
Navigating and reporting formatting in Microsoft Office is improved.
There are many bug fixes, particularly for braille, Microsoft Office, web browsers and Windows 11.
eSpeak-NG, LibLouis braille translator, and Unicode CLDR have been updated.
== New Features ==
- Add-on Store has been added to NVDA. (#13985)
- Browse, search, install and update community add-ons.
- Manually override incompatibility issues with outdated add-ons.
- The Add-ons Manager has been removed and replaced by the Add-on Store.
- For more information please read the updated user guide.
-
- New input gestures:
- An unbound gesture to cycle through the available languages for Windows OCR. (#13036)
- An unbound gesture to cycle through the braille show messages modes. (#14864)
- An unbound gesture to toggle showing the selection indicator for braille. (#14948)
- Added default keyboard gesture assignments to move to the next or previous object in a flattened view of the object hierarchy. (#15053)
- Desktop: ``NVDA+numpad9`` and ``NVDA+numpad3`` to move to the previous and next objects respectively.
- Laptop: ``shift+NVDA+[`` and ``shift+NVDA+]`` to move to the previous and next objects respectively.
-
-
- New braille features:
- Added support for the Help Tech Activator braille display. (#14917)
- A new option to toggle showing the selection indicator (dots 7 and 8). (#14948)
- A new option to optionally move the system caret or focus when changing the review cursor position with braille routing keys. (#14885, #3166)
- When pressing ``numpad2`` three times to report the numerical value of the character at the position of the review cursor, the information is now also provided in braille. (#14826)
- Added support for the ``aria-brailleroledescription`` ARIA 1.3 attribute, allowing web authors to override the type of an element shown on the braille display. (#14748)
- Baum braille driver: added several braille chord gestures for performing common keyboard commands such as ``windows+d`` and ``alt+tab``.
Please refer to the NVDA User Guide for a full list. (#14714)
-
- Added pronunciation of Unicode symbols:
- braille symbols such as ``⠐⠣⠃⠗⠇⠐⠜``. (#13778)
- Mac Option key symbol ``⌥``. (#14682)
-
- Added gestures for Tivomatic Caiku Albatross braille displays. (#14844, #15002)
- showing the braille settings dialog
- accessing the status bar
- cycling the braille cursor shape
- cycling the braille show messages mode
- toggling the braille cursor on/off
- toggling the "braille show selection indicator" state
- cycling the "braille move system caret when routing review cursor" mode. (#15122)
-
- Microsoft Office features:
- When highlighted text is enabled Document Formatting, highlight colours are now reported in Microsoft Word. (#7396, #12101, #5866)
- When colors are enabled Document Formatting, background colours are now reported in Microsoft Word. (#5866)
- When using Excel shortcuts to toggle format such as bold, italic, underline and strike through of a cell in Excel, the result is now reported. (#14923)
-
- Experimental enhanced sound management:
- NVDA can now output audio via the Windows Audio Session API (WASAPI), which may improve the responsiveness, performance and stability of NVDA speech and sounds. (#14697)
- WASAPI usage can be enabled in Advanced settings.
Additionally, if WASAPI is enabled, the following Advanced settings can also be configured.
- An option to have the volume of NVDA sounds and beeps follow the volume setting of the voice you are using. (#1409)
- An option to separately configure the volume of NVDA sounds. (#1409, #15038)
-
- There is a known issue with intermittent crashing when WASAPI is enabled. (#15150)
-
- In Mozilla Firefox and Google Chrome, NVDA now reports when a control opens a dialog, grid, list or tree if the author has specified this using ``aria-haspopup``. (#8235)
- It is now possible to use system variables (such as ``%temp%`` or ``%homepath%``) in the path specification while creating portable copies of NVDA. (#14680)
- In Windows 10 May 2019 Update and later, NVDA can announce virtual desktop names when opening, changing, and closing them. (#5641)
- A system wide parameter has been added to allow users and system administrators to force NVDA to start in secure mode. (#10018)
-
== Changes ==
- Component updates:
- eSpeak NG has been updated to 1.52-dev commit ``ed9a7bcf``. (#15036)
- Updated LibLouis braille translator to [3.26.0 https://github.com/liblouis/liblouis/releases/tag/v3.26.0]. (#14970)
- CLDR has been updated to version 43.0. (#14918)
-
- LibreOffice changes:
- When reporting the review cursor location, the current cursor/caret location is now reported relative to the current page in LibreOffice Writer 7.6 and newer, similar to what is done for Microsoft Word. (#11696)
- Announcement of the status bar (e.g. triggered by ``NVDA+end``) works for LibreOffice. (#11698)
- When moving to a different cell in LibreOffice Calc, NVDA no longer incorrectly announces the coordinates of the previously focused cell when cell coordinate announcement is disabled in NVDA's settings. (#15098)
-
- Braille changes:
- When using a braille display via the Standard HID braille driver, the dpad can be used to emulate the arrow keys and enter.
Also ``space+dot1`` and ``space+dot4`` now map to up and down arrow respectively. (#14713)
- Updates to dynamic web content (ARIA live regions) are now displayed in braille.
This can be disabled in the Advanced Settings panel. (#7756)
-
- Dash and em-dash symbols will always be sent to the synthesizer. (#13830)
- Distance reported in Microsoft Word will now honour the unit defined in Word's advanced options even when using UIA to access Word documents. (#14542)
- NVDA responds faster when moving the cursor in edit controls. (#14708)
- Script for reporting the destination of a link now reports from the caret / focus position rather than the navigator object. (#14659)
- Portable copy creation no longer requires that a drive letter be entered as part of the absolute path. (#14680)
- If Windows is configured to display seconds in the system tray clock, using ``NVDA+f12`` to report the time now honors that setting. (#14742)
- NVDA will now report unlabeled groupings that have useful position information, such as in recent versions of Microsoft Office 365 menus. (#14878)
-
== Bug Fixes ==
- Braille:
- Several stability fixes to input/output for braille displays, resulting in less frequent errors and crashes of NVDA. (#14627)
- NVDA will no longer unnecessarily switch to no braille multiple times during auto detection, resulting in a cleaner log and less overhead. (#14524)
- NVDA will now switch back to USB if a HID Bluetooth device (such as the HumanWare Brailliant or APH Mantis) is automatically detected and an USB connection becomes available.
This only worked for Bluetooth Serial ports before. (#14524)
- When no braille display is connected and the braille viewer is closed by pressing ``alt+f4`` or clicking the close button, the display size of the braille subsystem will again be reset to no cells. (#15214)
-
- Web browsers:
- NVDA no longer occasionally causes Mozilla Firefox to crash or stop responding. (#14647)
- In Mozilla Firefox and Google Chrome, typed characters are no longer reported in some text boxes even when speak typed characters is disabled. (#8442)
- You can now use browse mode in Chromium Embedded Controls where it was not possible previously. (#13493, #8553)
- In Mozilla Firefox, moving the mouse over text after a link now reliably reports the text. (#9235)
- The destination of graphic links is now reported accurately in more cases in Chrome and Edge. (#14783)
- When trying to report the URL for a link without a href attribute NVDA is no longer silent.
Instead NVDA reports that the link has no destination. (#14723)
- In Browse mode, NVDA will no longer incorrectly ignore focus moving to a parent or child control e.g. moving from a control to its parent list item or gridcell. (#14611)
- Note however that this fix only applies when the Automatically set focus to focusable elements" option in Browse Mode settings is turned off (which is the default).
-
-
- Fixes for Windows 11:
- NVDA can once again announce Notepad status bar contents. (#14573)
- Switching between tabs will announce the new tab name and position for Notepad and File Explorer. (#14587, #14388)
- NVDA will once again announce candidate items when entering text in languages such as Chinese and Japanese. (#14509)
- It is once again possible to open the Contributors and License items on the NVDA Help menu. (#14725)
-
- Microsoft Office fixes:
- When rapidly moving through cells in Excel, NVDA is now less likely to report the wrong cell or selection. (#14983, #12200, #12108)
- When landing on an Excel cell from outside a work sheet, braille and focus highlighter are no longer needlessly updated to the object that had focus previously. (#15136)
- NVDA no longer fails to announce focusing password fields in Microsoft Excel and Outlook. (#14839)
-
- For symbols which do not have a symbol description in the current locale, the default English symbol level will be used. (#14558, #14417)
- It is now possible to use the backslash character in the replacement field of a dictionaries entry, when the type is not set to regular expression. (#14556)
- In Windows 10 and 11 Calculator, a portable copy of NVDA will no longer do nothing or play error tones when entering expressions in standard calculator in compact overlay mode. (#14679)
- NVDA again recovers from many more situations such as applications that stop responding which previously caused it to freeze completely. (#14759)
- When forcing UIA support with certain terminal and consoles, a bug is fixed which caused a freeze and the log file to be spammed. (#14689)
- NVDA will no longer refuse to save the configuration after a configuration reset. (#13187)
- When running a temporary version from the launcher, NVDA will not mislead users into thinking they can save the configuration. (#14914)
- NVDA now generally responds slightly faster to commands and focus changes. (#14928)
- Displaying the OCR settings will not fail on some systems anymore. (#15017)
- Fix bug related to saving and loading the NVDA configuration, including switching synthesizers. (#14760)
- Fix bug causing text review "flick up" touch gesture to move pages rather than move to previous line. (#15127)
-
== Changes for Developers ==
Please refer to [the developer guide https://www.nvaccess.org/files/nvda/documentation/developerGuide.html#API] for information on NVDA's API deprecation and removal process.
- Suggested conventions have been added to the add-on manifest specification.
These are optional for NVDA compatibility, but are encouraged or required for submitting to the Add-on Store. (#14754)
- Use ``lowerCamelCase`` for the name field.
- Use ``<major>.<minor>.<patch>`` format for the version field (required for add-on datastore).
- Use ``https://`` as the schema for the url field (required for add-on datastore).
-
- Added a new extension point type called ``Chain``, which can be used to iterate over iterables returned by registered handlers. (#14531)
- Added the ``bdDetect.scanForDevices`` extension point.
Handlers can be registered that yield ``BrailleDisplayDriver/DeviceMatch`` pairs that don't fit in existing categories, like USB or Bluetooth. (#14531)
- Added extension point: ``synthDriverHandler.synthChanged``. (#14618)
- The NVDA Synth Settings Ring now caches available setting values the first time they're needed, rather than when loading the synthesizer. (#14704)
- You can now call the export method on a gesture map to export it to a dictionary.
This dictionary can be imported in another gesture by passing it either to the constructor of ``GlobalGestureMap`` or to the update method on an existing map. (#14582)
- ``hwIo.base.IoBase`` and its derivatives now have a new constructor parameter to take a ``hwIo.ioThread.IoThread``.
If not provided, the default thread is used. (#14627)
- ``hwIo.ioThread.IoThread`` now has a ``setWaitableTimer`` method to set a waitable timer using a python function.
Similarly, the new ``getCompletionRoutine`` method allows you to convert a python method into a completion routine safely. (#14627)
- ``offsets.OffsetsTextInfo._get_boundingRects`` should now always return ``List[locationHelper.rectLTWH]`` as expected for a subclass of ``textInfos.TextInfo``. (#12424)
- ``highlight-color`` is now a format field attribute. (#14610)
- NVDA should more accurately determine if a logged message is coming from NVDA core. (#14812)
- NVDA will no longer log inaccurate warnings or errors about deprecated appModules. (#14806)
- All NVDA extension points are now briefly described in a new, dedicated chapter in the Developer Guide. (#14648)
- ``scons checkpot`` will no longer check the ``userConfig`` subfolder anymore. (#14820)
- Translatable strings can now be defined with a singular and a plural form using ``ngettext`` and ``npgettext``. (#12445)
-
=== Deprecations ===
- Passing lambda functions to ``hwIo.ioThread.IoThread.queueAsApc`` is deprecated.
Instead, functions should be weakly referenceable. (#14627)
- Importing ``LPOVERLAPPED_COMPLETION_ROUTINE`` from ``hwIo.base`` is deprecated.
Instead import from ``hwIo.ioThread``. (#14627)
- ``IoThread.autoDeleteApcReference`` is deprecated.
It was introduced in NVDA 2023.1 and was never meant to be part of the public API.
Until removal, it behaves as a no-op, i.e. a context manager yielding nothing. (#14924)
- ``gui.MainFrame.onAddonsManagerCommand`` is deprecated, use ``gui.MainFrame.onAddonStoreCommand`` instead. (#13985)
- ``speechDictHandler.speechDictVars.speechDictsPath`` is deprecated, use ``NVDAState.WritePaths.speechDictsDir`` instead. (#15021)
- Importing ``voiceDictsPath`` and ``voiceDictsBackupPath`` from ``speechDictHandler.dictFormatUpgrade`` is deprecated.
Instead use ``WritePaths.voiceDictsDir`` and ``WritePaths.voiceDictsBackupDir`` from ``NVDAState``. (#15048)
- ``config.CONFIG_IN_LOCAL_APPDATA_SUBKEY`` is deprecated.
Instead use ``config.RegistryKey.CONFIG_IN_LOCAL_APPDATA_SUBKEY``. (#15049)
-
= 2023.1 =
A new option has been added, "Paragraph Style" in "Document Navigation".
This can be used with text editors that do not support paragraph navigation natively, such as Notepad and Notepad++.
There is a new global command to report the destination of a link, mapped to ``NVDA+k``.
Support for annotated web content (such as comments and footnotes) has improved.
Press ``NVDA+d`` to cycle through summaries when annotations are reported (e.g. "has comment, has footnote").
Tivomatic Caiku Albatross 46/80 braille displays are now supported.
Support for ARM64 and AMD64 versions of Windows has improved.
There are many bug fixes, notably Windows 11 fixes.
eSpeak, LibLouis, Sonic rate boost and Unicode CLDR have been updated.
There are new Georgian, Swahili (Kenya) and Chichewa (Malawi) braille tables.
Note:
- This release breaks compatibility with existing add-ons.
-
== New Features ==
- Microsoft Excel via UI Automation: Automatic reporting of column and row headers in tables. (#14228)
- Note: This is referring to tables formatted via the "Table" button on the Insert pane of the Ribbon.
"First Column" and "Header Row" in "Table Style Options" correspond to column and row headers respectively.
- This is not referring to screen reader specific headers via named ranges, which is currently not supported via UI Automation.
-
- An unassigned script has been added to toggle delayed character descriptions. (#14267)
- Added an experimental option to leverage the UIA notification support in Windows Terminal to report new or changed text in the terminal, resulting in improved stability and responsivity. (#13781)
- Consult the user guide for limitations of this experimental option.
-
- On Windows 11 ARM64, browse mode is now available in AMD64 apps such as Firefox, Google Chrome and 1Password. (#14397)
- A new option has been added, "Paragraph Style" in "Document Navigation".
This adds support for single line break (normal) and multi line break (block) paragraph navigation.
This can be used with text editors that do not support paragraph navigation natively, such as Notepad and Notepad++. (#13797)
- The presence of multiple annotations are now reported.
``NVDA+d`` now cycles through reporting the summary of each annotation target for origins with multiple annotation targets.
For example, when text has a comment and a footnote associated with it. (#14507, #14480)
- Added support for Tivomatic Caiku Albatross 46/80 braille displays. (#13045)
- New global command: Report link destination (``NVDA+k``).
Pressed once will speak/braille the destination of the link that is in the navigator object.
Pressing twice will show it in a window, for more detailed review. (#14583)
- New unmapped global command (Tools category): Report link destination in a window.
Same as pressing ``NVDA+k`` twice, but may be more useful for braille users. (#14583)
-
== Changes ==
- Updated LibLouis braille translator to [3.24.0 https://github.com/liblouis/liblouis/releases/tag/v3.24.0]. (#14436)
- Major updates to Hungarian, UEB, and Chinese bopomofo braille.
- Support for the Danish braille standard 2022.
- New braille tables for Georgian literary braille, Swahili (Kenya) and Chichewa (Malawi).
-
- Updated Sonic rate boost library to commit ``1d70513``. (#14180)
- CLDR has been updated to version 42.0. (#14273)
- eSpeak NG has been updated to 1.52-dev commit ``f520fecb``. (#14281, #14675)
- Fixed reporting of large numbers. (#14241)
-
- Java applications with controls using the selectable state will now announce when an item is not selected rather than when the item is selected. (#14336)
-
== Bug Fixes ==
- Windows 11 fixes:
- NVDA will announce search highlights when opening Start menu. (#13841)
- On ARM, x64 apps are no longer identified as ARM64 applications. (#14403)
- Clipboard history menu items such as "pin item" can be accessed. (#14508)
- In Windows 11 22H2 and newer, it is again possible to use mouse and touch interaction to interact with areas such as the system tray overflow window and "Open With" dialog. (#14538, #14539)
-
- Suggestions are reported when typing an @mention in in Microsoft Excel comments. (#13764)
- In the Google Chrome location bar, suggestion controls (switch to tab, remove suggestion etc) are now reported when selected. (#13522)
- When requesting formatting information, colors are now explicitly reported in Wordpad or log viewer, rather than only "Default color". (#13959)
- In Firefox, activating the "Show options" button on GitHub issue pages now works reliably. (#14269)
- The date picker controls in Outlook 2016 / 365 Advanced search dialog now report their label and value. (#12726)
- ARIA switch controls are now actually reported as switches in Firefox, Chrome and Edge, rather than checkboxes. (#11310)
- NVDA will automatically announce the sort state on an HTML table column header when changed by pressing an inner button. (#10890)
- A landmark or region's name is always automatically spoken when jumping inside from outside using quick navigation or focus in browse mode. (#13307)
- When beep or announce 'cap' for capitals is enabled with delayed character descriptions, NVDA no longer beeps or announces 'cap' twice. (#14239)
- Controls in tables in Java applications will now be announced more accurately by NVDA. (#14347)
- Some settings will no longer be unexpectedly different when used with multiple profiles. (#14170)
- The following settings have been addressed:
- Line indentation in Document formatting settings.
- Cell borders in doc formatting settings
- Show messages in braille settings
- Tether Braille in braille settings
-
- In some rare cases, these settings used in profiles may be unexpectedly modified when installing this version of NVDA.
- Please check these options in your profiles after upgrading NVDA to this version.
-
- Emojis should now be reported in more languages. (#14433)
- The presence of an annotation is no longer missing in braille for some elements. (#13815)
- Fixed an issue where config changes not save correctly when changing between a "Default" option and the value of the "Default" option. (#14133)
- When configuring NVDA there will always be at least one key defined as an NVDA key. (#14527)
- When accessing the NVDA menu via the notification area, NVDA will not suggest a pending update anymore when no update is available. (#14523)
- Remaining, elapsed and total time is now reported correctly for audio files over a day long in foobar2000. (#14127)
- In web browsers such as Chrome and Firefox, alerts such as file downloads are shown in braille in addition to being spoken. (#14562)
- Bug fixed when navigating to the first and last column in a table in Firefox (#14554)
- When NVDA is launched with ``--lang=Windows`` parameter, it is again possible to open NVDA's General settings dialog. (#14407)
- NVDA no longer fails to continue reading in Kindle for PC after turning the page. (#14390)
-
== Changes for Developers ==
Note: this is an Add-on API compatibility breaking release.
Add-ons will need to be re-tested and have their manifest updated.
Please refer to [the developer guide https://www.nvaccess.org/files/nvda/documentation/developerGuide.html#API] for information on NVDA's API deprecation and removal process.
- System tests should now pass when run locally on non-English systems. (#13362)
- In Windows 11 on ARM, x64 apps are no longer identified as ARM64 applications. (#14403)
- It is no longer necessary to use ``SearchField`` and ``SuggestionListItem`` ``UIA`` ``NVDAObjects`` in new UI Automation scenarios, where automatic reporting of search suggestions, and where typing has been exposed via UI Automation with the ``controllerFor`` pattern.
This functionality is now available generically via ``behaviours.EditableText`` and the base ``NVDAObject`` respectively. (#14222)
- The UIA debug logging category when enabled now produces significantly more logging for UIA event handlers and utilities. (#14256)
- NVDAHelper build standards updated. (#13072)
- Now uses the C++20 standard, was C++17.
- Now uses the ``/permissive-`` compiler flag which disables permissive behaviors, and sets the ``/Zc`` compiler options for strict conformance.
-
- Some plugin objects (e.g. drivers and add-ons) now have a more informative description in the NVDA python console. (#14463)
- NVDA can now be fully compiled with Visual Studio 2022, no longer requiring the Visual Studio 2019 build tools. (#14326)
- More detailed logging for NVDA freezes to aid debugging. (#14309)
- The singleton ``braille._BgThread`` class has been replaced with ``hwIo.ioThread.IoThread``. (#14130)
- A single instance ``hwIo.bgThread`` (in NVDA core) of this class provides background i/o for thread safe braille display drivers.
- This new class is not a singleton by design, add-on authors are encouraged to use their own instance when doing hardware i/o.
-
- The processor architecture for the computer can be queried from ``winVersion.WinVersion.processorArchitecture attribute.`` (#14439)
- New extension points have been added. (#14503)
- ``inputCore.decide_executeGesture``
- ``tones.decide_beep``
- ``nvwave.decide_playWaveFile``
- ``braille.pre_writeCells``
- ``braille.filter_displaySize``
- ``braille.decide_enabled``
- ``braille.displayChanged``
- ``braille.displaySizeChanged``
-
- It is possible to set useConfig to False on supported settings for a synthesizer driver. (#14601)
-
=== API Breaking Changes ===
These are breaking API changes.
Please open a GitHub issue if your Add-on has an issue with updating to the new API.
- The configuration specification has been altered, keys have been removed or modified:
- In ``[documentFormatting]`` section (#14233):
- ``reportLineIndentation`` stores an int value (0 to 3) instead of a boolean
- ``reportLineIndentationWithTones`` has been removed.
- ``reportBorderStyle`` and ``reportBorderColor`` have been removed and are replaced by ``reportCellBorders``.
-
- In ``[braille]`` section (#14233):
- ``noMessageTimeout`` has been removed, replaced by a value for ``showMessages``.
- ``messageTimeout`` cannot take the value 0 anymore, replaced by a value for ``showMessages``.
- ``autoTether`` has been removed; ``tetherTo`` can now take the value "auto" instead.
-
- In ``[keyboard]`` section (#14528):
- ``useCapsLockAsNVDAModifierKey``, ``useNumpadInsertAsNVDAModifierKey``, ``useExtendedInsertAsNVDAModifierKey`` have been removed.
They are replaced by ``NVDAModifierKeys``.
-
-
- The ``NVDAHelper.RemoteLoader64`` class has been removed with no replacement. (#14449)
- The following functions in ``winAPI.sessionTracking`` are removed with no replacement. (#14416, #14490)
- ``isWindowsLocked``
- ``handleSessionChange``
- ``unregister``
- ``register``
- ``isLockStateSuccessfullyTracked``
-
- It is no longer possible to enable/disable the braille handler by setting ``braille.handler.enabled``.
To disable the braille handler programatically, register a handler to ``braille.handler.decide_enabled``. (#14503)
- It is no longer possible to update the display size of the handler by setting ``braille.handler.displaySize``.
To update the displaySize programatically, register a handler to ``braille.handler.filter_displaySize``.
Refer to ``brailleViewer`` for an example on how to do this. (#14503)
- There have been changes to the usage of ``addonHandler.Addon.loadModule``. (#14481)
- ``loadModule`` now expects dot as a separator, rather than backslash.
For example "lib.example" instead of "lib\example".
- ``loadModule`` now raises an exception when a module can't be loaded or has errors, instead of silently returning ``None`` without giving information about the cause.
-
- The following symbols have been removed from ``appModules.foobar2000`` with no direct replacement. (#14570)
- ``statusBarTimes``
- ``parseIntervalToTimestamp``
- ``getOutputFormat``
- ``getParsingFormat``
-
- The following are no longer singletons - their get method has been removed.
Usage of ``Example.get()`` is now ``Example()``. (#14248)
- ``UIAHandler.customAnnotations.CustomAnnotationTypesCommon``
- ``UIAHandler.customProps.CustomPropertiesCommon``
- ``NVDAObjects.UIA.excel.ExcelCustomProperties``
- ``NVDAObjects.UIA.excel.ExcelCustomAnnotationTypes``
-
-
=== Deprecations ===
- ``NVDAObjects.UIA.winConsoleUIA.WinTerminalUIA`` is deprecated and usage is discouraged. (#14047)
- ``config.addConfigDirsToPythonPackagePath`` has been moved.
Use ``addonHandler.packaging.addDirsToPythonPackagePath`` instead. (#14350)
- ``braille.BrailleHandler.TETHER_*`` are deprecated.
Use ``configFlags.TetherTo.*.value`` instead. (#14233)
- ``utils.security.postSessionLockStateChanged`` is deprecated.
Use ``utils.security.post_sessionLockStateChanged`` instead. (#14486)
- ``NVDAObject.hasDetails``, ``NVDAObject.detailsSummary``, ``NVDAObject.detailsRole`` has been deprecated.
Use ``NVDAObject.annotations`` instead. (#14507)
- ``keyboardHandler.SUPPORTED_NVDA_MODIFIER_KEYS`` is deprecated with no direct replacement.
Consider using the class ``config.configFlags.NVDAKey`` instead. (#14528)
- ``gui.MainFrame.evaluateUpdatePendingUpdateMenuItemCommand`` has been deprecated.
Use ``gui.MainFrame.SysTrayIcon.evaluateUpdatePendingUpdateMenuItemCommand`` instead. (#14523)
-
= 2022.4 =
This release includes several new key commands, including table say all commands.
A "Quick Start Guide" section has been added to the User Guide.
There are also several bug fixes.
eSpeak has been updated and LibLouis has been updated.
There are new Chinese, Swedish, Luganda and Kinyarwanda braille tables.
== New Features ==
- Added a "Quick Start Guide" section to the User Guide. (#13934)
- Introduced a new command to check the keyboard shortcut of the current focus. (#13960)
- Desktop: ``shift+numpad2``.
- Laptop: ``NVDA+ctrl+shift+.``.
-
- Introduced new commands to move the review cursor by page where supported by the application. (#14021)
- Move to previous page:
- Desktop: ``NVDA+pageUp``.
- Laptop: ``NVDA+shift+pageUp``.
-
- Move to next page:
- Desktop: ``NVDA+pageDown``.
- Laptop: ``NVDA+shift+pageDown``.
-
-
- Added the following table commands. (#14070)
- Say all in column: ``NVDA+control+alt+downArrow``
- Say all in row: ``NVDA+control+alt+rightArrow``
- Read entire column: ``NVDA+control+alt+upArrow``
- Read entire row: ``NVDA+control+alt+leftArrow``
-
- Microsoft Excel via UI Automation: NVDA now announces when moving out of a table within a spreadsheet. (#14165)
- Reporting table headers can now be configured separately for rows and columns. (#14075)
-
== Changes ==
- eSpeak NG has been updated to 1.52-dev commit ``735ecdb8``. (#14060, #14079, #14118, #14203)
- Fixed reporting of Latin characters when using Mandarin. (#12952, #13572, #14197)
-
- Updated LibLouis braille translator to [3.23.0 https://github.com/liblouis/liblouis/releases/tag/v3.23.0]. (#14112)
- Added braille tables:
- Chinese common braille (simplified Chinese characters)
- Kinyarwanda literary braille
- Luganda literary braille
- Swedish uncontracted braille
- Swedish partially contracted braille
- Swedish contracted braille
- Chinese (China, Mandarin) Current Braille System (no tones) (#14138)
-
- NVDA now includes the architecture of the operating system as part of user statistics tracking. (#14019)
-
== Bug Fixes ==
- When updating NVDA using the Windows Package Manager CLI (aka winget), a released version of NVDA is no longer always treated as newer than whatever alpha version is installed. (#12469)
- NVDA will now correctly announce Group boxes in Java applications. (#13962)
- Caret properly follows spoken text during "say all" in applications such as Bookworm, WordPad, or the NVDA log viewer. (#13420, #9179)
- In programs using UI Automation, partially checked checkboxes will be reported correctly. (#13975)
- Improved performance and stability in Microsoft Visual Studio, Windows Terminal, and other UI Automation based applications. (#11077, #11209)
- These fixes apply to Windows 11 Sun Valley 2 (version 22H2) and later.
- Selective registration for UI Automation events and property changes now enabled by default.
-
- Text reporting, Braille output, and password suppression now work as expected in the embedded Windows Terminal control in Visual Studio 2022. (#14194)
- NVDA is now DPI aware when using multiple monitors.
There are several fixes for using a DPI setting higher than 100% or multiple monitors.
Issues may still exist with versions of Windows older than Windows 10 1809.
For these fixes to work, applications which NVDA interacts with also need to be DPI aware.
Note there are still known issues with Chrome and Edge. (#13254)
- Visual highlighting frames should now be correctly placed in most applications. (#13370, #3875, #12070)
- Touch screen interaction should now be accurate for most applications. (#7083)
- Mouse tracking should now work for most applications. (#6722)
-
- Orientation state (landscape/portrait) changes are now correctly ignored when there is no change (e.g. monitor changes). (#14035)
- NVDA will announce dragging items on screen in places such as rearranging Windows 10 Start menu tiles and virtual desktops in Windows 11. (#12271, #14081)
- In advanced settings, "Play a sound for logged errors" option is now correctly restored to its default value when pressing the "Restore defaults" button. (#14149)
- NVDA can now select text using the ``NVDA+f10`` keyboard shortcut on Java applications. (#14163)
- NVDA will no longer get stuck in a menu when arrowing up and down threaded conversations in Microsoft Teams. (#14355)
-
== Changes for Developers ==
Please refer to [the developer guide https://www.nvaccess.org/files/nvda/documentation/developerGuide.html#API] for information on NVDA's API deprecation and removal process.
- The [NVDA API Announcement mailing list https://groups.google.com/a/nvaccess.org/g/nvda-api/about] was created. (#13999)
- NVDA no longer processes ``textChange`` events for most UI Automation applications due to their extreme negative performance impact. (#11002, #14067)
-
=== Deprecations ===
- ``core.post_windowMessageReceipt`` is deprecated, use ``winAPI.messageWindow.pre_handleWindowMessage`` instead.
- ``winKernel.SYSTEM_POWER_STATUS`` is deprecated and usage is discouraged, this has been moved to ``winAPI._powerTracking.SystemPowerStatus``.
- ``winUser.SM_*`` constants are deprecated, use ``winAPI.winUser.constants.SystemMetrics`` instead.
-
= 2022.3.3 =
This is a minor release to fix issues with 2022.3.2, 2022.3.1 and 2022.3.
This also addresses a security issue.
== Security Fixes ==
- Prevents possible system access (e.g. NVDA Python console) for unauthenticated users.
([GHSA-fpwc-2gxx-j9v7 https://github.com/nvaccess/nvda/security/advisories/GHSA-fpwc-2gxx-j9v7])
-
== Bug Fixes ==
- Fixed bug where if NVDA freezes when locking, NVDA will allow access to the users desktop while on the Windows lock screen. (#14416)
- Fixed bug where if NVDA freezes when locking, NVDA will not behave correctly, as if the device was still locked. (#14416)
- Fixed accessibility issues with the Windows "forgot my PIN" process and Windows update/install experience. (#14368)
- Fixed bug when trying to install NVDA in some Windows environments, e.g. Windows Server. (#14379)
-
== Changes for Developers ==
=== Deprecations ===
- ``utils.security.isObjectAboveLockScreen(obj)`` is deprecated, instead use ``obj.isBelowLockScreen``. (#14416)
- The following functions in ``winAPI.sessionTracking`` are deprecated for removal in 2023.1. (#14416)
- ``isWindowsLocked``
- ``handleSessionChange``
- ``unregister``
- ``register``
- ``isLockStateSuccessfullyTracked``
-
-
= 2022.3.2 =
This is a minor release to fix regressions with 2022.3.1 and address a security issue.
== Security Fixes ==
- Prevents possible system level access for unauthenticated users.
([GHSA-3jj9-295f-h69w https://github.com/nvaccess/nvda/security/advisories/GHSA-3jj9-295f-h69w])
-
== Bug Fixes ==
- Fixes a regression from 2022.3.1 where certain functionality was disabled on secure screens. (#14286)
- Fixes a regression from 2022.3.1 where certain functionality was disabled after sign-in, if NVDA started on the lock screen. (#14301)
-
= 2022.3.1 =
This is a minor release to fix several security issues.
Please responsibly disclose security issues to info@nvaccess.org.
== Security Fixes ==
- Fixed exploit where it was possible to elevate from user to system privileges.
([GHSA-q7c2-pgqm-vvw5 https://github.com/nvaccess/nvda/security/advisories/GHSA-q7c2-pgqm-vvw5])
- Fixed a security issue allowing access to the python console on the lock screen via a race condition for NVDA startup.
([GHSA-72mj-mqhj-qh4w https://github.com/nvaccess/nvda/security/advisories/GHSA-72mj-mqhj-qh4w])
- Fixed issue where speech viewer text is cached when locking Windows.
([GHSA-grvr-j2h8-3qm4 https://github.com/nvaccess/nvda/security/advisories/GHSA-grvr-j2h8-3qm4])
-
== Bug Fixes ==
- Prevent an unauthenticated user from updating settings for speech and Braille viewer on the lock screen. ([GHSA-grvr-j2h8-3qm4 https://github.com/nvaccess/nvda/security/advisories/GHSA-grvr-j2h8-3qm4])
-
= 2022.3 =
A significant amount of this release was contributed by the NVDA development community.
This includes delayed character descriptions and improved Windows Console support.
This release also includes several bug fixes.
Notably, up-to-date versions of Adobe Acrobat/Reader will no longer crash when reading a PDF document.
eSpeak has been updated, which introduces 3 new languages: Belarusian, Luxembourgish and Totontepec Mixe.
== New Features ==
- In the Windows Console Host used by Command Prompt, PowerShell, and the Windows Subsystem for Linux on Windows 11 version 22H2 (Sun Valley 2) and later:
- Vastly improved performance and stability. (#10964)
- When pressing ``control+f`` to find text, the review cursor position is updated to follow the found term. (#11172)
- Reporting of typed text that does not appear on-screen (such as passwords) is disabled by default.
It can be re-enabled in NVDA's advanced settings panel. (#11554)
- Text that has scrolled offscreen can be reviewed without scrolling the console window. (#12669)
- More detailed text formatting information is available. ([microsoft/terminal PR 10336 https://github.com/microsoft/terminal/pull/10336])
-
- A new Speech option has been added to read character descriptions after a delay. (#13509)
- A new Braille option has been added to determine if scrolling the display forward/back should interrupt speech. (#2124)
-
== Changes ==
- eSpeak NG has been updated to 1.52-dev commit ``9de65fcb``. (#13295)
- Added languages:
- Belarusian
- Luxembourgish
- Totontepec Mixe
-
-
- When using UI Automation to access Microsoft Excel spreadsheet controls, NVDA is now able to report when a cell is merged. (#12843)
- Instead of reporting "has details" the purpose of details is included where possible, for example "has comment". (#13649)
- The installation size of NVDA is now shown in Windows Programs and Feature section. (#13909)
-
== Bug Fixes ==
- Adobe Acrobat / Reader 64 bit will no longer crash when reading a PDF document. (#12920)
- Note that the most up to date version of Adobe Acrobat / Reader is also required to avoid the crash.
-
- Font size measurements are now translatable in NVDA. (#13573)
- Ignore Java Access Bridge events where no window handle can be found for Java applications.
This will improve performance for some Java applications including IntelliJ IDEA. (#13039)
- Announcement of selected cells for LibreOffice Calc is more efficient and no longer results in a Calc freeze when many cells are selected. (#13232)
- When running under a different user, Microsoft Edge is no longer inaccessible. (#13032)
- When rate boost is off, eSpeak's rate does not drop anymore between rates 99% and 100%. (#13876)
- Fix bug which allowed 2 Input Gestures dialogs to open. (#13854)
-
== Changes for Developers ==
- Updated Comtypes to version 1.1.11. (#12953)
- In builds of Windows Console (``conhost.exe``) with an NVDA API level of 2 (``FORMATTED``) or greater, such as those included with Windows 11 version 22H2 (Sun Valley 2), UI Automation is now used by default. (#10964)
- This can be overridden by changing the "Windows Console support" setting in NVDA's advanced settings panel.
- To find your Windows Console's NVDA API level, set "Windows Console support" to "UIA when available", then check the NVDA+F1 log opened from a running Windows Console instance.
-
- The Chromium virtual buffer is now loaded even when the document object has the MSAA ``STATE_SYSTEM_BUSY`` exposed via IA2. (#13306)
- A config spec type ``featureFlag`` has been created for use with experimental features in NVDA. See ``devDocs/featureFlag.md`` for more information. (#13859)
-
=== Deprecations ===
There are no deprecations proposed in 2022.3.
= 2022.2.4 =
This is a patch release to fix a security issue.
== Bug Fixes ==
- Fixed an exploit where it was possible to open the NVDA python console via the log viewer on the lock screen.
([GHSA-585m-rpvv-93qg https://github.com/nvaccess/nvda/security/advisories/GHSA-585m-rpvv-93qg])
-
= 2022.2.3 =
This is a patch release to fix an accidental API breakage introduced in 2022.2.1.
== Bug Fixes ==
- Fixed a bug where NVDA did not announce "Secure Desktop" when entering a secure desktop.
This caused NVDA remote to not recognize secure desktops. (#14094)
-
= 2022.2.2 =
This is a patch release to fix a bug introduced in 2022.2.1 with input gestures.
== Bug Fixes ==
- Fixed a bug where input gestures didn't always work. (#14065)
-
= 2022.2.1 =
This is a minor release to fix a security issue.
Please responsibly disclose security issues to info@nvaccess.org.
== Security Fixes ==
- Fixed exploit where it was possible to run a python console from the lockscreen. (GHSA-rmq3-vvhq-gp32)
- Fixed exploit where it was possible to escape the lockscreen using object navigation. (GHSA-rmq3-vvhq-gp32)
-
== Changes for Developers ==
=== Deprecations ===
These deprecations are currently not scheduled for removal.
The deprecated aliases will remain until further notice.
Please test the new API and provide feedback.
For add-on authors, please open a GitHub issue if these changes stop the API from meeting your needs.
- ``appModules.lockapp.LockAppObject`` should be replaced with ``NVDAObjects.lockscreen.LockScreenObject``. (GHSA-rmq3-vvhq-gp32)
- ``appModules.lockapp.AppModule.SAFE_SCRIPTS`` should be replaced with ``utils.security.getSafeScripts()``. (GHSA-rmq3-vvhq-gp32)
-
= 2022.2 =
This release includes many bug fixes.
Notably, there are significant improvements for Java based applications, braille displays and Windows features.