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


ash / system / input_device_settings / pref_handlers / keyboard_pref_handler.h [blame]

// Copyright 2023 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_INPUT_DEVICE_SETTINGS_PREF_HANDLERS_KEYBOARD_PREF_HANDLER_H_
#define ASH_SYSTEM_INPUT_DEVICE_SETTINGS_PREF_HANDLERS_KEYBOARD_PREF_HANDLER_H_

#include "ash/ash_export.h"
#include "ash/public/mojom/input_device_settings.mojom-forward.h"

class AccountId;
class PrefService;

namespace ash {

// Handles reading and updating prefs that store keyboard settings.
class ASH_EXPORT KeyboardPrefHandler {
 public:
  virtual ~KeyboardPrefHandler() = default;

  // Initializes device settings in prefs and update the `settings` member of
  // the `mojom::Keyboard` object. Respects all policies given by
  // `keyboard_policies`. If `pref_service` is null, sets the `settings` member
  // to default settings.
  virtual void InitializeKeyboardSettings(
      PrefService* pref_service,
      const mojom::KeyboardPolicies& keyboard_policies,
      mojom::Keyboard* keyboard) = 0;

  // Initializes login screen device settings using the passed in `keyboard`.
  // Settings will be stored either in `settings.keyboard.internal` or
  // `settings.keyboard.external` based on the value of `keyboard.is_external`.
  virtual void InitializeLoginScreenKeyboardSettings(
      PrefService* local_state,
      const AccountId& account_id,
      const mojom::KeyboardPolicies& keyboard_policies,
      mojom::Keyboard* keyboard) = 0;

  // Updates device settings stored in prefs to match the values in
  // `keyboard.settings`.
  virtual void UpdateKeyboardSettings(
      PrefService* pref_service,
      const mojom::KeyboardPolicies& keyboard_policies,
      const mojom::Keyboard& keyboard) = 0;

  // Updates login screen device settings stored in prefs to match the values in
  // `keyboard.settings`. Settings will be stored either in
  // `settings.keyboard.internal` or `settings.keyboard.external` based on the
  // value of `keyboard.is_external`.
  virtual void UpdateLoginScreenKeyboardSettings(
      PrefService* local_state,
      const AccountId& account_id,
      const mojom::KeyboardPolicies& keyboard_policies,
      const mojom::Keyboard& keyboard) = 0;

  // Updates the `settings` member of the `mojom::Keyboard` object using
  // default settings.
  virtual void InitializeWithDefaultKeyboardSettings(
      const mojom::KeyboardPolicies& keyboard_policies,
      mojom::Keyboard* keyboard) = 0;

  // Updates the default settings with the settings from the given keyboard.
  // These settings are applied to other ChromeOS keyboards that are connected
  // for the first time.
  virtual void UpdateDefaultChromeOSKeyboardSettings(
      PrefService* pref_service,
      const mojom::KeyboardPolicies& keyboard_policies,
      const mojom::Keyboard& keyboard) = 0;

  // Updates the default settings with the settings from the given keyboard.
  // These settings are applied to other Non-ChromeOS keyboards that are
  // connected for the first time.
  virtual void UpdateDefaultNonChromeOSKeyboardSettings(
      PrefService* pref_service,
      const mojom::KeyboardPolicies& keyboard_policies,
      const mojom::Keyboard& keyboard) = 0;

  // Updates the default settings with the settings from the given keyboard.
  // These settings are applied to other split modifier keyboards that are
  // connected for the first time.
  virtual void UpdateDefaultSplitModifierKeyboardSettings(
      PrefService* pref_service,
      const mojom::KeyboardPolicies& keyboard_policies,
      const mojom::Keyboard& keyboard) = 0;

  // Force refreshes the passed in keyboard settings to match the defaults for
  // the given `pref_service`.
  virtual void ForceInitializeWithDefaultSettings(
      PrefService* pref_service,
      const mojom::KeyboardPolicies& keyboard_policies,
      mojom::Keyboard* keyboard) = 0;
};

}  // namespace ash

#endif  // ASH_SYSTEM_INPUT_DEVICE_SETTINGS_PREF_HANDLERS_KEYBOARD_PREF_HANDLER_H_