chrome/common/extensions/api/automation_internal.idl

   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 // This is the implementation layer of the chrome.automation API, and is
   6 // essentially a translation of the internal accessibility tree update system
   7 // into an extension API.
   8 namespace automationInternal {
   9   dictionary Rect {
  10     long left;
  11     long top;
  12     long width;
  13     long height;
  14   };
  15
  16   // A compact representation of the accessibility information for a
  17   // single web object, in a form that can be serialized and sent from
  18   // one process to another.
  19   // See ui/accessibility/ax_node_data.h
  20   dictionary AXNodeData {
  21     long id;
  22     DOMString role;
  23     object state;
  24     Rect location;
  25
  26     object? boolAttributes;
  27     object? floatAttributes;
  28     object? htmlAttributes;
  29     object? intAttributes;
  30     object? intlistAttributes;
  31     object? stringAttributes;
  32     long[] childIds;
  33   };
  34
  35   dictionary AXTreeUpdate {
  36     // ID of the node, if any, which should be invalidated before the new data
  37     // is applied.
  38     long nodeIdToClear;
  39
  40     // A vector of nodes to update according to the rules described in
  41     // ui/accessibility/ax_tree_update.h.
  42     AXNodeData[] nodes;
  43   };
  44
  45   // Data for an accessibility event and/or an atomic change to an accessibility
  46   // tree. See ui/accessibility/ax_tree_update.h for an extended explanation of
  47   // the tree update format.
  48   dictionary AXEventParams {
  49     // The tree id of the web contents that this update is for.
  50     long treeID;
  51
  52     // ID of the node that the event applies to.
  53     long targetID;
  54
  55     // The type of event that this update represents.
  56     DOMString eventType;
  57
  58     // Serialized changes to the tree structure and node data that should be
  59     // applied before processing the event.
  60     AXTreeUpdate update;
  61   };
  62
  63   // All possible actions that can be performed on automation nodes.
  64   enum ActionType {
  65     focus,
  66     doDefault,
  67     makeVisible,
  68     setSelection
  69   };
  70
  71   // Arguments required for all actions supplied to performAction.
  72   dictionary PerformActionRequiredParams {
  73     long treeID;
  74     long automationNodeID;
  75     ActionType actionType;
  76   };
  77
  78   // Arguments for the set_selection action supplied to performAction.
  79   dictionary SetSelectionParams {
  80     long startIndex;
  81     long endIndex;
  82   };
  83
  84   // Arguments for the querySelector function.
  85   dictionary QuerySelectorRequiredParams {
  86     long treeID;
  87     long automationNodeID;
  88     DOMString selector;
  89   };
  90
  91   // Returns the accessibility tree id of the web contents who's accessibility
  92   // was enabled using enableTab().
  93   callback EnableTabCallback = void(long tree_id);
  94
  95   // Callback called when enableDesktop() returns.
  96   callback EnableDesktopCallback = void();
  97
  98   // Callback called when querySelector() returns.
  99   callback QuerySelectorCallback = void(long resultAutomationNodeID);
 100
 101   interface Functions {
 102     // Enable automation of the tab with the given id, or the active tab if no
 103     // tab id is given, and retrieves accessibility tree id for use in
 104     // future updates.
 105     static void enableTab(optional long tabId, EnableTabCallback callback);
 106
 107     // Enable automation of the frame with the given tree id.
 108     static void enableFrame(long tree_id);
 109
 110     // Enables desktop automation.
 111     static void enableDesktop(EnableDesktopCallback callback);
 112
 113     // Performs an action on an automation node.
 114     static void performAction(PerformActionRequiredParams args,
 115                               object opt_args);
 116
 117     // Performs a query selector query.
 118     static void querySelector(QuerySelectorRequiredParams args,
 119                               QuerySelectorCallback callback);
 120   };
 121
 122   interface Events {
 123     // Fired when an accessibility event occurs
 124     static void onAccessibilityEvent(AXEventParams update);
 125
 126     static void onAccessibilityTreeDestroyed(long treeID);
 127   };
 128 };