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.
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 {
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 {
26 object? boolAttributes;
27 object? floatAttributes;
28 object? htmlAttributes;
29 object? intAttributes;
30 object? intlistAttributes;
31 object? stringAttributes;
35 // Data for an accessibility event and/or an atomic change to an accessibility
36 // tree. See ui/accessibility/ax_tree_update.h for an extended explanation of
37 // the tree update format.
38 dictionary AXEventParams {
39 // The process id of the renderer host.
42 // The routing id of the web contents that this update is for.
45 // ID of the node that the event applies to.
48 // The type of event that this update represents.
51 // A vector of nodes to update according to the rules described in
52 // ui/ax_tree_update.h.
56 // All possible actions that can be performed on automation nodes.
64 // Arguments required for all actions supplied to performAction.
65 dictionary PerformActionRequiredParams {
68 long automationNodeID;
69 ActionType actionType;
72 // Arguments for the set_selection action supplied to performAction.
73 dictionary SetSelectionParams {
78 // Returns the process id and routing id of the tab whose accessibility was
79 // enabled using enable().
80 callback EnableCallback = void(long processID, long routingID);
83 // Enable automation of the active tab and retrieves its routing id for use
85 static void enableCurrentTab(EnableCallback callback);
87 // Enables desktop automation.
88 static void enableDesktop();
90 // Performs an action on an automation node.
91 static void performAction(PerformActionRequiredParams args,
96 // Fired when an accessibility event occurs
97 static void onAccessibilityEvent(AXEventParams update);