chrome/common/extensions/api/input_method_private.json

   1 // Copyright (c) 2012 The Chromium Authors. All rights reserved.
   2 // Use of this source code is governed by a BSD-style license that can be
   3 // found in the LICENSE file.
   4
   5 [
   6   {
   7     "namespace": "inputMethodPrivate",
   8     "platforms": ["chromeos"],
   9     "description": "none",
  10     "functions": [
  11       {
  12         "name": "getInputMethodConfig",
  13         "type": "function",
  14         "description": "Gets configurations for input methods.",
  15         "parameters": [
  16           {
  17             "name": "callback",
  18             "type": "function",
  19             "optional": false,
  20             "description": "Callback which is called with the config object.",
  21             "parameters": [
  22               {
  23                 "name": "config",
  24                 "type": "object",
  25                 "description": "The input method config object.",
  26                 "properties": {
  27                   "isPhysicalKeyboardAutocorrectEnabled": {"type": "boolean"},
  28                   "isNewQPInputViewEnabled": {"type": "boolean"},
  29                   "isVoiceInputEnabled": {"type": "boolean"}
  30                 }
  31               }
  32             ]
  33           }
  34         ]
  35       }, {
  36         "name": "getInputMethods",
  37         "type": "function",
  38         "description": "Gets all whitelisted input methods.",
  39         "parameters": [
  40           {
  41             "name": "callback",
  42             "type": "function",
  43             "optional": false,
  44             "description": "Callback which is called with the input method objects.",
  45             "parameters": [
  46               {
  47                 "name": "inputMethods",
  48                 "type": "array",
  49                 "description": "Whitelisted input method objects.",
  50                 "items": {
  51                   "type": "object",
  52                   "properties": {
  53                     "id": {"type": "string"},
  54                     "name": {"type": "string"},
  55                     "indicator": {"type": "string"}
  56                   }
  57                 }
  58               }
  59             ]
  60           }
  61         ]
  62       }, {
  63         "name": "getCurrentInputMethod",
  64         "type": "function",
  65         "description": "Gets the current input method.",
  66         "parameters": [
  67           {
  68             "name": "callback",
  69             "type": "function",
  70             "optional": false,
  71             "description": "Callback which is called with the current input method.",
  72             "parameters": [
  73               {
  74                 "name": "inputMethodId",
  75                 "type": "string",
  76                 "description": "Current input method."
  77               }
  78             ]
  79           }
  80         ]
  81       }, {
  82         "name": "setCurrentInputMethod",
  83         "type": "function",
  84         "description": "Sets the current input method.",
  85         "parameters": [
  86           {
  87             "name": "inputMethodId",
  88             "type": "string",
  89             "optional": false,
  90             "description": "The input method ID to be set as current input method."
  91           },
  92           {
  93             "name": "callback",
  94             "type": "function",
  95             "optional": true,
  96             "description": "Callback which is called once the current input method is set or error occurs.",
  97             "parameters": []
  98           }
  99         ]
 100       }
 101     ],
 102     "events": [
 103       {
 104         "name": "onChanged",
 105         "type": "function",
 106         "description": "Fired when the input method is changed.",
 107         "parameters": [
 108           {
 109             "name": "newInputMethodId",
 110             "type": "string",
 111             "description": "New input method which is being used."
 112           }
 113         ]
 114       }, {
 115         "name": "onCompositionBoundsChanged",
 116         "type": "function",
 117         "description": "Fired when the composition bounds or cursor bounds are changed.",
 118         "parameters": [
 119           {
 120             "name": "bounds",
 121             "type": "array",
 122             "description": "List of bounds information.",
 123             "items": {
 124               "type": "object",
 125               "properties": {
 126                 "x": {"type": "integer"},
 127                 "y": {"type": "integer"},
 128                 "w": {"type": "integer"},
 129                 "h": {"type": "integer"}
 130               }
 131             }
 132           }
 133         ]
 134       }
 135     ]
 136   }
 137 ]