Integrating GtkIMContext into the RenderWidgetHostViewGtk class (Take 2)....

chrome/browser/renderer_host/render_widget_host.h

 // Copyright (c) 2009 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 CHROME_BROWSER_RENDERER_HOST_RENDER_WIDGET_HOST_H_
 #define CHROME_BROWSER_RENDERER_HOST_RENDER_WIDGET_HOST_H_
 
 #include <queue>
 #include <vector>
 
@@ skipping 263 matching lines @@
   //   }
   // Once we cancel updating the text direction, we have to ignore all
   // succeeding UpdateTextDirection() requests until calling
   // NotifyTextDirection(). (We may receive keydown events even after we
   // canceled updating the text direction because of auto-repeat.)
   // Note: we cannot undo this change for compatibility with Firefox and IE.
   void UpdateTextDirection(WebTextDirection direction);
   void CancelUpdateTextDirection();
   void NotifyTextDirection();
 
+  // Notifies the renderer whether or not the IME attached to this process is
+  // activated.
+  // When the IME is activated, a renderer process sends IPC messages to notify
+  // the status of its composition node. (This message is mainly used for
+  // notifying the position of the input cursor so that the browser can
+  // display IME windows under the cursor.)
+  void ImeSetInputMode(bool activate);
+
+  // Update the composition node of the renderer (or WebKit).
+  // WebKit has a special node (a composition node) for IMEs to change its text
+  // without affecting any other DOM nodes. When the IME (attached to the
+  // browser) updates its text, the browser sends IPC messages to update the
+  // composition node of the renderer.
+  // (Read the comments of each function for its detail.)
+
+  // Sets the text of the composition node.
+  // This function can also update the cursor position and mark the specified
+  // range in the composition node.
+  // A browser should call this function:
+  // * when it receives a WM_IME_COMPOSITION message with a GCS_COMPSTR flag
+  //   (on Windows);
+  // * when it receives a "preedit_changed" signal of GtkIMContext (on Linux);
+  // * when markedText of NSTextInput is called (on Mac).
+  void ImeSetComposition(const std::wstring& ime_string,
+                         int cursor_position,
+                         int target_start,
+                         int target_end);
+
+  // Finishes an ongoing composition with the specified text.
+  // A browser should call this function:
+  // * when it receives a WM_IME_COMPOSITION message with a GCS_RESULTSTR flag
+  //   (on Windows);
+  // * when it receives a "commit" signal of GtkIMContext (on Linux);
+  // * when insertText of NSTextInput is called (on Mac).
+  void ImeConfirmComposition(const std::wstring& ime_string);
+
+  // Cancels an ongoing composition.
+  void ImeCancelComposition();
+
   // This is for derived classes to give us access to the resizer rect.
   // And to also expose it to the RenderWidgetHostView.
   virtual gfx::Rect GetRootWindowResizerRect() const;
 
  protected:
   // Internal implementation of the public Forward*Event() methods.
   void ForwardInputEvent(
       const WebKit::WebInputEvent& input_event, int event_size);
 
   // Called when we receive a notification indicating that the renderer
@@ skipping 165 matching lines @@
 
   // Set when we cancel updating the text direction.
   // This flag also ignores succeeding update requests until we call
   // NotifyTextDirection().
   bool text_direction_canceled_;
 
   DISALLOW_COPY_AND_ASSIGN(RenderWidgetHost);
 };
 
 #endif  // CHROME_BROWSER_RENDERER_HOST_RENDER_WIDGET_HOST_H_