chrome/browser/resources/chromeos/chromevox/common/chrome_extension_externs.js

   1 // Copyright 2014 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  * @fileoverview Definitions for the Chromium extensions API used by ChromeVox.
   8  *
   9  * @externs
  10  */
  11
  12
  13 // TODO: Move these to //third_party/closure_compiler/externs.
  14
  15 // Begin auto generated externs; do not edit.
  16 // The following was generated from:
  17 //
  18 // python tools/json_schema_compiler/compiler.py
  19 //     -g externs
  20 //     chrome/common/extensions/api/automation.idl
  21
  22 /**
  23  * @const
  24  */
  25 chrome.automation = {};
  26
  27 /**
  28  * @enum {string}
  29  */
  30 chrome.automation.EventType = {
  31   activedescendantchanged: 'activedescendantchanged',
  32   alert: 'alert',
  33   ariaAttributeChanged: 'ariaAttributeChanged',
  34   autocorrectionOccured: 'autocorrectionOccured',
  35   blur: 'blur',
  36   checkedStateChanged: 'checkedStateChanged',
  37   childrenChanged: 'childrenChanged',
  38   focus: 'focus',
  39   hide: 'hide',
  40   hover: 'hover',
  41   invalidStatusChanged: 'invalidStatusChanged',
  42   layoutComplete: 'layoutComplete',
  43   liveRegionChanged: 'liveRegionChanged',
  44   loadComplete: 'loadComplete',
  45   locationChanged: 'locationChanged',
  46   menuEnd: 'menuEnd',
  47   menuListItemSelected: 'menuListItemSelected',
  48   menuListValueChanged: 'menuListValueChanged',
  49   menuPopupEnd: 'menuPopupEnd',
  50   menuPopupStart: 'menuPopupStart',
  51   menuStart: 'menuStart',
  52   rowCollapsed: 'rowCollapsed',
  53   rowCountChanged: 'rowCountChanged',
  54   rowExpanded: 'rowExpanded',
  55   scrollPositionChanged: 'scrollPositionChanged',
  56   scrolledToAnchor: 'scrolledToAnchor',
  57   selectedChildrenChanged: 'selectedChildrenChanged',
  58   selection: 'selection',
  59   selectionAdd: 'selectionAdd',
  60   selectionRemove: 'selectionRemove',
  61   show: 'show',
  62   textChanged: 'textChanged',
  63   textSelectionChanged: 'textSelectionChanged',
  64   treeChanged: 'treeChanged',
  65   valueChanged: 'valueChanged',
  66 };
  67
  68 /**
  69  * @enum {string}
  70  */
  71 chrome.automation.RoleType = {
  72   alertDialog: 'alertDialog',
  73   alert: 'alert',
  74   annotation: 'annotation',
  75   application: 'application',
  76   article: 'article',
  77   banner: 'banner',
  78   blockquote: 'blockquote',
  79   busyIndicator: 'busyIndicator',
  80   button: 'button',
  81   buttonDropDown: 'buttonDropDown',
  82   canvas: 'canvas',
  83   caption: 'caption',
  84   cell: 'cell',
  85   checkBox: 'checkBox',
  86   client: 'client',
  87   colorWell: 'colorWell',
  88   columnHeader: 'columnHeader',
  89   column: 'column',
  90   comboBox: 'comboBox',
  91   complementary: 'complementary',
  92   contentInfo: 'contentInfo',
  93   date: 'date',
  94   dateTime: 'dateTime',
  95   definition: 'definition',
  96   descriptionListDetail: 'descriptionListDetail',
  97   descriptionList: 'descriptionList',
  98   descriptionListTerm: 'descriptionListTerm',
  99   desktop: 'desktop',
 100   details: 'details',
 101   dialog: 'dialog',
 102   directory: 'directory',
 103   disclosureTriangle: 'disclosureTriangle',
 104   div: 'div',
 105   document: 'document',
 106   embeddedObject: 'embeddedObject',
 107   figcaption: 'figcaption',
 108   figure: 'figure',
 109   footer: 'footer',
 110   form: 'form',
 111   grid: 'grid',
 112   group: 'group',
 113   heading: 'heading',
 114   iframe: 'iframe',
 115   iframePresentational: 'iframePresentational',
 116   ignored: 'ignored',
 117   imageMapLink: 'imageMapLink',
 118   imageMap: 'imageMap',
 119   image: 'image',
 120   inlineTextBox: 'inlineTextBox',
 121   labelText: 'labelText',
 122   legend: 'legend',
 123   lineBreak: 'lineBreak',
 124   link: 'link',
 125   listBoxOption: 'listBoxOption',
 126   listBox: 'listBox',
 127   listItem: 'listItem',
 128   listMarker: 'listMarker',
 129   list: 'list',
 130   locationBar: 'locationBar',
 131   log: 'log',
 132   main: 'main',
 133   marquee: 'marquee',
 134   math: 'math',
 135   menuBar: 'menuBar',
 136   menuButton: 'menuButton',
 137   menuItem: 'menuItem',
 138   menuItemCheckBox: 'menuItemCheckBox',
 139   menuItemRadio: 'menuItemRadio',
 140   menuListOption: 'menuListOption',
 141   menuListPopup: 'menuListPopup',
 142   menu: 'menu',
 143   meter: 'meter',
 144   navigation: 'navigation',
 145   note: 'note',
 146   outline: 'outline',
 147   pane: 'pane',
 148   paragraph: 'paragraph',
 149   popUpButton: 'popUpButton',
 150   pre: 'pre',
 151   presentational: 'presentational',
 152   progressIndicator: 'progressIndicator',
 153   radioButton: 'radioButton',
 154   radioGroup: 'radioGroup',
 155   region: 'region',
 156   rootWebArea: 'rootWebArea',
 157   rowHeader: 'rowHeader',
 158   row: 'row',
 159   ruby: 'ruby',
 160   ruler: 'ruler',
 161   svgRoot: 'svgRoot',
 162   scrollArea: 'scrollArea',
 163   scrollBar: 'scrollBar',
 164   seamlessWebArea: 'seamlessWebArea',
 165   search: 'search',
 166   searchBox: 'searchBox',
 167   slider: 'slider',
 168   sliderThumb: 'sliderThumb',
 169   spinButtonPart: 'spinButtonPart',
 170   spinButton: 'spinButton',
 171   splitter: 'splitter',
 172   staticText: 'staticText',
 173   status: 'status',
 174   switch: 'switch',
 175   tabGroup: 'tabGroup',
 176   tabList: 'tabList',
 177   tabPanel: 'tabPanel',
 178   tab: 'tab',
 179   tableHeaderContainer: 'tableHeaderContainer',
 180   table: 'table',
 181   textField: 'textField',
 182   time: 'time',
 183   timer: 'timer',
 184   titleBar: 'titleBar',
 185   toggleButton: 'toggleButton',
 186   toolbar: 'toolbar',
 187   treeGrid: 'treeGrid',
 188   treeItem: 'treeItem',
 189   tree: 'tree',
 190   unknown: 'unknown',
 191   tooltip: 'tooltip',
 192   webArea: 'webArea',
 193   webView: 'webView',
 194   window: 'window',
 195 };
 196
 197 /**
 198  * @enum {string}
 199  */
 200 chrome.automation.StateType = {
 201   busy: 'busy',
 202   checked: 'checked',
 203   collapsed: 'collapsed',
 204   default: 'default',
 205   disabled: 'disabled',
 206   editable: 'editable',
 207   enabled: 'enabled',
 208   expanded: 'expanded',
 209   focusable: 'focusable',
 210   focused: 'focused',
 211   haspopup: 'haspopup',
 212   horizontal: 'horizontal',
 213   hovered: 'hovered',
 214   indeterminate: 'indeterminate',
 215   invisible: 'invisible',
 216   linked: 'linked',
 217   multiselectable: 'multiselectable',
 218   offscreen: 'offscreen',
 219   pressed: 'pressed',
 220   protected: 'protected',
 221   readOnly: 'readOnly',
 222   required: 'required',
 223   selectable: 'selectable',
 224   selected: 'selected',
 225   vertical: 'vertical',
 226   visited: 'visited',
 227 };
 228
 229 /**
 230  * @enum {string}
 231  */
 232 chrome.automation.TreeChangeType = {
 233   nodeCreated: 'nodeCreated',
 234   subtreeCreated: 'subtreeCreated',
 235   nodeChanged: 'nodeChanged',
 236   nodeRemoved: 'nodeRemoved',
 237 };
 238
 239 /**
 240  * @typedef {{
 241  *   left: number,
 242  *   top: number,
 243  *   width: number,
 244  *   height: number
 245  * }}
 246  */
 247 chrome.automation.Rect;
 248
 249 /**
 250  * @typedef {{
 251  *   role: (!chrome.automation.RoleType|undefined),
 252  *   state: (Object|undefined),
 253  *   attributes: (Object|undefined)
 254  * }}
 255  */
 256 chrome.automation.FindParams;
 257
 258 /**
 259  * @constructor
 260  */
 261 chrome.automation.AutomationEvent = function() {};
 262
 263 /**
 264  * @typedef {{
 265  *   target: chrome.automation.AutomationNode,
 266  *   type: !chrome.automation.TreeChangeType
 267  * }}
 268  */
 269 chrome.automation.TreeChange;
 270
 271 /**
 272  * @constructor
 273  */
 274 chrome.automation.AutomationNode = function() {};
 275
 276
 277 /**
 278  * Get the automation tree for the tab with the given tabId, or the current tab
 279  * if no tabID is given, enabling automation if necessary. Returns a tree with a
 280  * placeholder root node; listen for the "loadComplete" event to get a
 281  * notification that the tree has fully loaded (the previous root node reference
 282  * will stop working at or before this point).
 283  * @param {number} tabId
 284  * @param {function(chrome.automation.AutomationNode):void} callback
 285  *     Called when the <code>AutomationNode</code> for the page is available.
 286  */
 287 chrome.automation.getTree = function(tabId, callback) {};
 288
 289 /**
 290  * Get the automation tree for the whole desktop which consists of all on screen
 291  * views. Note this API is currently only supported on Chrome OS.
 292  * @param {function(chrome.automation.AutomationNode):void} callback
 293  *     Called when the <code>AutomationNode</code> for the page is available.
 294  */
 295 chrome.automation.getDesktop = function(callback) {};
 296
 297 /**
 298  * Add a tree change observer. Tree change observers are static/global,
 299  * they listen to tree changes across all trees.
 300  * @param {function(chrome.automation.TreeChange):void} observer
 301  *     A listener for tree changes on the <code>AutomationNode</code> tree.
 302  */
 303 chrome.automation.addTreeChangeObserver = function(observer) {};
 304
 305 /**
 306  * Remove a tree change observer.
 307  * @param {function(chrome.automation.TreeChange):void} observer
 308  *     A listener for tree changes on the <code>AutomationNode</code> tree.
 309  */
 310 chrome.automation.removeTreeChangeObserver = function(observer) {};
 311
 312 //
 313 // End auto generated externs; do not edit.
 314 //
 315
 316
 317
 318 /**
 319  * @type {chrome.automation.RoleType}
 320  */
 321 chrome.automation.AutomationNode.prototype.role;
 322
 323
 324 /**
 325  * @type {!Object<chrome.automation.StateType, boolean>}
 326  */
 327 chrome.automation.AutomationNode.prototype.state;
 328
 329
 330 /**
 331  * @type {number}
 332  */
 333 chrome.automation.AutomationNode.prototype.indexInParent;
 334
 335
 336 /**
 337  * @type {string}
 338  */
 339 chrome.automation.AutomationNode.prototype.name;
 340
 341 /**
 342  * @type {string}
 343  */
 344 chrome.automation.AutomationNode.prototype.description;
 345
 346
 347 /**
 348  * @type {string}
 349  */
 350 chrome.automation.AutomationNode.prototype.url;
 351
 352
 353 /**
 354  * @type {string}
 355  */
 356 chrome.automation.AutomationNode.prototype.docUrl;
 357
 358
 359 /**
 360  * @type {string}
 361  */
 362 chrome.automation.AutomationNode.prototype.value;
 363
 364
 365 /**
 366  * @type {number}
 367  */
 368 chrome.automation.AutomationNode.prototype.textSelStart;
 369
 370
 371 /**
 372  * @type {number}
 373  */
 374 chrome.automation.AutomationNode.prototype.textSelEnd;
 375
 376
 377 /**
 378  * @type {Array<number>}
 379  */
 380 chrome.automation.AutomationNode.prototype.wordStarts;
 381
 382
 383 /**
 384  * @type {Array<number>}
 385  */
 386 chrome.automation.AutomationNode.prototype.wordEnds;
 387
 388
 389 /**
 390  * @type {!chrome.automation.AutomationNode}
 391  */
 392 chrome.automation.AutomationNode.prototype.root;
 393
 394
 395 /**
 396  * @type {chrome.automation.AutomationNode}
 397  */
 398 chrome.automation.AutomationNode.prototype.firstChild;
 399
 400
 401 /**
 402  * @type {chrome.automation.AutomationNode}
 403  */
 404 chrome.automation.AutomationNode.prototype.lastChild;
 405
 406
 407 /**
 408  * @type {chrome.automation.AutomationNode}
 409  */
 410 chrome.automation.AutomationNode.prototype.nextSibling;
 411
 412
 413 /**
 414  * @type {chrome.automation.AutomationNode}
 415  */
 416 chrome.automation.AutomationNode.prototype.previousSibling;
 417
 418
 419 /**
 420  * @type {chrome.automation.AutomationNode}
 421  */
 422 chrome.automation.AutomationNode.prototype.parent;
 423
 424
 425 /**
 426  * @type {!Array<chrome.automation.AutomationNode>}
 427  */
 428 chrome.automation.AutomationNode.prototype.children;
 429
 430
 431 /**
 432  * @type {{top: number, left: number, height: number, width: number}}
 433  */
 434 chrome.automation.AutomationNode.prototype.location;
 435
 436
 437 /**
 438  * @param {chrome.automation.EventType} eventType
 439  * @param {function(chrome.automation.AutomationNode) : void} callback
 440  * @param {boolean} capture
 441  */
 442 chrome.automation.AutomationNode.prototype.addEventListener =
 443     function(eventType, callback, capture) {};
 444
 445
 446 /**
 447  * @param {chrome.automation.EventType} eventType
 448  * @param {function(chrome.automation.AutomationNode) : void} callback
 449  * @param {boolean} capture
 450  */
 451 chrome.automation.AutomationNode.prototype.removeEventListener =
 452     function(eventType, callback, capture) {};
 453
 454
 455 /**
 456  * @type {chrome.automation.AutomationNode}
 457  */
 458 chrome.automation.TreeChange.prototype.target;
 459
 460
 461 /**
 462  * @type {chrome.automation.TreeChangeType}
 463  */
 464 chrome.automation.TreeChange.prototype.type;
 465
 466
 467 /**
 468  * @param {function(chrome.automation.TreeChange) : void}
 469  *    callback
 470  */
 471 chrome.automation.AutomationNode.prototype.addTreeChangeObserver =
 472     function(callback) {};
 473
 474
 475 /**
 476  * @param {function(chrome.automation.TreeChange) : void}
 477  *    callback
 478  */
 479 chrome.automation.AutomationNode.prototype.removeTreeChangeObserver =
 480     function(callback) {};
 481
 482
 483 chrome.automation.AutomationNode.prototype.doDefault = function() {};
 484
 485
 486 chrome.automation.AutomationNode.prototype.focus = function() {};
 487
 488
 489 chrome.automation.AutomationNode.prototype.showContextMenu = function() {};
 490
 491
 492 /**
 493  * @param {number} start
 494  * @param {number} end
 495  */
 496 chrome.automation.AutomationNode.prototype.setSelection =
 497     function(start, end) {};
 498
 499
 500 /** @type {string} */
 501 chrome.automation.AutomationNode.prototype.containerLiveStatus;
 502
 503 /** @type {string} */
 504 chrome.automation.AutomationNode.prototype.containerLiveRelevant;
 505
 506 /** @type {boolean} */
 507 chrome.automation.AutomationNode.prototype.containerLiveAtomic;
 508
 509 /** @type {boolean} */
 510 chrome.automation.AutomationNode.prototype.containerLiveBusy;
 511
 512
 513 /**
 514  * @param {Object} findParams
 515  */
 516 chrome.automation.AutomationNode.prototype.find = function(findParams) {};