IME for Mus: Add ui.mojom.CompositionText and its struct traits.

services/ui/public/interfaces/ime/ime.mojom

 // Copyright 2016 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.
 
 module ui.mojom;
 
 import "ui/events/mojo/event.mojom";
 import "ui/gfx/geometry/mojo/geometry.mojom";
+import "ui/gfx/range/mojo/range.mojom";
 
-struct CompositionEvent {
-  CompositionEventType type;
-
-  // Used when |type| is INSERT_CHAR. See the comments for
-  // ui::TextInputClient::InsertChar() for more information.
-  Event? key_event;
-
-  // TODO(moshayedi): crbug.com/631524. Add fields required for other types of
-  // composition event.
+// Represents an underlined segment of text currently composed by IME.
+// Corresponds to ui::CompositionUnderline.
+struct CompositionUnderline {
+  uint32 start_offset;
+  uint32 end_offset;
+  bool thick;
+  uint32 color;
+  uint32 background_color;
 };
 
-enum CompositionEventType {
-  UPDATE,
-  CONFIRM,
-  CLEAR,
-  INSERT_CHAR,
-  INSERT_TEXT
+// Represents a text currently being composed by IME. Corresponds to
+// ui::CompositionText.
+struct CompositionText {
+  string text;
+  array<CompositionUnderline> underlines;
+  gfx.mojom.Range selection;
 };
 
 // See comments for ui::TextInputType for more details.
 enum TextInputType {
   NONE,
   TEXT,
   PASSWORD,
   SEARCH,
   EMAIL,
   NUMBER,
@@ skipping 52 matching lines @@
   OnTextInputModeChanged(TextInputMode text_input_mode);
   OnTextInputTypeChanged(TextInputType text_input_type);
 
   // Client sends |caret_bounds| in focused window coordinates,
   // Mus translates it to global coordinates and sends it to IME app.
   OnCaretBoundsChanged(gfx.mojom.Rect caret_bounds);
 
   // Called to process a key event. The callback function will be called to
   // notify the client if the event was handled or not. A handled event may
   // generate zero or more composition events which will be sent to the client
-  // by calling TextInputClient::OnCompositionEvent().
+  // using the "input method result" functions of TextInputClient interface.
   ProcessKeyEvent(ui.mojom.Event key_event) => (bool handled);
 
   CancelComposition();
 };
 
 // IME drivers send updates to clients using the TextInputClient interface.
 interface TextInputClient {
-  // Corresponds to "input method result" functions of ui::TextInputClient.
-  // See comments for InputMethod::ProcessKeyEvent() for when this is called.
-  OnCompositionEvent(CompositionEvent event);
+  // Functions corresponding to "input method result" functions of
+  // ui::TextInputClient. See comments for InputMethod::ProcessKeyEvent() for
+  // when these are called.
+  SetCompositionText(CompositionText composition);
+  ConfirmCompositionText();
+  ClearCompositionText();
+  InsertText(string text);
+  InsertChar(ui.mojom.Event event);
 
   // TODO(moshayedi): Add functions corresponding to ui::TextInputClient for:
   // - Input text confirmation
   // - Document content operations
   // - Miscellaneous functions
   // crbug.com/631527.

[sadrul, 2016/11/29 20:51:35]

Should this TODO be updated?

[Hadi, 2016/11/29 21:33:37]

"Input text confirmation" should have been "Input context information". Fixed
it. We don't have those functions here yet.

 };