Add IME UI related extension API.

chrome/browser/extensions/extension_ime_ui_api.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 CHROME_BROWSER_EXTENSIONS_EXTENSION_IME_UI_API_H_
+#define CHROME_BROWSER_EXTENSIONS_EXTENSION_IME_UI_API_H_
+#pragma once
+
+#include <string>
+
+#include "base/memory/singleton.h"
+#include "base/scoped_ptr.h"
+#include "chrome/browser/extensions/extension_function.h"
+
+class ImeUiController;
+class ListValue;
+class Profile;
+
+namespace chromeos {
+class InputMethodLookupTable;
+}
+
+class ExtensionImeUiEventRouter {
+ public:
+  static ExtensionImeUiEventRouter* GetInstance();
+  void Init();
+
+ private:
+  friend class ImeUiController;
+  friend class CandidateClickedImeUiFunction;
+  friend class CursorUpImeUiFunction;
+  friend class CursorDownImeUiFunction;
+  friend class PageUpImeUiFunction;
+  friend class PageDownImeUiFunction;
+  friend class RegisterImeUiFunction;
+  friend struct DefaultSingletonTraits<ExtensionImeUiEventRouter>;
+
+  ExtensionImeUiEventRouter();
+  virtual ~ExtensionImeUiEventRouter();
+
+  void Register(Profile* profile, const std::string& extension_id);
+  void CandidateClicked(Profile* profile,
+      const std::string& extension_id, int index, int button);
+  void CursorUp(Profile* profile, const std::string& extension_id);
+  void CursorDown(Profile* profile, const std::string& extension_id);
+  void PageUp(Profile* profile, const std::string& extension_id);
+  void PageDown(Profile* profile, const std::string& extension_id);
+
+  void OnHideAuxiliaryText();
+  void OnHideLookupTable();
+  void OnSetCursorLocation(int x, int y, int width, int height);
+  void OnUpdateAuxiliaryText(const std::string& utf8_text);
+  void OnUpdateLookupTable(
+      const chromeos::InputMethodLookupTable& lookup_table);
+
+  void DispatchEvent(Profile* profile,
+                     const char* event_name,
+                     const std::string& json_args);
+
+  Profile* profile_;
+  std::string extension_id_;
+  ImeUiController* ime_ui_controller_;
+
+  DISALLOW_COPY_AND_ASSIGN(ExtensionImeUiEventRouter);
+};
+
+// Base class for input APIs.
+class ImeUiFunction : public AsyncExtensionFunction {

[Yusuke Sato, 2011/04/18 08:21:29]

The ImeUiFunction class looks exactly the same as SyncExtensionFunction in
src/chrome/browser/extensions/extension_function.h. You might want to use the
class instead.

[Peng, 2011/04/18 14:35:38]

Done.

+ public:
+  virtual void Run();
+  virtual bool RunImpl() = 0;
+};
+
+// Note that this experimental API is currently only available for
+// TOOLKIT_VIEWS (see chrome/chrome_browser.gypi).
+//
+// We may eventually support other platforms by adding the necessary
+// synthetic event distribution code to this Function.
+class RegisterImeUiFunction : public ImeUiFunction {
+ public:
+  virtual bool RunImpl();
+  DECLARE_EXTENSION_FUNCTION_NAME("experimental.ime.ui.register");
+};
+
+class CandidateClickedImeUiFunction : public ImeUiFunction {
+ public:
+  virtual bool RunImpl();
+  DECLARE_EXTENSION_FUNCTION_NAME("experimental.ime.ui.candidateClicked");
+};
+
+class CursorUpImeUiFunction : public ImeUiFunction {
+ public:
+  virtual bool RunImpl();
+  DECLARE_EXTENSION_FUNCTION_NAME("experimental.ime.ui.cursorUp");
+};
+
+class CursorDownImeUiFunction : public ImeUiFunction {
+ public:
+  virtual bool RunImpl();
+  DECLARE_EXTENSION_FUNCTION_NAME("experimental.ime.ui.cursorDown");
+};
+
+class PageUpImeUiFunction : public ImeUiFunction {
+ public:
+  virtual bool RunImpl();
+  DECLARE_EXTENSION_FUNCTION_NAME("experimental.ime.ui.pageUp");
+};
+
+class PageDownImeUiFunction : public ImeUiFunction {
+ public:
+  virtual bool RunImpl();
+  DECLARE_EXTENSION_FUNCTION_NAME("experimental.ime.ui.pageDown");
+};
+
+#endif  // CHROME_BROWSER_EXTENSIONS_EXTENSION_IME_UI_API_H_