Add IME UI related extension API.

chrome/common/extensions/api/extension_api.json

Index: chrome/common/extensions/api/extension_api.json
diff --git a/chrome/common/extensions/api/extension_api.json b/chrome/common/extensions/api/extension_api.json
index 8de6a8d1f3c7b1878209fe693ac2df0ea52742ca..36161b6a72d5e856367ffe2a2e94ed318f5768b0 100644
--- a/chrome/common/extensions/api/extension_api.json
+++ b/chrome/common/extensions/api/extension_api.json
@@ -2423,6 +2423,144 @@
     "events": []
   },
   {
+    "namespace": "experimental.inputUI",
+    "nodoc": true,

[asargent_no_longer_on_chrome, 2011/05/05 23:50:02]

FYI, while we generally haven't *required* people to generate docs for APIs that
are just being implemented in experimental, it can be very helpful to outside
developers attempting to use the API (and we usually like to try and get outside
developer input on our experimental APIs).

See this page for a list of other experimental APIs' documentation in the
current dev channel: 

http://code.google.com/chrome/extensions/dev/experimental.html

You can also look at the trunk version here:

http://src.chromium.org/viewvc/chrome/trunk/src/chrome/common/extensions/docs...

To create your own docs for this API, remove the "nodoc" line here, and then
create a template file at:

chrome/common/extensions/docs/static/experimental.inputUI.html

You can look at other files there to get a sense for the format. Then run the
chrome/common/extensions/docs/build/build.py script and the build script will
generate chrome/common/extensions/docs/experimental.inputUI.html for you, as
well as link to it inside chrome/common/extensions/docs/experimental.html. 

Anyhow, no need to hold up this CL, but I'd encourage you to do a follow-up CL
adding docs. 

[Peng, 2011/05/06 14:52:08]

Currently, this API is only used internally and only exists when touchui==1 and
chromeos==1. We do not want to public it right now. If we decide to allow
external developer develop input method ui extension in future, I will do it
later.

I added the template file, but did not remove nodoc.

On 2011/05/05 23:50:02, Antony Sargent wrote:

+    "types": [],
+    "functions": [
+      {
+        "name": "register",
+        "type": "function",
+        "description": "Register the extension, so the extension can receive the onUpdated event.",

[asargent_no_longer_on_chrome, 2011/05/05 23:50:02]

nit: I do not see any event named onUpdated. Maybe you meant
onSetCursorLocation/onUpdateAuxiliaryText/onUpdateLookupTable ?

[Peng, 2011/05/06 14:52:08]

Done.

+        "parameters": [
+          { "type": "function",
+            "name": "callback",
+            "optional": true,
+            "description": "This function is called when the event processing is completed.",
+            "parameters": []
+          }
+        ]
+      },
+      {
+        "name": "candidateClicked",
+        "type": "function",
+        "description": "Notify input method engine that a candidate was clicked.",
+        "parameters": [
+          { "type": "integer",
+            "name": "index"
+          },
+          { "type": "integer",
+            "name": "button"
+          },
+          { "type": "function",
+            "name": "callback",
+            "optional": true,
+            "description": "This function is called when the event processing is completed.",
+            "parameters": []
+          }
+        ]
+      },
+      {
+        "name": "cursorUp",
+        "type": "function",
+        "description": "Notify input method engine cursor up button was clicked.",
+        "parameters": [
+          { "type": "function",
+            "name": "callback",
+            "optional": true,
+            "description": "This function is called when the event processing is completed.",
+            "parameters": []
+          }
+        ]
+      },
+      {
+        "name": "cursorDown",
+        "type": "function",
+        "description": "Notify input method engine cursor down button was clicked.",
+        "parameters": [
+          { "type": "function",
+            "name": "callback",
+            "optional": true,
+            "description": "This function is called when the event processing is completed.",
+            "parameters": []
+          }
+        ]
+      },
+      {
+        "name": "pageUp",
+        "type": "function",
+        "description": "Notify input method engine page up button was clicked.",
+        "parameters": [
+          { "type": "function",
+            "name": "callback",
+            "optional": true,
+            "description": "This function is called when the event processing is completed.",
+            "parameters": []
+          }
+        ]
+      },
+      {
+        "name": "pageDown",
+        "type": "function",
+        "description": "Notify input method engine page down button was clicked.",
+        "parameters": [
+          { "type": "function",
+            "name": "callback",
+            "optional": true,
+            "description": "This function is called when the event processing is completed.",
+            "parameters": []
+          }
+        ]
+      }
+    ],
+    "events": [
+      {
+        "name": "onSetCursorLocation",
+        "type": "function",
+        "description": "Fired when input cursor location is changed.",
+        "parameters": [
+          { "type": "integer",
+            "name": "x"
+          },
+          { "type": "integer",
+            "name": "y"
+          },
+          { "type": "integer",
+            "name": "width"
+          },
+          { "type": "integer",
+            "name": "height"
+          }
+        ]
+      },
+      {
+        "name": "onUpdateAuxiliaryText",
+        "type": "function",
+        "description": "Fired when auxiliary text is changed.",
+        "parameters": [
+          { "type": "string",
+            "name": "text",
+            "description": "Auxiliary text."
+          }
+        ]
+      },
+      {
+        "name": "onUpdateLookupTable",
+        "type": "function",
+        "description": "Fired when lookup table is updated.",
+        "parameters": [
+          { "type": "object",
+            "properties": {
+              "visible": { "type": "boolean" },
+              "candidates": { "type": "array", "items": { "type": "string" } }
+            },
+            "description": "Lookup table"
+          }
+        ]
+      }
+
+    ]
+  },
+  {
     "namespace": "experimental.bookmarkManager",
     "nodoc": true,
     "types": [