Added a setting panel and some fixes.

README.md

@@ -4,18 +4,60 @@
 * NVDA compatibility: 2018.3 and beyond
 * Download [development version][2]
 
-This add-on improves the use of the Windows Magnifier with NVDA.
+This add-on improves the use of Windows Magnifier with NVDA.
 
 
 ## Features
 
+* Allows to report the result of some native Magnifier keyboard commands.
+* Allows to reduces the cases where table navigation command conflict with Magnifier's commands.
 * Adds some keyboard shortcuts to toggle various Magnifier options.
-* Reports the result of some native Magnifier keyboard commands.
-* Reduces the cases where table navigation command conflict with Magnifier's commands.
+
+
+## Settings
+
+The setting panel of Windows Magnifier extension allows to configure how NVDA reacts to native Windows Magnifier commands.
+You may want to have more or less commands reported according to what you are able to see.
+This panel may be opened choosing Preferences -> Settings in the NVDA menu and then selecting the Windows Magnifier category in the Settings window.
+The keyboard shortcut NVDA+Windows+O then O also allows to open this settings panel directly.
+
+The panel contains the following options:
+
+* Report view moves: controls what is reported when you move the view with Control+Alt+Arrows commands. The three options are:
+
+    * Off: Nothing is reported
+    * With speech: a speech message indicate the position of the zoomed view on the dimension the view is being moved.
+    * With tones: a tone is played and its pitch indicates the position of the zoomed view on the dimension the view is being moved.
+
+* Report turn on or off:
+  If checked, the Magnifier's state is reported when you use Windows++ or Windows+Escape commands to turn it on or off.
+* Report zoom:
+  If checked, the Magnifier's zoom level is reported when you use Windows++ or Windows+- zoom commands.
+* Report color inversion:
+  If checked, the color inversion state is reported when you use the control+shift+I toggle command.
+* Report view change:
+  If checked, the view type is reported when you use a command that changes the view type (Control+Alt+M, Control+Alt+F, Control+Alt+D, Control+Alt+L)
+* Report lens or docked window resizing:
+  If checked, a message is reported when you use the resizing commands (Control+Shift+Arrows).
+  In docked window mode, the height or the width is reported.
+  In lens mode, the new dimension cannot be reported for now.
+* In documents and list views, pass control+alt+arrows shortcuts to Windows Magnifier:
+  There are three possible choices:  
+
+    * Never: The command is not passed to Windows Magnifier and standard NVDA table navigation can operate.
+      When used in documents out of a table, Control+Alt+Arrow commands report a "Not in a table" error message.
+      This is the standard behaviour of NVDA without this add-on.
+    * Only when not in table: In table or in list views, Control+Alt+Arrow commands perform standard table navigation.
+      When used in documents out of a table, Control+Alt+Arrow commands perform standard Magnifier view move commands.
+      If you still want to move Windows Magnifier view while in table or in list view, you will need to press NVDA+F2 before using Control+Alt+Arrow commands.
+      This option is the best compromise if you want to use Control+Alt+Arrow for both Magnifier and table navigation.
+    * Always: Control+Alt+Arrow commands moves the Magnifier's view in any case.
+      This option may be useful if you do not use Control+Alt+Arrow to navigate in table, e.g. because you have changed table navigation shortcuts in NVDA or because you exclusively use [Easy table navigator][5] add-on for table navigation.
 
 
 ## Commands added by this add-on
 
+In addition to native Magnifier commands, this add-on provide additional commands that allow to control Magnifier's options without opening its configuration page.
 All the commands added to control Magnifier options are accessible through the Magnifier layer command NVDA+Windows+O:
 
 * NVDA+Windows+O then C: Toggles on or off caret tracking.
@@ -24,15 +66,19 @@ All the commands added to control Magnifier options are accessible through the M
 * NVDA+Windows+O then T: Toggles on or off tracking globally.
 * NVDA+Windows+O then S: Toggles on or off smoothing.
 * NVDA+Windows+O then R: Switches between mouse tracking modes (within the edge of the screen or centered on the screen); this feature is only available on Windows 10 build 17643 or higher.
+* NVDA+Windows+O then X: Switches between text cursor tracking modes (within the edge of the screen or centered on the screen); this feature is only available on Windows 10 build 18894 or higher.
 * NVDA+Windows+O then V: Moves the mouse cursor in the center of the magnified view (command available in full screen view only).
+* NVDA+Windows+O then O: Opens Windows Magnifier add-on settings.
 * NVDA+Windows+O then H: Displays help on Magnifier layer commands.
 
-There is no default gesture for each command, but you can attribute one normally in the input gesture dialog if you wish. The same way, You can also modify or delete the Magnifier layer access gesture (NVDA+Windows+O). Yet, you cannot modify the shortcut key of the Magnifier layer sub-commands.
+There is no default direct gesture for each command, but you can attribute one normally in the input gesture dialog if you wish.
+The same way, You can also modify or delete the Magnifier layer access gesture (NVDA+Windows+O).
+Yet, you cannot modify the shortcut key of the Magnifier layer sub-commands.
 
 
 ## Magnifier's native commands
 
