File: on_screen_keyboard_display_manager_input_pane.h

package info (click to toggle)
chromium 139.0.7258.127-1
  • links: PTS, VCS
  • area: main
  • in suites:
  • size: 6,122,068 kB
  • sloc: cpp: 35,100,771; ansic: 7,163,530; javascript: 4,103,002; python: 1,436,920; asm: 946,517; xml: 746,709; pascal: 187,653; perl: 88,691; sh: 88,436; objc: 79,953; sql: 51,488; cs: 44,583; fortran: 24,137; makefile: 22,147; tcl: 15,277; php: 13,980; yacc: 8,984; ruby: 7,485; awk: 3,720; lisp: 3,096; lex: 1,327; ada: 727; jsp: 228; sed: 36
file content (86 lines) | stat: -rw-r--r-- 3,178 bytes parent folder | download | duplicates (11)
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
// 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_BASE_IME_WIN_ON_SCREEN_KEYBOARD_DISPLAY_MANAGER_INPUT_PANE_H_
#define UI_BASE_IME_WIN_ON_SCREEN_KEYBOARD_DISPLAY_MANAGER_INPUT_PANE_H_

#include <inputpaneinterop.h>
#include <windows.ui.viewmanagement.h>
#include <wrl/client.h>
#include <wrl/event.h>

#include <memory>

#include "base/component_export.h"
#include "base/observer_list.h"
#include "base/task/single_thread_task_runner.h"
#include "base/win/windows_types.h"
#include "ui/base/ime/mojom/virtual_keyboard_types.mojom-shared.h"
#include "ui/base/ime/virtual_keyboard_controller.h"
#include "ui/base/ime/win/virtual_keyboard_debounce_timer.h"
#include "ui/gfx/geometry/rect.h"

namespace ui {

class OnScreenKeyboardTest;

// This class provides an implementation of the OnScreenKeyboardDisplayManager
// that uses InputPane which is available on Windows >= 10.0.10240.0.
class COMPONENT_EXPORT(UI_BASE_IME_WIN)
    OnScreenKeyboardDisplayManagerInputPane final
    : public VirtualKeyboardController {
 public:
  explicit OnScreenKeyboardDisplayManagerInputPane(HWND hwnd);

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

  ~OnScreenKeyboardDisplayManagerInputPane() override;

  // VirtualKeyboardController:
  bool DisplayVirtualKeyboard() override;
  void DismissVirtualKeyboard() override;
  void AddObserver(VirtualKeyboardControllerObserver* observer) override;
  void RemoveObserver(VirtualKeyboardControllerObserver* observer) override;
  bool IsKeyboardVisible() override;

  void SetInputPaneForTesting(
      Microsoft::WRL::ComPtr<ABI::Windows::UI::ViewManagement::IInputPane>
          pane);
  // Returns whether show/hide VK API is called from
  // VirtualKeyboardController or not.
  mojom::VirtualKeyboardVisibilityRequest
  GetLastVirtualKeyboardVisibilityRequest() const {
    return last_vk_visibility_request_;
  }

 private:
  class VirtualKeyboardInputPane;
  friend class OnScreenKeyboardTest;

  void NotifyObserversOnKeyboardShown(gfx::Rect rect);
  void NotifyObserversOnKeyboardHidden();
  // This executes when the debounce timer expires.
  void Run();

  // The main window which displays the on screen keyboard.
  const HWND hwnd_;
  base::ObserverList<VirtualKeyboardControllerObserver, false>::Unchecked
      observers_;
  const scoped_refptr<base::SingleThreadTaskRunner> main_task_runner_;
  const scoped_refptr<base::SingleThreadTaskRunner> background_task_runner_;
  scoped_refptr<VirtualKeyboardInputPane> virtual_keyboard_input_pane_;
  bool is_keyboard_visible_;
  mojom::VirtualKeyboardVisibilityRequest last_vk_visibility_request_ =
      mojom::VirtualKeyboardVisibilityRequest::NONE;
  std::unique_ptr<VirtualKeyboardDebounceTimer> debouncer_;
  base::WeakPtrFactory<OnScreenKeyboardDisplayManagerInputPane> weak_factory_{
      this};
};

}  // namespace ui

#endif  // UI_BASE_IME_WIN_ON_SCREEN_KEYBOARD_DISPLAY_MANAGER_INPUT_PANE_H_