| // Copyright 2018 The Chromium Authors |
| // Use of this source code is governed by a BSD-style license that can be |
| // found in the LICENSE file. |
| |
| #ifndef UI_EVENTS_KEYBOARD_HOOK_H_ |
| #define UI_EVENTS_KEYBOARD_HOOK_H_ |
| |
| #include <memory> |
| |
| #include "base/component_export.h" |
| #include "base/containers/flat_set.h" |
| #include "base/functional/callback.h" |
| #include "third_party/abseil-cpp/absl/types/optional.h" |
| #include "ui/gfx/native_widget_types.h" |
| |
| namespace ui { |
| |
| enum class DomCode : uint32_t; |
| class KeyEvent; |
| |
| // Intercepts keyboard events typically handled by the OS or browser. |
| // Destroying the instance will unregister and clean up the keyboard hook. |
| class COMPONENT_EXPORT(KEYBOARD_HOOK) KeyboardHook { |
| public: |
| using KeyEventCallback = base::RepeatingCallback<void(KeyEvent* event)>; |
| |
| virtual ~KeyboardHook() = default; |
| |
| // Creates a platform specific implementation. |
| // |dom_codes| is the set of key codes which will be intercepted, if it is |
| // empty, this class will try to intercept all keys allowed by the platform. |
| // |callback| is called for each key which is intercepted. |
| // Returns a valid instance if the hook was created and successfully |
| // registered otherwise nullptr. |
| static std::unique_ptr<KeyboardHook> CreateModifierKeyboardHook( |
| absl::optional<base::flat_set<DomCode>> dom_codes, |
| gfx::AcceleratedWidget accelerated_widget, |
| KeyEventCallback callback); |
| |
| // Creates a platform-specific KeyboardHook implementation that captures the |
| // play/pause, stop, and next/previous track media keys. |
| // |callback| is called for each key which is intercepted. |
| // Returns a valid instance if the hook was created and successfully |
| // registered otherwise nullptr. |
| static std::unique_ptr<KeyboardHook> CreateMediaKeyboardHook( |
| KeyEventCallback callback); |
| |
| // True if |dom_code| is reserved for an active KeyboardLock request. |
| virtual bool IsKeyLocked(DomCode dom_code) const = 0; |
| }; |
| |
| } // namespace ui |
| |
| #endif // UI_EVENTS_KEYBOARD_HOOK_H_ |