New method: InputMethod::IsCandidatePopupOpen()

ui/base/ime/input_method_tsf.cc

 // Copyright 2013 The Chromium Authors. All rights reserved.
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
 #include "ui/base/ime/input_method_tsf.h"
 
 #include "ui/base/ime/text_input_client.h"
 
 namespace ui {
 
 InputMethodTSF::InputMethodTSF(internal::InputMethodDelegate* delegate,
                                HWND toplevel_window_handle)
-    : InputMethodWin(delegate, toplevel_window_handle) {
+    : InputMethodWin(delegate, toplevel_window_handle),
+      is_popup_open_(false) {
 }
 
 void InputMethodTSF::OnFocus() {
   InputMethodWin::OnFocus();
   NOTIMPLEMENTED();
 }
 
 void InputMethodTSF::OnBlur() {
   NOTIMPLEMENTED();
   InputMethodWin::OnBlur();
@@ skipping 21 matching lines @@
       // - Another application sends WM_CHAR through SendMessage API.
       original_result = OnChar(
           event.message, event.wParam, event.lParam, &handled);
       break;
     case WM_DEADCHAR:
     case WM_SYSDEADCHAR:
       // See the comment in WM_CHAR/WM_SYSCHAR.
       original_result = OnDeadChar(
           event.message, event.wParam, event.lParam, &handled);
       break;
+    case WM_IME_NOTIFY:

[Yohei Yukawa, 2013/06/19 09:23:07]

I guess WM_IME_NOTIFY is not supported on Metro mode, where IMM32-TSF
emulation layer is disabled. I think it is OK to keep
InputMethodTSF::IsPopupOpen as just a stub that always returns false,
as far as we will fix it in some follow-up CLs.

FYI, if you want to support InputMethodTSF::IsPopupOpen() in the TSF way,
you can receive appropriate notifications via
TSFEventRouterObserver::OnCandidateWindowCountChanged. You can see our
previous work in chrome/browser/ui/views/omnibox/omnibox_view_win.cc
about how to use the event.

+      original_result = OnImeNotify(
+          event.message, event.wParam, event.lParam, &handled);
+      break;
   }
   if (result)
     *result = original_result;
   return !!handled;
 }
 
 void InputMethodTSF::OnTextInputTypeChanged(const TextInputClient* client) {
   NOTIMPLEMENTED();
   InputMethodWin::OnTextInputTypeChanged(client);
 }
 
 void InputMethodTSF::OnCaretBoundsChanged(const TextInputClient* client) {
   NOTIMPLEMENTED();
 }
 
 void InputMethodTSF::CancelComposition(const TextInputClient* client) {
   NOTIMPLEMENTED();
 }
 
 void InputMethodTSF::SetFocusedTextInputClient(TextInputClient* client) {
   NOTIMPLEMENTED();
   InputMethodWin::SetFocusedTextInputClient(client);
 }
 
+bool InputMethodTSF::IsPopupOpen() const {
+  return is_popup_open_;
+}
+
 void InputMethodTSF::OnWillChangeFocusedClient(TextInputClient* focused_before,
                                                TextInputClient* focused) {
   NOTIMPLEMENTED();
 }
 
 void InputMethodTSF::OnDidChangeFocusedClient(TextInputClient* focused_before,
                                               TextInputClient* focused) {
   NOTIMPLEMENTED();
 }
 
+LRESULT InputMethodTSF::OnImeNotify(UINT message,
+                                    WPARAM wparam,
+                                    LPARAM lparam,
+                                    BOOL* handled) {
+  *handled = FALSE;
+
+  // Update |is_popup_open_|, whether a candidate window is open or not.
+  switch (wparam) {
+  case IMN_OPENCANDIDATE:
+    is_popup_open_ = true;
+    break;
+  case IMN_CLOSECANDIDATE:
+    is_popup_open_ = false;
+    break;
+  }
+
+  return 0;
+}
+
 void InputMethodTSF::ConfirmCompositionText() {
   NOTIMPLEMENTED();
 }
 
 }  // namespace ui