chrome/browser/chromeos/system/input_device_settings.h

   1 // Copyright (c) 2012 The Chromium Authors. All rights reserved.
   2 // Use of this source code is governed by a BSD-style license that can be
   3 // found in the LICENSE file.
   4
   5 #ifndef CHROME_BROWSER_CHROMEOS_SYSTEM_INPUT_DEVICE_SETTINGS_H_
   6 #define CHROME_BROWSER_CHROMEOS_SYSTEM_INPUT_DEVICE_SETTINGS_H_
   7
   8 #include "base/callback.h"
   9 #include "base/logging.h"
  10 #include "chromeos/chromeos_export.h"
  11
  12 namespace chromeos {
  13 namespace system {
  14
  15 class InputDeviceSettings;
  16
  17 namespace internal {
  18
  19 // Objects of this class are intended to store values of type T, but might have
  20 // "unset" state. Object will be in "unset" state until Set is called first
  21 // time.
  22 template <typename T>
  23 class Optional {
  24  public:
  25   Optional() : value_(), is_set_(false) {}
  26
  27   Optional& operator=(const Optional& other) {
  28     if (&other != this) {
  29       value_ = other.value_;
  30       is_set_ = other.is_set_;
  31     }
  32     return *this;
  33   }
  34
  35   void Set(const T& value) {
  36     is_set_ = true;
  37     value_ = value;
  38   }
  39
  40   bool is_set() const { return is_set_; }
  41
  42   T value() const {
  43     DCHECK(is_set());
  44     return value_;
  45   }
  46
  47   // Tries to update |this| with |update|. If |update| is unset or has same
  48   // value as |this| method returns false. Otherwise |this| takes value of
  49   // |update| and returns true.
  50   bool Update(const Optional& update) {
  51     if (update.is_set_ && (!is_set_ || value_ != update.value_)) {
  52       value_ = update.value_;
  53       is_set_ = true;
  54       return true;
  55     }
  56     return false;
  57   }
  58
  59  private:
  60   T value_;
  61   bool is_set_;
  62 };
  63
  64 }  // namespace internal
  65
  66 // Min/max possible pointer sensitivity values.
  67 const int kMinPointerSensitivity = 1;
  68 const int kMaxPointerSensitivity = 5;
  69
  70 // Auxiliary class used to update several touchpad settings at a time. User
  71 // should set any number of settings and pass object to UpdateTouchpadSettings
  72 // method of InputDeviceSettings.
  73 // Objects of this class have no default values for settings, so it is error
  74 // to call Get* method before calling corresponding Set* method at least
  75 // once.
  76 class TouchpadSettings {
  77  public:
  78   TouchpadSettings();
  79   TouchpadSettings& operator=(const TouchpadSettings& other);
  80
  81   void SetSensitivity(int value);
  82   int GetSensitivity() const;
  83   bool IsSensitivitySet() const;
  84
  85   void SetTapToClick(bool enabled);
  86   bool GetTapToClick() const;
  87   bool IsTapToClickSet() const;
  88
  89   void SetThreeFingerClick(bool enabled);
  90   bool GetThreeFingerClick() const;
  91   bool IsThreeFingerClickSet() const;
  92
  93   void SetTapDragging(bool enabled);
  94   bool GetTapDragging() const;
  95   bool IsTapDraggingSet() const;
  96
  97   void SetNaturalScroll(bool enabled);
  98   bool GetNaturalScroll() const;
  99   bool IsNaturalScrollSet() const;
 100
 101   // Updates |this| with |settings|. If at least one setting was updated returns
 102   // true.
 103   bool Update(const TouchpadSettings& settings);
 104
 105   // Apply |settings| to input devices.
 106   static void Apply(const TouchpadSettings& touchpad_settings,
 107                     InputDeviceSettings* input_device_settings);
 108
 109  private:
 110   internal::Optional<int> sensitivity_;
 111   internal::Optional<bool> tap_to_click_;
 112   internal::Optional<bool> three_finger_click_;
 113   internal::Optional<bool> tap_dragging_;
 114   internal::Optional<bool> natural_scroll_;
 115 };
 116
 117 // Auxiliary class used to update several mouse settings at a time. User
 118 // should set any number of settings and pass object to UpdateMouseSettings
 119 // method of InputDeviceSettings.
 120 // Objects of this class have no default values for settings, so it is error
 121 // to call Get* method before calling corresponding Set* method at least
 122 // once.
 123 class MouseSettings {
 124  public:
 125   MouseSettings();
 126   MouseSettings& operator=(const MouseSettings& other);
 127
 128   void SetSensitivity(int value);
 129   int GetSensitivity() const;
 130   bool IsSensitivitySet() const;
 131
 132   void SetPrimaryButtonRight(bool right);
 133   bool GetPrimaryButtonRight() const;
 134   bool IsPrimaryButtonRightSet() const;
 135
 136   // Updates |this| with |settings|. If at least one setting was updated returns
 137   // true.
 138   bool Update(const MouseSettings& settings);
 139
 140   // Apply |settings| to input devices.
 141   static void Apply(const MouseSettings& mouse_settings,
 142                     InputDeviceSettings* input_device_settings);
 143
 144  private:
 145   internal::Optional<int> sensitivity_;
 146   internal::Optional<bool> primary_button_right_;
 147 };
 148
 149 // Interface for configuring input device settings.
 150 class CHROMEOS_EXPORT InputDeviceSettings {
 151  public:
 152   typedef base::Callback<void(bool)> DeviceExistsCallback;
 153
 154   virtual ~InputDeviceSettings() {}
 155
 156   // Returns current instance of InputDeviceSettings.
 157   static InputDeviceSettings* Get();
 158
 159   // Replaces current instance with |test_settings|. Takes ownership of
 160   // |test_settings|. Default implementation could be returned back by passing
 161   // NULL to this method.
 162   static void SetSettingsForTesting(InputDeviceSettings* test_settings);
 163
 164   // Returns true if UI should implement enhanced keyboard support for cases
 165   // where other input devices like mouse are absent.
 166   static bool ForceKeyboardDrivenUINavigation();
 167
 168   // Calls |callback| asynchronously after determining if a touchpad is
 169   // connected.
 170   virtual void TouchpadExists(const DeviceExistsCallback& callback) = 0;
 171
 172   // Updates several touchpad settings at a time. Updates only settings that
 173   // are set in |settings| object. It is more efficient to use this method to
 174   // update several settings then calling Set* methods one by one.
 175   virtual void UpdateTouchpadSettings(const TouchpadSettings& settings) = 0;
 176
 177   // Sets the touchpad sensitivity in the range [kMinPointerSensitivity,
 178   // kMaxPointerSensitivity].
 179   virtual void SetTouchpadSensitivity(int value) = 0;
 180
 181   // Turns tap to click on/off.
 182   virtual void SetTapToClick(bool enabled) = 0;
 183
 184   // Switch for three-finger click.
 185   virtual void SetThreeFingerClick(bool enabled) = 0;
 186
 187   // Turns tap-dragging on/off.
 188   virtual void SetTapDragging(bool enabled) = 0;
 189
 190   // Turns natural scrolling on/off for all devices except wheel mice
 191   virtual void SetNaturalScroll(bool enabled) = 0;
 192
 193   // Calls |callback| asynchronously after determining if a mouse is connected.
 194   virtual void MouseExists(const DeviceExistsCallback& callback) = 0;
 195
 196   // Updates several mouse settings at a time. Updates only settings that
 197   // are set in |settings| object. It is more efficient to use this method to
 198   // update several settings then calling Set* methods one by one.
 199   virtual void UpdateMouseSettings(const MouseSettings& settings) = 0;
 200
 201   // Sets the mouse sensitivity in the range [kMinPointerSensitivity,
 202   // kMaxPointerSensitivity].
 203   virtual void SetMouseSensitivity(int value) = 0;
 204
 205   // Sets the primary mouse button to the right button if |right| is true.
 206   virtual void SetPrimaryButtonRight(bool right) = 0;
 207
 208   // Reapplies previously set touchpad settings.
 209   virtual void ReapplyTouchpadSettings() = 0;
 210
 211   // Reapplies previously set mouse settings.
 212   virtual void ReapplyMouseSettings() = 0;
 213 };
 214
 215 }  // namespace system
 216 }  // namespace chromeos
 217
 218 #endif  // CHROME_BROWSER_CHROMEOS_SYSTEM_INPUT_DEVICE_SETTINGS_H_