| OLD | NEW |
| (Empty) | |
| 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": "experimental.accessibility", |
| 8 "nodoc": true, |
| 9 "types": [ |
| 10 { |
| 11 "id": "AccessibilityObject", |
| 12 "type": "object", |
| 13 "description": "Parent class for accessibility information about an obje
ct.", |
| 14 "properties": { |
| 15 "type": { |
| 16 "type": "string", |
| 17 "description": "The type of this object, which determines the conten
ts of 'details'.", |
| 18 "enum": ["button", "checkbox", "combobox", "link", "menu", "menuitem
", "radiobutton", "slider", "tab", "textbox", "window"] |
| 19 }, |
| 20 "name": { |
| 21 "type": "string", |
| 22 "description": "The localized name of the object, like OK or Passwor
d. Do not rely on an exact string match because the text will be in the user's l
anguage and may change in the future." |
| 23 }, |
| 24 "context": { |
| 25 "type": "string", |
| 26 "description": "The localized name of the context for the object, li
ke the name of the surrounding toolbar or group of controls.", |
| 27 "optional": true |
| 28 }, |
| 29 "details": { |
| 30 "description": "Other details like the state, depending on the type
of object.", |
| 31 "optional": true, |
| 32 "choices": [ |
| 33 { "$ref": "CheckboxDetails" }, |
| 34 { "$ref": "ComboBoxDetails" }, |
| 35 { "$ref": "MenuDetails" }, |
| 36 { "$ref": "MenuItemDetails" }, |
| 37 { "$ref": "RadioButtonDetails" }, |
| 38 { "$ref": "SliderDetails" }, |
| 39 { "$ref": "TabDetails" }, |
| 40 { "$ref": "TextBoxDetails" } |
| 41 ] |
| 42 } |
| 43 } |
| 44 }, |
| 45 { |
| 46 "id": "CheckboxDetails", |
| 47 "type": "object", |
| 48 "description": "Information about the state of a checkbox.", |
| 49 "properties": { |
| 50 "isChecked": {"type": "boolean", "description": "True if this checkbox
is checked."} |
| 51 } |
| 52 }, |
| 53 { |
| 54 "id": "ComboBoxDetails", |
| 55 "type": "object", |
| 56 "description": "Information about the state of a combo box.", |
| 57 "properties": { |
| 58 "value": {"type": "string", "description": "The value of the combo box
."}, |
| 59 "itemCount": {"type": "integer", "description": "The number of items i
n the combo box's list."}, |
| 60 "itemIndex": {"type": "integer", "description": "The 0-based index of
the current value, or -1 if the user entered a value not from the list."} |
| 61 } |
| 62 }, |
| 63 { |
| 64 "id": "ListBoxDetails", |
| 65 "type": "object", |
| 66 "description": "Information about the state of a list box.", |
| 67 "properties": { |
| 68 "value": {"type": "string", "description": "The value of the list box.
"}, |
| 69 "itemCount": {"type": "integer", "description": "The number of items i
n the list."}, |
| 70 "itemIndex": {"type": "integer", "description": "The 0-based index of
the selected value, or -1 if no items are selected."} |
| 71 } |
| 72 }, |
| 73 { |
| 74 "id": "MenuDetails", |
| 75 "type": "object", |
| 76 "description": "Information about the state of a drop-down menu.", |
| 77 "properties": { |
| 78 } |
| 79 }, |
| 80 { |
| 81 "id": "MenuItemDetails", |
| 82 "type": "object", |
| 83 "description": "Information about a menu item.", |
| 84 "properties": { |
| 85 "hasSubmenu": {"type": "boolean", "description": "True if this item op
ens a submenu."}, |
| 86 "itemCount": {"type": "integer", "description": "The number of items i
n the menu."}, |
| 87 "itemIndex": {"type": "integer", "description": "The 0-based index of
this menu item."} |
| 88 } |
| 89 }, |
| 90 { |
| 91 "id": "RadioButtonDetails", |
| 92 "type": "object", |
| 93 "description": "Information about the state of a radio button.", |
| 94 "properties": { |
| 95 "isChecked": {"type": "boolean", "description": "True if this radio bu
tton is checked."}, |
| 96 "itemCount": {"type": "integer", "description": "The number of radio b
uttons in this group."}, |
| 97 "itemIndex": {"type": "integer", "description": "The 0-based index of
this radio button in this group."} |
| 98 } |
| 99 }, |
| 100 { |
| 101 "id": "SliderDetails", |
| 102 "type": "object", |
| 103 "description": "Information about the state of a slider.", |
| 104 "properties": { |
| 105 "stringValue": {"type": "string", "description": "The value of the sli
der as a string."} |
| 106 } |
| 107 }, |
| 108 { |
| 109 "id": "TabDetails", |
| 110 "type": "object", |
| 111 "description": "Additional accessibility information about a tab.", |
| 112 "properties": { |
| 113 "itemCount": {"type": "integer", "description": "The number of tabs in
this group."}, |
| 114 "itemIndex": {"type": "integer", "description": "The 0-based index of
this tab in this group."} |
| 115 } |
| 116 }, |
| 117 { |
| 118 "id": "TextBoxDetails", |
| 119 "type": "object", |
| 120 "description": "Information about the state of a text box.", |
| 121 "properties": { |
| 122 "value": {"type": "string", "description": "The value of the text box
- the entered text."}, |
| 123 "isPassword": {"type": "boolean", "description": "True if this control
contains password text whose contents should be obscured."}, |
| 124 "selectionStart": {"type": "integer", "description": "The index of the
character where the selection starts, if this control contains editable text."}
, |
| 125 "selectionEnd": {"type": "integer", "description": "The index of the c
haracter where the selection ends, if this control contains editable text."} |
| 126 } |
| 127 }, |
| 128 { |
| 129 "id": "AlertInfo", |
| 130 "type": "object", |
| 131 "description": "Information about an alert", |
| 132 "properties": { |
| 133 "message": { |
| 134 "type": "string", |
| 135 "description": "The message the alert is showing." |
| 136 } |
| 137 } |
| 138 } |
| 139 ], |
| 140 "functions": [ |
| 141 { |
| 142 "name": "setAccessibilityEnabled", |
| 143 "type": "function", |
| 144 "description": "Enables or disables the accessibility extension api. Thi
s must be set to true before event listeners or getFocusedControl will work.", |
| 145 "parameters": [ |
| 146 { |
| 147 "type": "boolean", |
| 148 "name": "enabled", |
| 149 "description": "True if accessibility support should be enabled." |
| 150 } |
| 151 ] |
| 152 }, |
| 153 { |
| 154 "name": "getFocusedControl", |
| 155 "type": "function", |
| 156 "description": "Gets information about the currently focused control.", |
| 157 "parameters": [ |
| 158 { |
| 159 "type": "function", |
| 160 "name": "callback", |
| 161 "parameters": [ |
| 162 { |
| 163 "name": "control", |
| 164 "description": "Details of the currently focused control, or nul
l if nothing is focused.", |
| 165 "$ref": "AccessibilityObject", |
| 166 "optional": true |
| 167 } |
| 168 ] |
| 169 } |
| 170 ] |
| 171 }, |
| 172 { |
| 173 "name": "getAlertsForTab", |
| 174 "type": "function", |
| 175 "description": "Gets alerts being shown on the given tab.", |
| 176 "parameters": [ |
| 177 { |
| 178 "name": "tabId", |
| 179 "type": "integer", |
| 180 "minimum": 0 |
| 181 }, |
| 182 { |
| 183 "type": "function", |
| 184 "name": "callback", |
| 185 "parameters": [ |
| 186 { |
| 187 "name": "alerts", |
| 188 "type": "array", |
| 189 "items": { "$ref": "AlertInfo" }, |
| 190 "description": "Alerts being shown on the given tab." |
| 191 } |
| 192 ] |
| 193 } |
| 194 ] |
| 195 } |
| 196 ], |
| 197 "events": [ |
| 198 { |
| 199 "name": "onWindowOpened", |
| 200 "type": "function", |
| 201 "description": "Fired when a window is opened.", |
| 202 "parameters": [ |
| 203 { |
| 204 "$ref": "AccessibilityObject", |
| 205 "name": "window", |
| 206 "description": "Information about the window that was opened." |
| 207 } |
| 208 ] |
| 209 }, |
| 210 { |
| 211 "name": "onWindowClosed", |
| 212 "type": "function", |
| 213 "description": "Fired when a window is closed.", |
| 214 "parameters": [ |
| 215 { |
| 216 "$ref": "AccessibilityObject", |
| 217 "name": "window", |
| 218 "description": "Information about the window that was closed." |
| 219 } |
| 220 ] |
| 221 }, |
| 222 { |
| 223 "name": "onControlFocused", |
| 224 "type": "function", |
| 225 "description": "Fired when a control is focused.", |
| 226 "parameters": [ |
| 227 { |
| 228 "$ref": "AccessibilityObject", |
| 229 "name": "control", |
| 230 "description": "Details of the control that was focused." |
| 231 } |
| 232 ] |
| 233 }, |
| 234 { |
| 235 "name": "onControlAction", |
| 236 "type": "function", |
| 237 "description": "Fired when a control's action is taken, like pressing a
button or toggling a checkbox.", |
| 238 "parameters": [ |
| 239 { |
| 240 "$ref": "AccessibilityObject", |
| 241 "name": "control", |
| 242 "description": "Details of the control whose action was taken." |
| 243 } |
| 244 ] |
| 245 }, |
| 246 { |
| 247 "name": "onTextChanged", |
| 248 "type": "function", |
| 249 "description": "Fired when text changes in an editable text control.", |
| 250 "parameters": [ |
| 251 { |
| 252 "$ref": "AccessibilityObject", |
| 253 "name": "control", |
| 254 "description": "Details of the control where the text changed." |
| 255 } |
| 256 ] |
| 257 }, |
| 258 { |
| 259 "name": "onMenuOpened", |
| 260 "type": "function", |
| 261 "description": "Fired when a menu is opened.", |
| 262 "parameters": [ |
| 263 { |
| 264 "$ref": "AccessibilityObject", |
| 265 "name": "menu", |
| 266 "description": "Information about the menu that was opened." |
| 267 } |
| 268 ] |
| 269 }, |
| 270 { |
| 271 "name": "onMenuClosed", |
| 272 "type": "function", |
| 273 "description": "Fired when a menu is closed.", |
| 274 "parameters": [ |
| 275 { |
| 276 "$ref": "AccessibilityObject", |
| 277 "name": "menu", |
| 278 "description": "Information about the menu that was closed." |
| 279 } |
| 280 ] |
| 281 } |
| 282 ] |
| 283 } |
| 284 ] |
| OLD | NEW |