content/common/accessibility_messages.h

   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 // IPC messages for accessibility.
   6 // Multiply-included message file, hence no include guard.
   7
   8 #include "base/basictypes.h"
   9 #include "content/common/content_export.h"
  10 #include "content/common/view_message_enums.h"
  11 #include "content/public/common/common_param_traits.h"
  12 #include "ipc/ipc_message_macros.h"
  13 #include "ipc/ipc_message_utils.h"
  14 #include "ipc/ipc_param_traits.h"
  15 #include "ipc/param_traits_macros.h"
  16 #include "third_party/WebKit/public/web/WebAXEnums.h"
  17 #include "ui/accessibility/ax_node_data.h"
  18 #include "ui/accessibility/ax_tree_update.h"
  19
  20 #undef IPC_MESSAGE_EXPORT
  21 #define IPC_MESSAGE_EXPORT CONTENT_EXPORT
  22
  23 #define IPC_MESSAGE_START AccessibilityMsgStart
  24
  25 IPC_ENUM_TRAITS_MAX_VALUE(ui::AXEvent, ui::AX_EVENT_LAST)
  26 IPC_ENUM_TRAITS_MAX_VALUE(ui::AXRole, ui::AX_ROLE_LAST)
  27
  28 IPC_ENUM_TRAITS_MAX_VALUE(ui::AXBoolAttribute, ui::AX_BOOL_ATTRIBUTE_LAST)
  29 IPC_ENUM_TRAITS_MAX_VALUE(ui::AXFloatAttribute, ui::AX_FLOAT_ATTRIBUTE_LAST)
  30 IPC_ENUM_TRAITS_MAX_VALUE(ui::AXIntAttribute, ui::AX_INT_ATTRIBUTE_LAST)
  31 IPC_ENUM_TRAITS_MAX_VALUE(ui::AXIntListAttribute,
  32                           ui::AX_INT_LIST_ATTRIBUTE_LAST)
  33 IPC_ENUM_TRAITS_MAX_VALUE(ui::AXStringAttribute, ui::AX_STRING_ATTRIBUTE_LAST)
  34
  35 IPC_STRUCT_TRAITS_BEGIN(ui::AXNodeData)
  36   IPC_STRUCT_TRAITS_MEMBER(id)
  37   IPC_STRUCT_TRAITS_MEMBER(role)
  38   IPC_STRUCT_TRAITS_MEMBER(state)
  39   IPC_STRUCT_TRAITS_MEMBER(location)
  40   IPC_STRUCT_TRAITS_MEMBER(string_attributes)
  41   IPC_STRUCT_TRAITS_MEMBER(int_attributes)
  42   IPC_STRUCT_TRAITS_MEMBER(float_attributes)
  43   IPC_STRUCT_TRAITS_MEMBER(bool_attributes)
  44   IPC_STRUCT_TRAITS_MEMBER(intlist_attributes)
  45   IPC_STRUCT_TRAITS_MEMBER(html_attributes)
  46   IPC_STRUCT_TRAITS_MEMBER(child_ids)
  47 IPC_STRUCT_TRAITS_END()
  48
  49 IPC_STRUCT_TRAITS_BEGIN(ui::AXTreeUpdate)
  50   IPC_STRUCT_TRAITS_MEMBER(node_id_to_clear)
  51   IPC_STRUCT_TRAITS_MEMBER(nodes)
  52 IPC_STRUCT_TRAITS_END()
  53
  54 typedef std::map<int32, int> FrameIDMap;
  55
  56 IPC_STRUCT_BEGIN(AccessibilityHostMsg_EventParams)
  57   // The tree update.
  58   IPC_STRUCT_MEMBER(ui::AXTreeUpdate, update)
  59
  60   // Mapping from node id to routing id of its child frame - either the
  61   // routing id of a RenderFrame or a RenderFrameProxy for an out-of-process
  62   // iframe.
  63   IPC_STRUCT_MEMBER(FrameIDMap, node_to_frame_routing_id_map)
  64
  65   // Type of event.
  66   IPC_STRUCT_MEMBER(ui::AXEvent, event_type)
  67
  68   // ID of the node that the event applies to.
  69   IPC_STRUCT_MEMBER(int, id)
  70 IPC_STRUCT_END()
  71
  72 IPC_STRUCT_BEGIN(AccessibilityHostMsg_LocationChangeParams)
  73   // ID of the object whose location is changing.
  74   IPC_STRUCT_MEMBER(int, id)
  75
  76   // The object's new location, in frame-relative coordinates (same
  77   // as the coordinates in AccessibilityNodeData).
  78   IPC_STRUCT_MEMBER(gfx::Rect, new_location)
  79 IPC_STRUCT_END()
  80
  81 // Messages sent from the browser to the renderer.
  82
  83 // Relay a request from assistive technology to set focus to a given node.
  84 IPC_MESSAGE_ROUTED1(AccessibilityMsg_SetFocus,
  85                     int /* object id */)
  86
  87 // Relay a request from assistive technology to perform the default action
  88 // on a given node.
  89 IPC_MESSAGE_ROUTED1(AccessibilityMsg_DoDefaultAction,
  90                     int /* object id */)
  91
  92 // Relay a request from assistive technology to make a given object
  93 // visible by scrolling as many scrollable containers as possible.
  94 // In addition, if it's not possible to make the entire object visible,
  95 // scroll so that the |subfocus| rect is visible at least. The subfocus
  96 // rect is in local coordinates of the object itself.
  97 IPC_MESSAGE_ROUTED2(AccessibilityMsg_ScrollToMakeVisible,
  98                     int /* object id */,
  99                     gfx::Rect /* subfocus */)
 100
 101 // Relay a request from assistive technology to move a given object
 102 // to a specific location, in the WebContents area coordinate space, i.e.
 103 // (0, 0) is the top-left corner of the WebContents.
 104 IPC_MESSAGE_ROUTED2(AccessibilityMsg_ScrollToPoint,
 105                     int /* object id */,
 106                     gfx::Point /* new location */)
 107
 108 // Relay a request from assistive technology to set the cursor or
 109 // selection within an editable text element.
 110 IPC_MESSAGE_ROUTED3(AccessibilityMsg_SetTextSelection,
 111                     int /* object id */,
 112                     int /* New start offset */,
 113                     int /* New end offset */)
 114
 115 // Determine the accessibility object under a given point and reply with
 116 // a AccessibilityHostMsg_HitTestResult with the same id.
 117 IPC_MESSAGE_ROUTED1(AccessibilityMsg_HitTest,
 118                     gfx::Point /* location to test */)
 119
 120 // Tells the render view that a AccessibilityHostMsg_Events
 121 // message was processed and it can send addition events.
 122 IPC_MESSAGE_ROUTED0(AccessibilityMsg_Events_ACK)
 123
 124 // Kill the renderer because we got a fatal error in the accessibility tree.
 125 IPC_MESSAGE_ROUTED0(AccessibilityMsg_FatalError)
 126
 127 // Messages sent from the renderer to the browser.
 128
 129 // Sent to notify the browser about renderer accessibility events.
 130 // The browser responds with a AccessibilityMsg_Events_ACK.
 131 IPC_MESSAGE_ROUTED1(
 132     AccessibilityHostMsg_Events,
 133     std::vector<AccessibilityHostMsg_EventParams>)
 134
 135 // Sent to update the browser of the location of accessibility objects.
 136 IPC_MESSAGE_ROUTED1(
 137     AccessibilityHostMsg_LocationChanges,
 138     std::vector<AccessibilityHostMsg_LocationChangeParams>)