Integrate the new input method API for Views into Chromium.

views/controls/textfield/native_textfield_views.h

 // Copyright (c) 2011 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 VIEWS_CONTROLS_TEXTFIELD_NATIVE_TEXTFIELD_VIEWS_H_
 #define VIEWS_CONTROLS_TEXTFIELD_NATIVE_TEXTFIELD_VIEWS_H_
 #pragma once
 
 #include "base/string16.h"
 #include "base/task.h"
 #include "ui/base/models/simple_menu_model.h"
 #include "ui/gfx/font.h"
 #include "views/border.h"
 #include "views/controls/textfield/native_textfield_wrapper.h"
+#include "views/controls/textfield/textfield_views_model.h"
+#include "views/ime/text_input_client.h"
 #include "views/view.h"
 
 namespace base {
 class Time;
 }
 
 namespace gfx {
 class Canvas;
 }
 
 namespace views {
 
 class KeyEvent;
 class Menu2;
-class TextfieldViewsModel;
 
 // A views/skia only implementation of NativeTextfieldWrapper.
 // No platform specific code is used.
 // Following features are not yet supported.
 // * BIDI
 // * IME/i18n support.
 // * X selection (only if we want to support).
 // * STYLE_MULTILINE, STYLE_LOWERCASE text. (These are not used in
 //   chromeos, so we may not need them)
 // * Double click to select word, and triple click to select all.
 // * Undo/Redo
 class NativeTextfieldViews : public views::View,
                              public views::ContextMenuController,
                              public NativeTextfieldWrapper,
-                             public ui::SimpleMenuModel::Delegate {
+                             public ui::SimpleMenuModel::Delegate,
+                             public TextInputClient,
+                             public TextfieldViewsModel::Delegate {
  public:
   explicit NativeTextfieldViews(Textfield* parent);
   ~NativeTextfieldViews();
 
   // views::View overrides:
   virtual bool OnMousePressed(const views::MouseEvent& e) OVERRIDE;
   virtual bool OnMouseDragged(const views::MouseEvent& e) OVERRIDE;
   virtual void OnMouseReleased(const views::MouseEvent& e,
                                bool canceled) OVERRIDE;
   virtual bool OnKeyPressed(const views::KeyEvent& e) OVERRIDE;
@@ skipping 30 matching lines @@
   virtual View* GetView() OVERRIDE;
   virtual gfx::NativeView GetTestingHandle() const OVERRIDE;
   virtual bool IsIMEComposing() const OVERRIDE;
   virtual void GetSelectedRange(ui::Range* range) const OVERRIDE;
   virtual void SelectRange(const ui::Range& range) OVERRIDE;
   virtual size_t GetCursorPosition() const OVERRIDE;
   virtual bool HandleKeyPressed(const views::KeyEvent& e) OVERRIDE;
   virtual bool HandleKeyReleased(const views::KeyEvent& e) OVERRIDE;
   virtual void HandleFocus() OVERRIDE;
   virtual void HandleBlur() OVERRIDE;
+  virtual TextInputClient* GetTextInputClient() OVERRIDE;
 
   // ui::SimpleMenuModel::Delegate overrides
   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;
 
   // class name of internal
@@ skipping 37 matching lines @@
       has_focus_ = has_focus;
     }
 
    private:
     bool has_focus_;
     gfx::Insets insets_;
 
     DISALLOW_COPY_AND_ASSIGN(TextfieldBorder);
   };
 
+  // Overridden from TextInputClient:
+  virtual void SetCompositionText(
+      const ui::CompositionText& composition) OVERRIDE;
+  virtual void ConfirmCompositionText() OVERRIDE;
+  virtual void ClearCompositionText() OVERRIDE;
+  virtual void InsertText(const string16& text) OVERRIDE;
+  virtual void InsertChar(char16 ch, int flags) OVERRIDE;
+  virtual ui::TextInputType GetTextInputType() OVERRIDE;
+  virtual gfx::Rect GetCaretBounds() OVERRIDE;
+  virtual bool HasCompositionText() OVERRIDE;
+  virtual bool GetTextRange(ui::Range* range) OVERRIDE;
+  virtual bool GetCompositionTextRange(ui::Range* range) OVERRIDE;
+  virtual bool GetSelectionRange(ui::Range* range) OVERRIDE;
+  virtual bool SetSelectionRange(const ui::Range& range) OVERRIDE;
+  virtual bool DeleteRange(const ui::Range& range) OVERRIDE;
+  virtual bool GetTextFromRange(
+      const ui::Range& range,
+      const base::Callback<void(const string16&)>& callback) OVERRIDE;
+  virtual void OnInputMethodChanged() OVERRIDE;
+  virtual bool ChangeTextDirectionAndLayoutAlignment(
+      base::i18n::TextDirection direction) OVERRIDE;
+
+  // Overridden from TextfieldViewsModel::Delegate:
+  virtual void OnCompositionTextConfirmedOrCleared() OVERRIDE;
+
   // Returns the Textfield's font.
   const gfx::Font& GetFont() const;
 
   // Returns the Textfield's text color.
   SkColor GetTextColor() const;
 
   // A callback function to periodically update the cursor state.
   void UpdateCursor();
 
   // Repaint the cursor.
@@ skipping 21 matching lines @@
   // that the text in the textfield has changed.
   void PropagateTextChange();
 
   // Does necessary updates when the text and/or the position of the cursor
   // changed.
   void UpdateAfterChange(bool text_changed, bool cursor_changed);
 
   // Utility function to create the context menu if one does not already exist.
   void InitContextMenuIfRequired();
 
+  // Convenience method to call InputMethod::OnTextInputTypeChanged();
+  void OnTextInputTypeChanged();
+
+  // Convenience method to call InputMethod::OnCaretBoundsChanged();
+  void OnCaretBoundsChanged();
+
   // Convenience method to call TextfieldController::OnBeforeUserAction();
   void OnBeforeUserAction();
 
   // Convenience method to call TextfieldController::OnAfterUserAction();
   void OnAfterUserAction();
 
   // Checks if a char is ok to be inserted into the textfield. The |ch| is a
   // modified character, i.e., modifiers took effect when generating this char.
   static bool ShouldInsertChar(char16 ch, int flags);
 
   // The parent textfield, the owner of this object.
   Textfield* textfield_;
 
   // The text model.
   scoped_ptr<TextfieldViewsModel> model_;
 
   // The reference to the border class. The object is owned by View::border_.
   TextfieldBorder* text_border_;
 
   // The x offset for the text to be drawn, without insets;
   int text_offset_;
 
   // Cursor's bounds in the textfield's coordinates.
   gfx::Rect cursor_bounds_;

[oshima, 2011/03/30 21:06:34]

If we can assume input_method is always present, moving this to input method may
simplify the code. What do you think?

[James Su, 2011/03/30 21:30:32]

|cursor_bounds_| is also used in painting code, I doubt if we can remove it
without significant code change.

 
   // True if the textfield is in insert mode.
   bool insert_;
 
   // The drawing state of cursor. True to draw.
   bool is_cursor_visible_;
 
+  // True if InputMethod::CancelComposition() should not be called.
+  bool skip_input_method_cancel_composition_;
+
   // A runnable method factory for callback to update the cursor.
   ScopedRunnableMethodFactory<NativeTextfieldViews> cursor_timer_;
 
   // Time of last LEFT mouse press. Used for tracking double/triple click.
   base::Time last_mouse_press_time_;
 
   // Position of last LEFT mouse press. Used for tracking double/triple click.
   gfx::Point last_mouse_press_location_;
 
   // State variable to track double and triple clicks.
   ClickState click_state_;
 
   // Context menu and its content list for the textfield.
   scoped_ptr<ui::SimpleMenuModel> context_menu_contents_;
   scoped_ptr<Menu2> context_menu_menu_;
 
   DISALLOW_COPY_AND_ASSIGN(NativeTextfieldViews);
 };
 
 }  // namespace views
 
 #endif  // VIEWS_CONTROLS_TEXTFIELD_NATIVE_TEXTFIELD_VIEWS_H_