Add accessibilityPrivate.onMagnifierBoundsChanged API

(For use in Accessibility Common, to enable Magnifier Panning Improvements including Keyboard Panning)

AX-Relnotes: n/a
Change-Id: I751e8b319488c4dcd0d9e28775a3990ef93cdf10
Reviewed-on: https://chromium-review.googlesource.com/c/chromium/src/+/2491601
Commit-Queue: Josiah Krutz <josiahk@google.com>
Reviewed-by: Xiyuan Xia <xiyuan@chromium.org>
Reviewed-by: David Tseng <dtseng@chromium.org>
Cr-Commit-Position: refs/heads/master@{#820433}

ash/accessibility/accessibility_controller_impl.cc

@@ -1526,6 +1526,12 @@ void AccessibilityControllerImpl::RequestAutoclickScrollableBoundsForPoint(
     client_->RequestAutoclickScrollableBoundsForPoint(point_in_screen);
 }
 
+void AccessibilityControllerImpl::MagnifierBoundsChanged(
+    const gfx::Rect& bounds_in_screen) {
+  if (client_)
+    client_->MagnifierBoundsChanged(bounds_in_screen);
+}
+
 void AccessibilityControllerImpl::UpdateAutoclickMenuBoundsIfNeeded() {
   Shell::Get()->autoclick_controller()->UpdateAutoclickMenuBoundsIfNeeded();
 }

ash/accessibility/accessibility_controller_impl.h

@@ -197,6 +197,7 @@ class ASH_EXPORT AccessibilityControllerImpl : public AccessibilityController,
   void SetAutoclickMenuPosition(FloatingMenuPosition position);
   FloatingMenuPosition GetAutoclickMenuPosition();
   void RequestAutoclickScrollableBoundsForPoint(gfx::Point& point_in_screen);
+  void MagnifierBoundsChanged(const gfx::Rect& bounds_in_screen);
 
   void SetFloatingMenuPosition(FloatingMenuPosition position);
   FloatingMenuPosition GetFloatingMenuPosition();

ash/accessibility/test_accessibility_controller_client.cc

@@ -70,6 +70,9 @@ void TestAccessibilityControllerClient::RequestSelectToSpeakStateChange() {
 void TestAccessibilityControllerClient::
     RequestAutoclickScrollableBoundsForPoint(gfx::Point& point_in_screen) {}
 
+void TestAccessibilityControllerClient::MagnifierBoundsChanged(
+    const gfx::Rect& bounds_in_screen) {}
+
 void TestAccessibilityControllerClient::OnSwitchAccessDisabled() {}
 
 int32_t TestAccessibilityControllerClient::GetPlayedEarconAndReset() {

ash/accessibility/test_accessibility_controller_client.h

@@ -40,6 +40,7 @@ class TestAccessibilityControllerClient : public AccessibilityControllerClient {
   void RequestSelectToSpeakStateChange() override;
   void RequestAutoclickScrollableBoundsForPoint(
       gfx::Point& point_in_screen) override;
+  void MagnifierBoundsChanged(const gfx::Rect& bounds_in_screen) override;
   void OnSwitchAccessDisabled() override;
 
   int32_t GetPlayedEarconAndReset();

ash/magnifier/magnification_controller.cc

@@ -10,6 +10,7 @@
 #include <vector>
 
 #include "ash/accelerators/accelerator_controller_impl.h"
+#include "ash/accessibility/accessibility_controller_impl.h"
 #include "ash/accessibility/accessibility_delegate.h"
 #include "ash/display/root_window_transformers.h"
 #include "ash/host/ash_window_tree_host.h"
@@ -701,6 +702,9 @@ bool MagnificationController::RedrawDIP(const gfx::PointF& position_in_dip,
   if (duration_in_ms > 0)
     is_on_animation_ = true;
 
+  Shell::Get()->accessibility_controller()->MagnifierBoundsChanged(
+      GetViewportRect());
+
   return true;
 }
 

ash/public/cpp/accessibility_controller_client.h

@@ -17,6 +17,7 @@ enum class Gesture;
 namespace gfx {
 class Point;
 class PointF;
+class Rect;
 }  // namespace gfx
 
 namespace ash {
@@ -82,6 +83,10 @@ class ASH_PUBLIC_EXPORT AccessibilityControllerClient {
   virtual void RequestAutoclickScrollableBoundsForPoint(
       gfx::Point& point_in_screen) = 0;
 
+  // Dispatches update to Accessibility Common extension when magnifier bounds
+  // have changed.
+  virtual void MagnifierBoundsChanged(const gfx::Rect& bounds_in_screen) = 0;
+
   // Called when Switch Access is fully disabled by the user accepting the
   // disable dialog. Switch Access must be left running when the pref changes
   // and before the disable dialog is accepted, so that users can use Switch

chrome/browser/chromeos/accessibility/accessibility_manager.cc

@@ -531,11 +531,11 @@ bool AccessibilityManager::PlayEarcon(int sound_key, PlaySoundOption option) {
 }
 
 void AccessibilityManager::OnTwoFingerTouchStart() {
-  if (!profile())
+  if (!profile_)
     return;
 
   extensions::EventRouter* event_router =
-      extensions::EventRouter::Get(profile());
+      extensions::EventRouter::Get(profile_);
 
   auto event_args = std::make_unique<base::ListValue>();
   auto event = std::make_unique<extensions::Event>(
@@ -546,11 +546,11 @@ void AccessibilityManager::OnTwoFingerTouchStart() {
 }
 
 void AccessibilityManager::OnTwoFingerTouchStop() {
-  if (!profile())
+  if (!profile_)
     return;
 
   extensions::EventRouter* event_router =
-      extensions::EventRouter::Get(profile());
+      extensions::EventRouter::Get(profile_);
 
   auto event_args = std::make_unique<base::ListValue>();
   auto event = std::make_unique<extensions::Event>(
@@ -599,7 +599,7 @@ void AccessibilityManager::HandleAccessibilityGesture(
     ax::mojom::Gesture gesture,
     gfx::PointF location) {
   extensions::EventRouter* event_router =
-      extensions::EventRouter::Get(profile());
+      extensions::EventRouter::Get(profile_);
 
   std::unique_ptr<base::ListValue> event_args =
       std::make_unique<base::ListValue>();
@@ -688,6 +688,35 @@ void AccessibilityManager::RequestAutoclickScrollableBoundsForPoint(
       extension_misc::kAccessibilityCommonExtensionId, std::move(event));
 }
 
+void AccessibilityManager::MagnifierBoundsChanged(
+    const gfx::Rect& bounds_in_screen) {
+  if (!profile_)
+    return;
+
+  extensions::EventRouter* event_router =
+      extensions::EventRouter::Get(profile_);
+
+  auto magnifier_bounds =
+      std::make_unique<extensions::api::accessibility_private::ScreenRect>();
+  magnifier_bounds->left = bounds_in_screen.x();
+  magnifier_bounds->top = bounds_in_screen.y();
+  magnifier_bounds->width = bounds_in_screen.width();
+  magnifier_bounds->height = bounds_in_screen.height();
+
+  auto event_args =
+      extensions::api::accessibility_private::OnMagnifierBoundsChanged::Create(
+          *magnifier_bounds.get());
+
+  auto event = std::make_unique<extensions::Event>(
+      extensions::events::ACCESSIBILITY_PRIVATE_ON_MAGNIFIER_BOUNDS_CHANGED,
+      extensions::api::accessibility_private::OnMagnifierBoundsChanged::
+          kEventName,
+      std::move(event_args));
+
+  event_router->DispatchEventWithLazyListener(
+      extension_misc::kAccessibilityCommonExtensionId, std::move(event));
+}
+
 void AccessibilityManager::EnableVirtualKeyboard(bool enabled) {
   if (!profile_)
     return;

chrome/browser/chromeos/accessibility/accessibility_manager.h

@@ -158,6 +158,10 @@ class AccessibilityManager
   // ancestor to the point in the screen, as given in screen coordinates.
   void RequestAutoclickScrollableBoundsForPoint(gfx::Point& point_in_screen);
 
+  // Dispatches magnifier bounds update to Magnifier (through Accessibility
+  // Common extension).
+  void MagnifierBoundsChanged(const gfx::Rect& bounds_in_screen);
+
   // Enables or disables the virtual keyboard.
   void EnableVirtualKeyboard(bool enabled);
   // Returns true if the virtual keyboard is enabled, otherwise false.

chrome/browser/ui/ash/accessibility/accessibility_controller_client.cc

@@ -150,6 +150,12 @@ void AccessibilityControllerClient::RequestAutoclickScrollableBoundsForPoint(
       ->RequestAutoclickScrollableBoundsForPoint(point_in_screen);
 }
 
+void AccessibilityControllerClient::MagnifierBoundsChanged(
+    const gfx::Rect& bounds_in_screen) {
+  chromeos::AccessibilityManager::Get()->MagnifierBoundsChanged(
+      bounds_in_screen);
+}
+
 void AccessibilityControllerClient::OnSwitchAccessDisabled() {
   chromeos::AccessibilityManager::Get()->OnSwitchAccessDisabled();
 }

chrome/browser/ui/ash/accessibility/accessibility_controller_client.h

@@ -32,6 +32,7 @@ class AccessibilityControllerClient
   void RequestSelectToSpeakStateChange() override;
   void RequestAutoclickScrollableBoundsForPoint(
       gfx::Point& point_in_screen) override;
+  void MagnifierBoundsChanged(const gfx::Rect& bounds_in_screen) override;
   void OnSwitchAccessDisabled() override;
 
  private:

chrome/common/extensions/api/accessibility_private.json

@@ -565,6 +565,19 @@
         ],
         "platforms": ["chromeos"]
       },
+      {
+        "name": "onMagnifierBoundsChanged",
+        "type": "function",
+        "description": "Fired when Chrome OS magnifier bounds are updated.",
+        "parameters": [
+          {
+            "name": "magnifierBounds",
+            "$ref": "ScreenRect",
+            "description": "Updated bounds of magnifier viewport."
+          }
+        ],
+        "platforms": ["chromeos"]
+      },
       {
         "name": "onCustomSpokenFeedbackToggled",
         "type": "function",

extensions/browser/extension_event_histogram_value.h

@@ -483,6 +483,7 @@ enum HistogramValue {
   WINDOWS_ON_BOUNDS_CHANGED = 461,
   WALLPAPER_PRIVATE_ON_CLOSE_PREVIEW_WALLPAPER = 462,
   PASSWORDS_PRIVATE_ON_WEAK_CREDENTIALS_CHANGED = 463,
+  ACCESSIBILITY_PRIVATE_ON_MAGNIFIER_BOUNDS_CHANGED = 464,
   // Last entry: Add new entries above, then run:
   // python tools/metrics/histograms/update_extension_histograms.py
   ENUM_BOUNDARY

third_party/closure_compiler/externs/accessibility_private.js

@@ -274,7 +274,7 @@ chrome.accessibilityPrivate.forwardKeyEventsToSwitchAccess = function(shouldForw
 chrome.accessibilityPrivate.updateSwitchAccessBubble = function(bubble, show, anchor, actions) {};
 
 /**
- * Enable point scanning in Switch Access.
+ * Enables or disables point scanning in Switch Access.
  * @param {boolean} enabled True for start point scanning, false for end point
  *     scanning.
  */
@@ -417,6 +417,12 @@ chrome.accessibilityPrivate.onAnnounceForAccessibility;
  */
 chrome.accessibilityPrivate.onScrollableBoundsForPointRequested;
 
+/**
+ * Fired when Chrome OS magnifier bounds are updated.
+ * @type {!ChromeEvent}
+ */
+chrome.accessibilityPrivate.onMagnifierBoundsChanged;
+
 /**
  * Fired when a custom spoken feedback on the active window gets enabled or
  * disabled. Called from ARC++ accessibility.

tools/metrics/histograms/enums.xml

@@ -23524,6 +23524,7 @@ Called by update_extension_histograms.py.-->
   <int value="461" label="WINDOWS_ON_BOUNDS_CHANGED"/>
   <int value="462" label="WALLPAPER_PRIVATE_ON_CLOSE_PREVIEW_WALLPAPER"/>
   <int value="463" label="PASSWORDS_PRIVATE_ON_WEAK_CREDENTIALS_CHANGED"/>
+  <int value="464" label="ACCESSIBILITY_PRIVATE_ON_MAGNIFIER_BOUNDS_CHANGED"/>
 </enum>
 
 <enum name="ExtensionFileWriteResult">