Revise IBusEngineService.

chromeos/dbus/ibus/ibus_engine_service.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 CHROMEOS_DBUS_IBUS_IBUS_ENGINE_SERVICE_H_
 #define CHROMEOS_DBUS_IBUS_IBUS_ENGINE_SERVICE_H_
 
 #include <string>
 #include "base/bind.h"
 #include "base/callback.h"
@@ skipping 12 matching lines @@
 namespace ibus {
 class IBusLookupTable;
 class IBusProperty;
 class IBusText;
 typedef ScopedVector<IBusProperty> IBusPropertyList;
 }  // namespace
 
 // A interface to handle the engine client method call.
 class CHROMEOS_EXPORT IBusEngineHandlerInterface {
  public:
+  typedef base::Callback<void (bool consumed)> KeyEventDoneCallback;
+
   // Following capability mask is introduced from
   // http://ibus.googlecode.com/svn/docs/ibus-1.4/ibus-ibustypes.html#IBusCapabilite
   // TODO(nona): Move to ibus_contants and merge one in ui/base/ime/*
   enum IBusCapability {
     IBUS_CAPABILITY_PREEDIT_TEXT = 1U,
     IBUS_CAPABILITY_FOCUS = 8U,
   };
 
   // Following property state value is introduced from
   // http://ibus.googlecode.com/svn/docs/ibus-1.4/IBusProperty.html#IBusPropState
@@ skipping 37 matching lines @@
 
   // Called when the Chrome input field set their capabilities.
   virtual void SetCapability(IBusCapability capability) = 0;
 
   // Called when the IME is reset.
   virtual void Reset() = 0;
 
   // Called when the key event is received. The |keycode| is raw layout
   // independent keycode. The |keysym| is result of XLookupString function
   // which translate |keycode| to keyboard layout dependent symbol value.
+  // Actual implementation must call |callback| after key event handling.
   // For example: key press event for 'd' key on us layout and dvorak layout.
   //                  keyval keycode state
   //      us layout :  0x64   0x20    0x00
   //  dvorak layout :  0x65   0x20    0x00
-  virtual bool ProcessKeyEvent(uint32 keysym, uint32 keycode, uint32 state) = 0;
+  virtual void ProcessKeyEvent(uint32 keysym, uint32 keycode, uint32 state,
+                               const KeyEventDoneCallback& callback) = 0;
 
   // Called when the candidate in lookup table is clicked. The |index| is 0
   // based candidate index in lookup table. The |state| is same value as
   // GdkModifierType in
   // http://developer.gnome.org/gdk/stable/gdk-Windows.html#GdkModifierType
   virtual void CandidateClicked(uint32 index, IBusMouseButton button,
                                 uint32 state) = 0;
 
   // Called when a new surrounding text is set. The |text| is surrounding text
   // and |cursor_pos| is 0 based index of cursor position in |text|. If there is
@@ skipping 37 matching lines @@
                                    bool is_visible) = 0;
   // Emits UpdateLookupTable signal.
   virtual void UpdateLookupTable(const ibus::IBusLookupTable& lookup_table,
                                  bool is_visible) = 0;
   // Emits UpdateProperty signal.
   virtual void UpdateProperty(const ibus::IBusProperty& property) = 0;
   // Emits ForwardKeyEvent signal.
   virtual void ForwardKeyEvent(uint32 keyval, uint32 keycode, uint32 state) = 0;
   // Emits RequireSurroundingText signal.
   virtual void RequireSurroundingText() = 0;
+  // Emits CommitText signal.
+  virtual void CommitText(const std::string& text) = 0;
 
   // Factory function, creates a new instance and returns ownership.
   // For normal usage, access the singleton via DBusThreadManager::Get().
   static CHROMEOS_EXPORT IBusEngineService* Create(
       DBusClientImplementationType type,
       dbus::Bus* bus,
       const dbus::ObjectPath& object_path);
 
  protected:
   // Create() should be used instead.
   IBusEngineService();
 
  private:
   DISALLOW_COPY_AND_ASSIGN(IBusEngineService);
 };
 
 }  // namespace chromeos
 
 #endif  // CHROMEOS_DBUS_IBUS_IBUS_ENGINE_SERVICE_H_