Add IME UI related extension API.

chrome/common/extensions/api/extension_api.json

 [
   {
     "namespace": "extension",
     "unprivileged": true,
     "types": [
       {
         "id": "MessageSender",
         "type": "object",
         "description": "An object containing information about the script context that sent a message or request.",
         "properties": {
@@ skipping 2350 matching lines @@
         ],
         "returns": {
           "type": "string",
           "description": "Message localized for current locale."
         }
       }
     ],
     "events": []
   },
   {
+    "namespace": "experimental.ime.ui",

[Peng, 2011/04/15 21:16:11]

I use name space experimental.ime.ui temporarily. I am not sure what's a good
name space for those APIs. How about experimental.input.imeui?

[Zachary Kuznia, 2011/04/18 03:52:29]

I think experiemental.input is a better place.  imeui is a little hard to read,
how about input.candidates or candidateList?


On 2011/04/15 21:16:11, Peng wrote:

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

I think we need to find a good way to organize IME APIs. In ibus, methods are
bound with IBusBus, IBusPanelService, IBusEngine and etc classes. In IME
extension API, I think it is better to separate them to several name spaces too.
It will be more developer friendly.

Why I use ime.ui is because I may add some APIs for switching IME, and some
focus related events in this namespace later. So the name candidates is too
limited.

How about input.ime.engine for Engine related API, and input.ime.ui for UI
related API?

On 2011/04/18 03:52:29, Zachary Kuznia wrote:

+    "nodoc": true,
+    "types": [],
+    "functions": [
+      {
+        "name": "register",
+        "type": "function",
+        "description": "Register the extension, so the extension can receive the onUpdated event.",
+        "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 buttion 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 buttion 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 buttion 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 buttion 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.input",
     "nodoc": true,
     "types": [],
     "functions": [
       {
         "name": "sendKeyboardEvent",
         "type": "function",
         "description": "Send a keyboard event to Chrome.",
         "parameters": [
           { "type": "object",
@@ skipping 2679 matching lines @@
           {
             "type": "integer",
             "name": "tabId",
             "description": "The id of the tab that was detached."
           }
         ]
       }
     ]
   }
 ]