Add a graphical user interface for the vision framework by LeonarddeR · Pull Request #10082 · nvaccess/nvda

LeonarddeR · 2019-08-13T10:49:24Z

Link to issue number:

Follow up of #9064
Closes #971

Summary of the issue:

#9064 introduced the vision framework without a graphical user interface.

Description of how this pull request fixes the issue:

Added a new vision panel to the settings dialog. Vision enhancement providers can provide their own gui panel class to create a customized gui. Otherwise, they can rely on the supportedSettings property to be implemented on the provider.

Testing performed:

Tested that providers load and unload and that settings can be changed using the gui.

Known issues with pull request:

Providers load and unload directly when checking and unchecking check boxes
No user guide changes yet. I'd like to agree about the UX before doing that.

Change log entry:

New features
- Added screen highlight functionality to NVDA. (Visual highlight of focus, browse or caret location being read. #971, Abstract vision framework with included support for focus, navigator object and browse mode caret highlighting #9064)
  - The NVDA Highlighter is able to highlight the focus, navigator object and browse mode caret position and can be enabled and configured from the new vision category in NVDA's settings dialog.
  - If you have the focus highlight add-on installed, you are encouraged to reconsider its installation. Note that that add-on can still be used as long as the built-in highlighter is disabled.

There's also a wording issue in the changes for developers setting:

A framework allowing developers to create vision enhancement providers; > please add the word Àdded to the start of that sentence. You could also consider updating this entry to point at the new vision category in the gui.

LeonarddeR · 2019-08-13T10:51:18Z

@nishimotz I was thinking about your focus highlight add-on while looking at the changelog entry. Are you intending to discontinue your add-on, or will you rebase it onto the new framework? I think there are still some implementation differences that might cause people to prefer one or the other.
Of course, you're also welcome to extend on the current highlighter in core. One thing I'd like to make configurable at some point is the color and thickness of the highlights.

feerrenrut

What is your plan for the user guide? Could you update it in this PR, covering the vision panel and focus highlight. Then on the screen curtain PR add that?

I hope you don't mind, I have pushed a commit that addresses a few layout issues.

LeonarddeR

I'll do the user guide as part of this. Have two questions about your change

feerrenrut · 2019-08-22T17:59:21Z

Overall, I am pretty happy with the default colors for focus highlight. But I might adjust them to have some transparency in a later PR. When they are over text, it can obscure adjacent text.

nishimotz · 2019-08-23T08:25:33Z

We should consider people who have difficulty distinguishing between red and green colors.
Since the Focus Highlight decided the color first,
I have added the distinction according to the line type later.

Typo: vvision > vision BNrowse mode caret is shown using a rectangle, not a single line

…ning for the screen curtain

LeonarddeR · 2019-09-06T15:12:02Z

@feerrenrut: This is ready for another review. I think everything from 641ccdc is new.

feerrenrut · 2019-09-06T15:45:25Z

I'm seeing some unexpected changes in the diff ie libluis. I'll review the user guide to start with.

dpy013 · 2019-09-08T21:45:40Z

Current pr build failed
Can it be fixed?
thank

LeonarddeR · 2019-09-09T06:14:36Z

@dingpengyu Failed appveyor builds are pretty likely to be acted upon pretty soon after they fail.

Co-Authored-By: Reef Turner <feerrenrut@users.noreply.github.com>

…tion

dpy013 · 2019-09-09T22:53:55Z

@dingpengyu Failed appveyor builds are pretty likely to be acted upon pretty soon after they fail.
problem solved
thank

JulienCochuyt · 2019-09-13T12:00:23Z

I was afraid that the Highlighter could suffer from #10211, that is not being functional while the Windows Magnifier is turned on.
It does not.
Thanks to the GUI implemented in this PR, I could successfully test the Highlighter with Windows Magnifier on and everything seems to work as expected.

LeonarddeR · 2019-09-13T12:49:18Z

Note that this gui is still a prototype, it will have a revisit by @feerrenrut

dpy013 · 2019-10-24T04:39:30Z

Will pr currently merge 2019.3?

dpy013 · 2019-10-25T09:46:42Z

hi @LeonarddeR
This branch has conflicts that must be resolved
Conflicting files
source/visionEnhancementProviders/screenCurtain.py
thank

dpy013 · 2019-11-14T08:47:27Z

hi This branch has conflicts that must be resolved
Conflicting files
source/globalCommands.py
thanks

LeonarddeR

hi This branch has conflicts that must be resolved

This is a known issue. This work is a continuous work in progress.

It was introduced with this feature, but is not used.

This was introduced with this feature. Not being used by the framework, and seems likely to mislead.

- class AutoSettings - data class ProviderInfo This is more consistent with class DriverSettings It communicates the intended usage of the string better.

LeonarddeR

This looks awesome, thanks @feerrenrut

feerrenrut · 2019-11-18T15:08:42Z

This work was delivered via commit 46c5606

nishimotz · 2019-11-24T06:30:11Z

Thank you for beautifully reimplementing my work.
I would like to ask from the translation standpoint.
Is the Browse Mode Cursor and the Review Cursor technically different?

ruifontes · 2019-11-24T15:01:41Z

Browse cursor is the one used in browse mode in the web navigators, PDF files and so on... Review cursor is used on object navigation and screen review... Rui Fontes Às 06:30 de 24/11/2019, Takuya Nishimoto escreveu:

…

Thank you for beautifully reimplementing my work. I would like to ask from the translation standpoint. Is the Browse Mode Cursor and the Review Cursor technically different? — You are receiving this because you are subscribed to this thread. Reply to this email directly, view it on GitHub <#10082?email_source=notifications&email_token=ADZAPRU5BLY4X4D5ART7M5LQVINPTA5CNFSM4ILJQPCKYY3PNVWWK3TUL52HS4DFVREXG43VMVBW63LNMVXHJKTDN5WW2ZLOORPWSZGOEFAEYWA#issuecomment-557861976>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/ADZAPRTMFQIUPNP7Y7FPXDTQVINPTANCNFSM4ILJQPCA>.

nishimotz · 2019-11-25T00:45:20Z

Thank you for the suggestion.
Just confirmed that "Highlight browse mode cursor" does not work with review cursor.

STR:

Open NVDA menu and select Configuration Profile dialog.
Press NVDA+right arrow key (laptop layout)
The move of review cursor can be confirmed. However, the yellow rectangle is not available.

I understand the description regarding the vision framework is correct.

So far, "browse mode cursor" is used only in the Content Recognition chapter of the User Guide and almost undocumented.

LeonarddeR · 2019-11-25T06:34:00Z

The browse mode caret is the virtual caret used in all browse mode situations, so also in browsers. It isn't the same as the review cursor and therefore indeed, the review cursor position isn't shown. Most important reason of this is that we don't always have the physical position of the review cursor, so we can't reliably show it.

LeonarddeR requested a review from feerrenrut August 13, 2019 10:49

feerrenrut mentioned this pull request Aug 13, 2019

Visual highlight of focus, browse or caret location being read. #971

Closed

LeonarddeR mentioned this pull request Aug 13, 2019

Vision framework: add a screen curtain #10090

Merged

1 task

feerrenrut added this to the 2019.3 milestone Aug 14, 2019

feerrenrut approved these changes Aug 22, 2019

View reviewed changes

Comment thread source/gui/settingsDialogs.py Outdated

LeonarddeR commented Aug 22, 2019

View reviewed changes

Comment thread source/gui/settingsDialogs.py Outdated

Comment thread source/gui/settingsDialogs.py Outdated

LeonarddeR requested a review from feerrenrut August 22, 2019 14:24

Leonard de Ruijter and others added 5 commits September 6, 2019 16:34

Add a graphical user interface for the vision framework

3a83cf8

Layout adjustments to vision framework

f76da24

Update user guide

641ccdc

Typo: vvision > vision BNrowse mode caret is shown using a rectangle, not a single line

Many gui and framework updates and improvements, including a load war…

1816b28

…ning for the screen curtain

Fix last (linting) issues

5a8de04

feerrenrut suggested changes Sep 6, 2019

View reviewed changes

Comment thread user_docs/en/userGuide.t2t Outdated

Comment thread user_docs/en/userGuide.t2t Outdated

Comment thread user_docs/en/userGuide.t2t Outdated

Comment thread user_docs/en/userGuide.t2t Outdated

LeonarddeR and others added 4 commits September 9, 2019 08:48

Apply user guide suggestions from code review

99ea075

Co-Authored-By: Reef Turner <feerrenrut@users.noreply.github.com>

Revert accidental change to liblouis submodule

985dc51

Fix translator comments

a419254

Apply additional review action for the highlighter user guide descrip…

3fdc434

…tion

LeonarddeR added the BabbageWork Pull requests filed on behalf of Babbage B.V. label Oct 8, 2019

LeonarddeR commented Nov 14, 2019

View reviewed changes

Comment thread source/autoSettingsUtils/utils.py

Comment thread source/gui/settingsDialogs.py

Comment thread source/vision/providerBase.py

Leonard de Ruijter added 3 commits November 14, 2019 10:35

Update user guide

7ebc511

Fix square brackets

ef9b4fa

User docs: visual aide> visual aid

a9f179a

LeonarddeR commented Nov 14, 2019

View reviewed changes

Comment thread source/gui/settingsDialogs.py Outdated

feerrenrut added 6 commits November 14, 2019 15:32

Fix spelling: aides vs aids

01dfbab

Handle providers with no options with auto gui

0a09c26

Remove saveSettings param from Driver.terminate

77ac29a

It was introduced with this feature, but is not used.

Remove preInitSettings property

c4b8492

This was introduced with this feature. Not being used by the framework, and seems likely to mislead.

Rename getTranalatedName -> getDisplayName

e31e3a2

- class AutoSettings - data class ProviderInfo This is more consistent with class DriverSettings It communicates the intended usage of the string better.

Fix consistency of imports.

4daa3de

LeonarddeR commented Nov 18, 2019

View reviewed changes

feerrenrut closed this in 46c5606 Nov 18, 2019

This was referenced Nov 18, 2019

Change how enabled providers are saved in the config spec #10500

Merged

Avoid Screen Curtain error on Windows 7 #10503

Merged

VisionProviderSubPanel_Settings.hasOptions now returns False based on supportedSettings instead of sizerDict #10504

Merged

feerrenrut added a commit that referenced this pull request Nov 19, 2019

Update changes file for PR #10082

6e503c9

feerrenrut mentioned this pull request Nov 19, 2019

Update changes file for PR #10082 #10507

Merged

feerrenrut added a commit that referenced this pull request Nov 19, 2019

Update changes file for PR #10082

e7b61dc

This was referenced Nov 20, 2019

Vision framework fix-up: when changing a synthesizer, make the setting controls reflect the new synth #10519

Merged

Convert several classes to dataclass #10527

Closed

This was referenced Mar 14, 2021

Use DriverSetting classes from autoSettingUtils rather than from driverHandler #12168

Merged

Deprecations for 2021.1 #12123

Closed

seanbudd added the deprecated/2021.1 Label used to track deprecations due for removal in the 2021.1 release label Mar 16, 2021

Uh oh!

Conversation

LeonarddeR commented Aug 13, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Link to issue number:

Summary of the issue:

Description of how this pull request fixes the issue:

Testing performed:

Known issues with pull request:

Change log entry:

Uh oh!

LeonarddeR commented Aug 13, 2019

Uh oh!

feerrenrut left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

LeonarddeR left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

feerrenrut commented Aug 22, 2019

Uh oh!

nishimotz commented Aug 23, 2019

Uh oh!

LeonarddeR commented Sep 6, 2019

Uh oh!

feerrenrut commented Sep 6, 2019

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

dpy013 commented Sep 8, 2019

Uh oh!

LeonarddeR commented Sep 9, 2019

Uh oh!

dpy013 commented Sep 9, 2019

Uh oh!

JulienCochuyt commented Sep 13, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

LeonarddeR commented Sep 13, 2019 via email

Uh oh!

dpy013 commented Oct 24, 2019

Uh oh!

dpy013 commented Oct 25, 2019

Uh oh!

dpy013 commented Nov 14, 2019

Uh oh!

LeonarddeR left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

LeonarddeR left a comment

Choose a reason for hiding this comment

Uh oh!

feerrenrut commented Nov 18, 2019

Uh oh!

nishimotz commented Nov 24, 2019

Uh oh!

ruifontes commented Nov 24, 2019 via email

Uh oh!

nishimotz commented Nov 25, 2019

Uh oh!

LeonarddeR commented Nov 25, 2019 via email

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

8 participants

LeonarddeR commented Aug 13, 2019 •

edited

Loading

JulienCochuyt commented Sep 13, 2019 •

edited

Loading