Support TSF related event handling on NativeTextField

ui/views/controls/textfield/native_textfield_win.h

 // Copyright (c) 2012 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.
 
 #ifndef UI_VIEWS_CONTROLS_TEXTFIELD_NATIVE_TEXTFIELD_WIN_H_
 #define UI_VIEWS_CONTROLS_TEXTFIELD_NATIVE_TEXTFIELD_WIN_H_
 
 #include <atlbase.h>
 #include <atlapp.h>
 #include <atlcrack.h>
 #include <atlctrls.h>
 #include <atlmisc.h>
 #include <oleacc.h>
 #include <peninputpanel.h>
 #include <tom.h>  // For ITextDocument, a COM interface to CRichEditCtrl
 #include <vsstyle.h>
 
 #include "base/memory/scoped_ptr.h"
 #include "base/string16.h"
 #include "base/win/scoped_comptr.h"
 #include "ui/base/models/simple_menu_model.h"
+#include "ui/base/ime/win/tsf_event_router.h"
 #include "ui/gfx/insets.h"
 #include "ui/base/win/extra_sdk_defines.h"
 #include "ui/views/controls/textfield/native_textfield_wrapper.h"
 
 namespace gfx {
 class SelectionModel;
 }
 
 namespace views {
 
 class MenuRunner;
 class NativeViewHost;
 class Textfield;
 
 static const int kDefaultEditStyle = WS_CHILD | WS_VISIBLE | WS_CLIPCHILDREN |
     WS_CLIPSIBLINGS;
 
 // TODO(beng): make a subclass of NativeControlWin instead.
 class NativeTextfieldWin
     : public CWindowImpl<NativeTextfieldWin, CRichEditCtrl,
                          CWinTraits<kDefaultEditStyle> >,
       public CRichEditCommands<NativeTextfieldWin>,
       public NativeTextfieldWrapper,
-      public ui::SimpleMenuModel::Delegate {
+      public ui::SimpleMenuModel::Delegate,
+      public ui::TsfEventRouterObserver {
  public:
   DECLARE_WND_SUPERCLASS(L"ViewsTextfieldEdit", MSFTEDIT_CLASS);
 
   explicit NativeTextfieldWin(Textfield* parent);
   ~NativeTextfieldWin();
 
   // Returns true if the current point is close enough to the origin point in
   // space and time that it would be considered a double click.
   VIEWS_EXPORT static bool IsDoubleClick(const POINT& origin,
                                          const POINT& current,
@@ skipping 47 matching lines @@
   virtual int GetFontHeight() OVERRIDE;
 
   // Overridden from ui::SimpleMenuModel::Delegate:
   virtual bool IsCommandIdChecked(int command_id) const OVERRIDE;
   virtual bool IsCommandIdEnabled(int command_id) const OVERRIDE;
   virtual bool GetAcceleratorForCommandId(
       int command_id,
       ui::Accelerator* accelerator) OVERRIDE;
   virtual void ExecuteCommand(int command_id) OVERRIDE;
 
+  // Overridden from ui::TsfEventRouterObserver:
+  virtual void OnTextUpdated(const ui::Range& composition_range) OVERRIDE;
+  virtual void OnCandidateWindowCountChanged(size_t window_count) OVERRIDE;
+  virtual void OnTsfStartComposition() OVERRIDE;
+  virtual void OnTsfEndComposition() OVERRIDE;
+
   // Update accessibility information.
   void InitializeAccessibilityInfo();
   void UpdateAccessibleState(uint32 state_flag, bool set_value);
   void UpdateAccessibleValue(const string16& value);
 
   // CWindowImpl
   BEGIN_MSG_MAP(Edit)
     MSG_WM_CHAR(OnChar)
     MSG_WM_CONTEXTMENU(OnContextMenu)
     MSG_WM_COPY(OnCopy)
@@ skipping 12 matching lines @@
     MSG_WM_LBUTTONUP(OnLButtonUp)
     MSG_WM_MBUTTONDOWN(OnNonLButtonDown)
     MSG_WM_MOUSEMOVE(OnMouseMove)
     MSG_WM_MOUSELEAVE(OnMouseLeave)
     MESSAGE_HANDLER_EX(WM_MOUSEWHEEL, OnMouseWheel)
     MSG_WM_NCCALCSIZE(OnNCCalcSize)
     MSG_WM_NCPAINT(OnNCPaint)
     MSG_WM_RBUTTONDOWN(OnNonLButtonDown)
     MSG_WM_PASTE(OnPaste)
     MSG_WM_SETFOCUS(OnSetFocus)
+    MSG_WM_KILLFOCUS(OnKillFocus)
     MSG_WM_SYSCHAR(OnSysChar)  // WM_SYSxxx == WM_xxx with ALT down
     MSG_WM_SYSKEYDOWN(OnKeyDown)
   END_MSG_MAP()
 
  private:
   // This object freezes repainting of the edit until the object is destroyed.
   // Some methods of the CRichEditCtrl draw synchronously to the screen.  If we
   // don't freeze, the user will see a rapid series of calls to these as
   // flickers.
   //
@@ skipping 44 matching lines @@
   void OnLButtonDown(UINT keys, const CPoint& point);
   void OnLButtonUp(UINT keys, const CPoint& point);
   void OnMouseLeave();
   LRESULT OnMouseWheel(UINT message, WPARAM w_param, LPARAM l_param);
   void OnMouseMove(UINT keys, const CPoint& point);
   int OnNCCalcSize(BOOL w_param, LPARAM l_param);
   void OnNCPaint(HRGN region);
   void OnNonLButtonDown(UINT keys, const CPoint& point);
   void OnPaste();
   void OnSetFocus(HWND hwnd);
+  void OnKillFocus(HWND hwnd);
   void OnSysChar(TCHAR ch, UINT repeat_count, UINT flags);
 
   // Helper function for OnChar() and OnKeyDown() that handles keystrokes that
   // could change the text in the edit.
   // Note: This function assumes GetCurrentMessage() returns a MSG with
   // msg > WM_KEYFIRST and < WM_KEYLAST.
   void HandleKeystroke();
 
   // Every piece of code that can change the edit should call these functions
   // before and after the change.  These functions determine if anything
@@ skipping 19 matching lines @@
   // doesn't click on the text itself.
   //
   // |is_triple_click| should be true iff this is the third click of a triple
   // click.  Sadly, we need to clip slightly differently in this case.
   LONG ClipXCoordToVisibleText(LONG x, bool is_triple_click) const;
 
   // Sets whether the mouse is in the edit. As necessary this redraws the
   // edit.
   void SetContainsMouse(bool contains_mouse);
 
+  // Handles composition related works on both IMM32 and TSF implementation.
+  void OnImeStartCompositionInternal();
+  void OnImeEndCompositionInternal();
+
   // Getter for the text_object_model_, used by the ScopedFreeze class.  Note
   // that the pointer returned here is only valid as long as the Edit is still
   // alive.
   ITextDocument* GetTextObjectModel() const;
 
   // Generates the contents of the context menu.
   void BuildContextMenu();
 
   static HMODULE loaded_libarary_module_;
 
@@ skipping 37 matching lines @@
   int ime_composition_length_;
 
   // TODO(beng): remove this when we are a subclass of NativeControlWin.
   NativeViewHost* container_view_;
 
   COLORREF bg_color_;
 
   //  The accessibility state of this object.
   int accessibility_state_;
 
+  scoped_ptr<ui::TsfEventRouter> tsf_event_router_;
+
   DISALLOW_COPY_AND_ASSIGN(NativeTextfieldWin);
 };
 
 }  // namespace views
 
 #endif  // UI_VIEWS_CONTROLS_TEXTFIELD_NATIVE_TEXTFIELD_WIN_H_