IME (input method editor) support for Aura, part 3 of 3: Use ui::InputMethod in ash.

ui/aura/event.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 UI_AURA_EVENT_H_
 #define UI_AURA_EVENT_H_
 #pragma once
 
 #include "base/basictypes.h"
 #include "base/event_types.h"
@@ skipping 163 matching lines @@
  private:
   ui::KeyboardCode key_code_;
   // True if this is a translated character event (vs. a raw key down). Both
   // share the same type: ui::ET_KEY_PRESSED.
   bool is_char_;
 
   uint16 character_;
   uint16 unmodified_character_;
 };
 
+// A key event which is translated by an input method (IME).
+// For example, if an IME receives a KeyEvent(ui::VKEY_SPACE), and it does not
+// consume the key, the IME usually generates and dispatches a
+// TranslatedKeyEvent(ui::VKEY_SPACE) event. If the IME receives a KeyEvent and
+// it does consume the event, it might dispatch a
+// TranslatedKeyEvent(ui::VKEY_PROCESSKEY) event as defined in the DOM spec.
+class AURA_EXPORT TranslatedKeyEvent : public KeyEvent {

[Ben Goodger (Google), 2011/12/14 15:30:21]

Sorry, when I mentioned "different event type" what I meant was a different
value in the ui/base/event types enumeration... then you would just continue to
pass plain KeyEvent*s to everyone, avoiding the need to adjust the event filter
interface with knowledge of the translated type. You can feel free to keep this
class to help with constructing them (if the ctor has a substantially different
signature to KeyEvent's), but I think it probably better goes in
ui/aura_shell/events.h/cc (you'd have to make a new file, I'm considering moving
DropTargetEvent there too).

[Yusuke Sato, 2011/12/15 06:29:59]

oh I see. I've modified the code as follows:

- Revert all changes related to the EventFilter interface.
- Add two event type enum values to ui/base/events.h
- Move the TranslatedKeyEvent class to ui/aura_shell/event.h. 

Now classes under ui/aura/ don't know anything about the new event types and the
new event class. Only the new event filter for aura_shell,
aura_shell::InputMethodEventFIlter, uses the new types/class.

+ public:
+  TranslatedKeyEvent(const base::NativeEvent& native_event, bool is_char);
+
+  // Used for synthetic events such as a VKEY_PROCESSKEY key event.
+  TranslatedKeyEvent(ui::EventType type,
+                     ui::KeyboardCode key_code,
+                     int flags);
+};
+
 class AURA_EXPORT DropTargetEvent : public LocatedEvent {
  public:
   DropTargetEvent(const ui::OSExchangeData& data,
                   const gfx::Point& location,
                   int source_operations)
       : LocatedEvent(ui::ET_DROP_TARGET_EVENT, location, 0),
         data_(data),
         source_operations_(source_operations) {
   }
 
   const ui::OSExchangeData& data() const { return data_; }
   int source_operations() const { return source_operations_; }
 
  private:
   // Data associated with the drag/drop session.
   const ui::OSExchangeData& data_;
 
   // Bitmask of supported ui::DragDropTypes::DragOperation by the source.
   int source_operations_;
 
   DISALLOW_COPY_AND_ASSIGN(DropTargetEvent);
 };
 
 }  // namespace aura
 
 #endif  // UI_AURA_EVENT_H_