ash/system/accessibility/accessibility_detailed_view.h

// Copyright 2012 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#ifndef ASH_SYSTEM_ACCESSIBILITY_ACCESSIBILITY_DETAILED_VIEW_H_
#define ASH_SYSTEM_ACCESSIBILITY_ACCESSIBILITY_DETAILED_VIEW_H_

#include <stdint.h>

#include "ash/accessibility/accessibility_delegate.h"
#include "ash/accessibility/accessibility_observer.h"
#include "ash/public/cpp/session/session_observer.h"
#include "ash/system/tray/tray_detailed_view.h"
#include "base/memory/raw_ptr.h"
#include "components/soda/soda_installer.h"
#include "ui/gfx/font.h"
#include "ui/views/controls/button/button.h"
#include "ui/views/view.h"

namespace views {
class Button;
class Button;
class View;
}  // namespace views

namespace ash {
class HoverHighlightView;
class DetailedViewDelegate;

enum class SodaFeature {
  kDictation,
  kLiveCaption,
};

// Create the detailed view of accessibility tray.
class ASH_EXPORT AccessibilityDetailedView
    : public TrayDetailedView,
      public speech::SodaInstaller::Observer {
 public:
  static const char kClassName[];

  explicit AccessibilityDetailedView(DetailedViewDelegate* delegate);

  AccessibilityDetailedView(const AccessibilityDetailedView&) = delete;
  AccessibilityDetailedView& operator=(const AccessibilityDetailedView&) =
      delete;

  ~AccessibilityDetailedView() override;

  void OnAccessibilityStatusChanged();

  // views::View
  const char* GetClassName() const override;

 private:
  friend class AccessibilityDetailedViewLoginScreenTest;
  friend class AccessibilityDetailedViewSodaTest;
  friend class AccessibilityDetailedViewTest;
  friend class TrayAccessibilityTest;

  // TrayDetailedView:
  void HandleViewClicked(views::View* view) override;
  void CreateExtraTitleRowButtons() override;

  // Launches the WebUI settings in a browser and closes the system menu.
  void ShowSettings();

  // Launches the a11y help article in a browser and closes the system menu.
  void ShowHelp();

  // Add the accessibility feature list.
  void AppendAccessibilityList();

  // Adds the enabled accessibility features to the `container`.
  // Only used with QsRevamp.
  void AddEnabledFeatures(views::View* container);

  // Adds all accessibility features to the `container`.
  void AddAllFeatures(views::View* container);

  // Adds a HoverHighlightView to `container` for the appropriate accessibility
  // feature and returns it.
  HoverHighlightView* AddSpokenFeedbackView(views::View* container);
  HoverHighlightView* AddSelectToSpeakView(views::View* container);
  HoverHighlightView* AddDictationView(views::View* container);
  HoverHighlightView* AddHighContrastView(views::View* container);
  HoverHighlightView* AddScreenMagnifierView(views::View* container);
  HoverHighlightView* AddDockedMagnifierView(views::View* container);
  HoverHighlightView* AddLargeCursorView(views::View* container);
  HoverHighlightView* AddAutoclickView(views::View* container);
  HoverHighlightView* AddVirtualKeyboardView(views::View* container);
  HoverHighlightView* AddSwitchAccessView(views::View* container);
  HoverHighlightView* AddLiveCaptionView(views::View* container);
  HoverHighlightView* AddMonoAudioView(views::View* container);
  HoverHighlightView* AddCaretHighlightView(views::View* container);
  HoverHighlightView* AddHighlightMouseCursorView(views::View* container);
  HoverHighlightView* AddHighlightKeyboardFocusView(views::View* container);
  HoverHighlightView* AddStickyKeysView(views::View* container);

  // Adds a HoverHighlightView to the scroll list and returns it. Configures
  // the view based on the QsRevamp feature flag.
  HoverHighlightView* AddScrollListFeatureItem(views::View* container,
                                               const gfx::VectorIcon& icon,
                                               const std::u16string& text,
                                               bool checked,
                                               bool enterprise_managed);

  // Adds a HoverHighlightView with a toggle button on the right to the scroll
  // list and returns it. Only used with QsRevamp.
  HoverHighlightView* AddScrollListToggleItem(views::View* container,
                                              const gfx::VectorIcon& icon,
                                              const std::u16string& text,
                                              bool checked,
                                              bool enterprise_managed);

  // SodaInstaller::Observer:
  void OnSodaInstalled(speech::LanguageCode language_code) override;
  void OnSodaInstallError(speech::LanguageCode language_code,
                          speech::SodaInstaller::ErrorCode error_code) override;
  void OnSodaProgress(speech::LanguageCode language_code,
                      int combined_progress) override;

  // Shows a message next to the feature icon in the tray if it is available
  // and if the language code provided is relevant to the feature.
  void MaybeShowSodaMessage(SodaFeature feature,
                            speech::LanguageCode language_code,
                            std::u16string message);
  bool IsSodaFeatureInTray(SodaFeature feature);
  void SetSodaFeatureSubtext(SodaFeature feature, std::u16string message);

  raw_ptr<HoverHighlightView, ExperimentalAsh> spoken_feedback_view_ = nullptr;
  raw_ptr<HoverHighlightView, ExperimentalAsh> select_to_speak_view_ = nullptr;
  raw_ptr<HoverHighlightView, ExperimentalAsh> dictation_view_ = nullptr;
  raw_ptr<HoverHighlightView, ExperimentalAsh> high_contrast_view_ = nullptr;
  raw_ptr<HoverHighlightView, ExperimentalAsh> screen_magnifier_view_ = nullptr;
  raw_ptr<HoverHighlightView, ExperimentalAsh> docked_magnifier_view_ = nullptr;
  raw_ptr<HoverHighlightView, ExperimentalAsh> large_cursor_view_ = nullptr;
  raw_ptr<HoverHighlightView, ExperimentalAsh> autoclick_view_ = nullptr;
  raw_ptr<HoverHighlightView, ExperimentalAsh> virtual_keyboard_view_ = nullptr;
  raw_ptr<HoverHighlightView, ExperimentalAsh> switch_access_view_ = nullptr;
  raw_ptr<HoverHighlightView, ExperimentalAsh> live_caption_view_ = nullptr;
  raw_ptr<HoverHighlightView, ExperimentalAsh> mono_audio_view_ = nullptr;
  raw_ptr<HoverHighlightView, ExperimentalAsh> caret_highlight_view_ = nullptr;
  raw_ptr<HoverHighlightView, ExperimentalAsh> highlight_mouse_cursor_view_ =
      nullptr;
  raw_ptr<HoverHighlightView, ExperimentalAsh> highlight_keyboard_focus_view_ =
      nullptr;
  raw_ptr<HoverHighlightView, ExperimentalAsh> sticky_keys_view_ = nullptr;

  // Views that appear in the top section listing enabled items. Created if the
  // feature is enabled, otherwise nullptr. Owned by views hierarchy.
  // Only used with QsRevamp.
  raw_ptr<HoverHighlightView, ExperimentalAsh> spoken_feedback_top_view_ =
      nullptr;
  raw_ptr<HoverHighlightView, ExperimentalAsh> select_to_speak_top_view_ =
      nullptr;
  raw_ptr<HoverHighlightView, ExperimentalAsh> dictation_top_view_ = nullptr;
  raw_ptr<HoverHighlightView, ExperimentalAsh> high_contrast_top_view_ =
      nullptr;
  raw_ptr<HoverHighlightView, ExperimentalAsh> screen_magnifier_top_view_ =
      nullptr;
  raw_ptr<HoverHighlightView, ExperimentalAsh> docked_magnifier_top_view_ =
      nullptr;
  raw_ptr<HoverHighlightView, ExperimentalAsh> large_cursor_top_view_ = nullptr;
  raw_ptr<HoverHighlightView, ExperimentalAsh> autoclick_top_view_ = nullptr;
  raw_ptr<HoverHighlightView, ExperimentalAsh> virtual_keyboard_top_view_ =
      nullptr;
  raw_ptr<HoverHighlightView, ExperimentalAsh> switch_access_top_view_ =
      nullptr;
  raw_ptr<HoverHighlightView, ExperimentalAsh> live_caption_top_view_ = nullptr;
  raw_ptr<HoverHighlightView, ExperimentalAsh> mono_audio_top_view_ = nullptr;
  raw_ptr<HoverHighlightView, ExperimentalAsh> caret_highlight_top_view_ =
      nullptr;
  raw_ptr<HoverHighlightView, ExperimentalAsh>
      highlight_mouse_cursor_top_view_ = nullptr;
  raw_ptr<HoverHighlightView, ExperimentalAsh>
      highlight_keyboard_focus_top_view_ = nullptr;
  raw_ptr<HoverHighlightView, ExperimentalAsh> sticky_keys_top_view_ = nullptr;

  raw_ptr<views::Button, ExperimentalAsh> help_view_ = nullptr;
  raw_ptr<views::Button, ExperimentalAsh> settings_view_ = nullptr;

  LoginStatus login_;

  // Whether `features::kQsRevamp` is enabled. Used to avoid redundant
  // base::Feature lookups when building the view.
  const bool is_qs_revamp_enabled_;
};

}  // namespace ash

#endif  // ASH_SYSTEM_ACCESSIBILITY_ACCESSIBILITY_DETAILED_VIEW_H_