New method: InputMethod::IsCandidatePopupOpen()

ui/base/ime/input_method_tsf.cc

 // Copyright (c) 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"
 #include "ui/base/ime/win/tsf_bridge.h"
 
 namespace ui {
 
 InputMethodTSF::InputMethodTSF(internal::InputMethodDelegate* delegate,
                                HWND toplevel_window_handle)
-    : InputMethodWin(delegate, toplevel_window_handle) {
+    : InputMethodWin(delegate, toplevel_window_handle),
+      is_candidate_popup_open_(false) {
   // In non-Aura environment, appropriate callbacks to OnFocus() and OnBlur()
   // are not implemented yet. To work around this limitation, here we use
   // "always focused" model.
   // TODO(ime): Fix the caller of OnFocus() and OnBlur() so that appropriate
   // focus event will be passed.
   InputMethodWin::OnFocus();
 }
 
 void InputMethodTSF::OnFocus() {
   // Ignore OnFocus event for "always focused" model. See the comment in the
@@ skipping 29 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/21 06:45:47]

Wait.

Please do not handle WM_IME_NOTIFY when TSF is enabled.
It was not a right way as I commented previously.

+      original_result = OnImeNotify(
+          event.message, event.wParam, event.lParam, &handled);
+      break;
   }
   if (result)
     *result = original_result;
   return !!handled;
 }
 
 void InputMethodTSF::OnTextInputTypeChanged(const TextInputClient* client) {
   if (IsTextInputClientFocused(client) && IsWindowFocused(client)) {
     ui::TSFBridge::GetInstance()->CancelComposition();
     ui::TSFBridge::GetInstance()->OnTextInputTypeChanged(client);
@@ skipping 12 matching lines @@
 }
 
 void InputMethodTSF::SetFocusedTextInputClient(TextInputClient* client) {
   if (IsWindowFocused(client)) {
     ui::TSFBridge::GetInstance()->SetFocusedClient(
         GetAttachedWindowHandle(client), client);
   }
   InputMethodWin::SetFocusedTextInputClient(client);
 }
 
+bool InputMethodTSF::IsCandidatePopupOpen() const {
+  return is_candidate_popup_open_;
+}
+
 void InputMethodTSF::OnWillChangeFocusedClient(TextInputClient* focused_before,
                                                TextInputClient* focused) {
   if (IsWindowFocused(focused_before)) {
     ConfirmCompositionText();
     ui::TSFBridge::GetInstance()->RemoveFocusedClient(focused_before);
   }
 }
 
 void InputMethodTSF::OnDidChangeFocusedClient(TextInputClient* focused_before,
                                               TextInputClient* focused) {
   if (IsWindowFocused(focused)) {
     ui::TSFBridge::GetInstance()->SetFocusedClient(
         GetAttachedWindowHandle(focused), focused);
     // Force to update the input type since client's TextInputStateChanged()
     // function might not be called if text input types before the client loses
     // focus and after it acquires focus again are the same.
     OnTextInputTypeChanged(focused);
 
     // Force to update caret bounds, in case the client thinks that the caret
     // bounds has not changed.
     OnCaretBoundsChanged(focused);
   }
 }
 
+LRESULT InputMethodTSF::OnImeNotify(UINT message,
+                                    WPARAM wparam,
+                                    LPARAM lparam,
+                                    BOOL* handled) {
+  *handled = FALSE;
+
+  // Update |is_candidate_popup_open_|, whether a candidate window is open.
+  switch (wparam) {
+  case IMN_OPENCANDIDATE:
+    is_candidate_popup_open_ = true;
+    break;
+  case IMN_CLOSECANDIDATE:
+    is_candidate_popup_open_ = false;
+    break;
+  }
+
+  return 0;
+}
+
 void InputMethodTSF::ConfirmCompositionText() {
   if (!IsTextInputTypeNone()) {
     // TSFBridge has not implemented ConfirmComposition yet. So here cancel
     // the composition instead as a workaround.
     // TODO(ime): Implement ConfirmComposition for TSF.
     ui::TSFBridge::GetInstance()->CancelComposition();
   }
 }
 
 bool InputMethodTSF::IsWindowFocused(const TextInputClient* client) const {
   if (!client)
     return false;
   HWND attached_window_handle = GetAttachedWindowHandle(client);
   return attached_window_handle && GetFocus() == attached_window_handle;
 }
 
 }  // namespace ui