-The result of the following Magnifier native commands is vocalized by this add-on:
+The result of the following Magnifier native commands may be reported by this add-on, according to its configuration:
 
 * Start Magnifier: Windows++ (on alpha-numeric keyboard or on numpad)
 * Quit Magnifier: Windows+Escape
@@ -43,16 +89,11 @@ The result of the following Magnifier native commands is vocalized by this add-o
 * Select the full screen view: Control+Alt+F
 * Select the lens view: Control+Alt+L
 * Cycle through the three view types: Control+Alt+M
-* Resize the lens with the keyboard: Shift+Alt+Left/Right/Up/DownArrow
-
-The following keyboard shortcuts are also native Magnifier commands: Control+Alt+LeftArrow, Control+Alt+RightArrow, Control+Alt+UpArrow, Control+Alt+DownArrow. They are used to move the magnified view respectively to the left, the right, up or down. Since they are also table navigation commands in NVDA, they are managed as follows by this add-on:
-
-* If the focus or the virtual cursor is not located in a table or a list view, the Magnifier command is executed.
-* If the focus or the virtual cursor is located in a table or a list view, the NVDA table navigation command is executed.
-* If you still want to move the Magnifier's view while being in a table or a list view, you will need to press NVDA+F2 before pressing control+alt+arrowKey.
+* Resize the lens with the keyboard: Shift+Alt+Left/Right/Up/DownArrow.
+  Note: although this withdrawal does not seem to be documented, this shortcut seems to have been withdrawn in recent Windows versions such as Windows 2004.
+* Move the magnified view: Control+Alt+Arrows
 
-
-At last, here is a list of other Magnifier native commands, just for information:
+Here is also a list of other Magnifier native commands, just for information:
 
 * Control+Alt+mouseScrollWheel: Zooms in and out using the mouse scroll wheel.
 * Control+Windows+M: Opens the Magnifier's settings window.
@@ -64,17 +105,23 @@ None of the Magnifier native commands can be modified.
 
 ## Notes
 
-* For computers equipped with an Intel graphic card, control+alt+arrow (left/right/up/down) are also shortcuts to modify the orientation of the screen. These shortcut are enabled by default and conflict with Windows Magnifiers shortcuts to move the view. You will need to disable them to be able to use them for the Magnifier. They can be disabled in the Intel control panel or in the Intel menu present in the system tray.
-* Alt+Shift+Arrow are Windows Magnifier shortcuts to resize the magnified view (lens or docked). When Magnifier is active (even in full screen mode), these shortcuts are captured by Magnifier and cannot be passed to the application, even if you press NVDA+F2 before. To use these shortcuts in the current application, you need to quit the Magnifier (Windows+Escape) and re-open it after (Windows++). For example in MS word, to decrease title level:
-
+* For computers equipped with an Intel graphic card, control+alt+arrow (left/right/up/down) are also shortcuts to modify the orientation of the screen.
+  These shortcut are enabled by default and conflict with Windows Magnifiers shortcuts to move the view.
+  You will need to disable them to be able to use them for the Magnifier.
+  They can be disabled in the Intel control panel or in the Intel menu present in the system tray.
+* Depending on your Windows version, Alt+Shift+Arrow are Windows Magnifier shortcuts to resize the magnified view (lens or docked).
+  When Magnifier is active (even in full screen mode), these shortcuts are captured by Magnifier and cannot be passed to the application, even if you press NVDA+F2 before.
+  To use these shortcuts in the current application, you need to quit the Magnifier (Windows+Escape) and re-open it after (Windows++).
+  For example in MS word, to decrease title level:
+
     * Press Windows+Escape to quit Magnifier.
     * Press Alt+Shift+RightArrow to decrease current title level.
     * Press Windows++ to re-open the Magnifier.
 
 * For more information about Windows Magnifier's features and shortcuts, you may want to consult the following pages:
 
-    * [Use Magnifier to make things on the screen easier to see](https://support.microsoft.com/en-us/help/11542/windows-use-magnifier-to-make-things-easier-to-see)
-    * [Windows keyboard shortcuts for accessibility](https://support.microsoft.com/en-us/help/13810)
+    * [Use Magnifier to make things on the screen easier to see][3]
+    * [Windows keyboard shortcuts for accessibility][4]
 
 
 ## Change log
@@ -84,3 +131,7 @@ None of the Magnifier native commands can be modified.
 * Initial release.
 
 [2]: https://addons.nvda-project.org/files/get.php?file=winmag-dev
+[3]: https://support.microsoft.com/en-us/help/11542/windows-use-magnifier-to-make-things-easier-to-see
+[4]: https://support.microsoft.com/en-us/help/13810
+[5]: https://addons.nvda-project.org/addons/easyTableNavigator.en.html
+