ui/accessibility/ax_enums.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 // These should be kept in sync with third_party/WebKit/public/web/WebAXEnums.h
   6 // until the Chromium and Blink trees are merged.
   7 [camel_case_enum_to_string=true] namespace ui {
   8
   9   // For new entries to the following three enums, also add to
  10   // chrome/common/extensions/api/automation.idl.
  11   //
  12   // Explanation of the comments next to these events:
  13   //
  14   // Web: this event is only used in web content. Unless a specific platform
  15   //      is specified, it fires a native event on multiple platforms.
  16   //
  17   // Native: this event is only used in native UI.
  18   //
  19   // Implicit: it would be cleaner if we just updated the AX node
  20   //     and each platform fired the appropriate events to indicate which
  21   //     platform-specific attributes changed.
  22   //
  23   // If unspecified, the event is used across web and native on multiple
  24   // platforms.
  25   enum AXEvent {
  26     activedescendantchanged,   // Web
  27     alert,
  28     aria_attribute_changed,    // Implicit
  29     autocorrection_occured,    // Unknown: http://crbug.com/392498
  30     blur,                      // Remove: http://crbug.com/392502
  31     checked_state_changed,     // Implicit
  32     children_changed,
  33     focus,
  34     hide,                      // Remove: http://crbug.com/392502
  35     hover,
  36     invalid_status_changed,    // Implicit
  37     layout_complete,           // Web
  38     live_region_changed,       // Web
  39     load_complete,             // Web
  40     location_changed,          // Web
  41     menu_end,                  // Native / Win
  42     menu_list_item_selected,   // Web
  43     menu_list_value_changed,   // Web
  44     menu_popup_end,            // Native / Win
  45     menu_popup_start,          // Native / Win
  46     menu_start,                // Native / Win
  47     row_collapsed,             // Web / Mac
  48     row_count_changed,         // Web / Mac
  49     row_expanded,              // Web / Mac
  50     scroll_position_changed,   // Web
  51     scrolled_to_anchor,        // Web
  52     selected_children_changed, // Web
  53     selection,                 // Native
  54     selection_add,             // Native
  55     selection_remove,          // Native
  56     show,                      // Remove: http://crbug.com/392502
  57     text_changed,
  58     text_selection_changed,
  59     tree_changed,              // Accessibility tree changed. Don't
  60                                // explicitly fire an accessibility event,
  61                                // only implicitly due to the change.
  62     value_changed
  63   };
  64
  65   enum AXRole {
  66     alert_dialog,
  67     alert,
  68     annotation,
  69     application,
  70     article,
  71     banner,
  72     blockquote,
  73     busy_indicator,
  74     button,
  75     button_drop_down,
  76     canvas,
  77     caption,
  78     cell,
  79     check_box,
  80     client,
  81     color_well,
  82     column_header,
  83     column,
  84     combo_box,
  85     complementary,
  86     content_info,
  87     date,
  88     date_time,
  89     definition,
  90     description_list_detail,
  91     description_list,
  92     description_list_term,
  93     desktop,
  94     details,
  95     dialog,
  96     directory,
  97     disclosure_triangle,
  98     div,
  99     document,
 100     embedded_object,
 101     figcaption,
 102     figure,
 103     footer,
 104     form,
 105     grid,
 106     group,
 107     heading,
 108     iframe,
 109     iframe_presentational,
 110     ignored,
 111     image_map_link,
 112     image_map,
 113     image,
 114     inline_text_box,
 115     input_time,
 116     label_text,
 117     legend,
 118     line_break,
 119     link,
 120     list_box_option,
 121     list_box,
 122     list_item,
 123     list_marker,
 124     list,
 125     location_bar,
 126     log,
 127     main,
 128     marquee,
 129     math,
 130     menu_bar,
 131     menu_button,
 132     menu_item,
 133     menu_item_check_box,
 134     menu_item_radio,
 135     menu_list_option,
 136     menu_list_popup,
 137     menu,
 138     meter,
 139     navigation,
 140     note,
 141     outline,
 142     pane,
 143     paragraph,
 144     pop_up_button,
 145     pre,
 146     presentational,
 147     progress_indicator,
 148     radio_button,
 149     radio_group,
 150     region,
 151     root_web_area,
 152     row_header,
 153     row,
 154     ruby,
 155     ruler,
 156     svg_root,
 157     scroll_area,
 158     scroll_bar,
 159     seamless_web_area,
 160     search,
 161     search_box,
 162     slider,
 163     slider_thumb,
 164     spin_button_part,
 165     spin_button,
 166     splitter,
 167     static_text,
 168     status,
 169     switch,
 170     tab_group,
 171     tab_list,
 172     tab_panel,
 173     tab,
 174     table_header_container,
 175     table,
 176     text_field,
 177     time,
 178     timer,
 179     title_bar,
 180     toggle_button,
 181     toolbar,
 182     tree_grid,
 183     tree_item,
 184     tree,
 185     unknown,
 186     tooltip,
 187     web_area,
 188     web_view,
 189     window
 190   };
 191
 192   // TODO(dmazzoni): switch content/ to use AX_STATE_DISABLED instead of
 193   // !AX_STATE_ENABLED, and AX_STATE_EDITABLE instead of !AX_STATE_READONLY.
 194   enum AXState {
 195     busy,
 196     checked,
 197     collapsed,
 198     default,
 199     disabled,  // ui/views only
 200     editable,  // ui/views only
 201     enabled,   // content only
 202     expanded,
 203     focusable,
 204     focused,
 205     haspopup,
 206     horizontal,
 207     hovered,
 208     indeterminate,
 209     invisible,
 210     linked,
 211     multiline,
 212     multiselectable,
 213     offscreen,
 214     pressed,
 215     protected,
 216     read_only,
 217     required,
 218     selectable,
 219     selected,
 220     vertical,
 221     visited
 222   };
 223
 224   // A change to the accessibility tree.
 225   enum AXMutation {
 226     node_created,
 227     subtree_created,
 228     node_changed,
 229     node_removed
 230   };
 231
 232   [cpp_enum_prefix_override="ax_attr"] enum AXStringAttribute {
 233     // Document attributes.
 234     doc_url,
 235     doc_title,
 236     doc_mimetype,
 237     doc_doctype,
 238
 239     // Attributes that could apply to any node.
 240     access_key,
 241     action,
 242     auto_complete,
 243     container_live_relevant,
 244     container_live_status,
 245     description,
 246     display,
 247     dropeffect,
 248     help,
 249     html_tag,
 250     // Only used when invalid_state == invalid_state_other.
 251     aria_invalid_value,
 252     name,
 253     live_relevant,
 254     live_status,
 255     placeholder,
 256     role,
 257     shortcut,
 258     text_input_type,
 259     url,
 260     value
 261   };
 262
 263   [cpp_enum_prefix_override="ax_attr"] enum AXIntAttribute {
 264     // Scrollable container attributes.
 265     scroll_x,
 266     scroll_x_min,
 267     scroll_x_max,
 268     scroll_y,
 269     scroll_y_min,
 270     scroll_y_max,
 271
 272     // Editable text attributes.
 273     text_sel_start,
 274     text_sel_end,
 275
 276     // Table attributes.
 277     table_row_count,
 278     table_column_count,
 279     table_header_id,
 280
 281     // Table row attributes.
 282     table_row_index,
 283     table_row_header_id,
 284
 285     // Table column attributes.
 286     table_column_index,
 287     table_column_header_id,
 288
 289     // Table cell attributes.
 290     table_cell_column_index,
 291     table_cell_column_span,
 292     table_cell_row_index,
 293     table_cell_row_span,
 294     sort_direction,
 295
 296     // Tree control attributes.
 297     hierarchical_level,
 298
 299     // Relationships between this element and other elements.
 300     title_ui_element,
 301     activedescendant_id,
 302
 303     // Uniquely identifies an AXTree.
 304     tree_id,
 305
 306     // Identifies a child tree which this node hosts.
 307     child_tree_id,
 308
 309     // Position or Number of items in current set of listitems or treeitems
 310     set_size,
 311     pos_in_set,
 312
 313     // In the case of AX_ROLE_COLOR_WELL, specifies the selected color.
 314     color_value,
 315
 316
 317     // Text attributes.
 318
 319     // Foreground and background color in RGBA.
 320     background_color,
 321     color,
 322
 323     // Indicates if a form control has invalid input or
 324     // if an element has an aria-invalid attribute.
 325     invalid_state,
 326
 327     // Specifies the direction of the text, e.g., right-to-left.
 328     text_direction,
 329
 330     // Bold, italic, underline, etc.
 331     text_style
 332   };
 333
 334   [cpp_enum_prefix_override="ax_attr"] enum AXFloatAttribute {
 335     // Document attributes.
 336     doc_loading_progress,
 337
 338     // Range attributes.
 339     value_for_range,
 340     min_value_for_range,
 341     max_value_for_range,
 342
 343     // Text attributes.
 344     // Font size is in pixels.
 345     font_size
 346   };
 347
 348   [cpp_enum_prefix_override="ax_attr"] enum AXBoolAttribute {
 349     // Document attributes.
 350     doc_loaded,
 351
 352     // True if a checkbox or radio button is in the "mixed" state.
 353     button_mixed,
 354
 355     // Live region attributes.
 356     container_live_atomic,
 357     container_live_busy,
 358     live_atomic,
 359     live_busy,
 360
 361     // ARIA readonly flag.
 362     aria_readonly,
 363
 364     // Writeable attributes
 365     can_set_value,
 366
 367     // If this is set, all of the other fields in this struct should
 368     // be ignored and only the locations should change.
 369     update_location_only,
 370
 371     // Set on a canvas element if it has fallback content.
 372     canvas_has_fallback,
 373
 374     // Set if this node is the host of an external AXTree, for
 375     // example a web view that's a child of a native view, or a
 376     // web iframe that's the child of another web frame.
 377     is_ax_tree_host,
 378
 379     // Set if this node has been selected for dragging in
 380     // a drag-n-drop operation.
 381     grabbed
 382   };
 383
 384   [cpp_enum_prefix_override="ax_attr"] enum AXIntListAttribute {
 385     // Ids of nodes that are children of this node logically, but are
 386     // not children of this node in the tree structure. As an example,
 387     // a table cell is a child of a row, and an 'indirect' child of a
 388     // column.
 389     indirect_child_ids,
 390
 391     // Relationships between this element and other elements.
 392     controls_ids,
 393     describedby_ids,
 394     flowto_ids,
 395     labelledby_ids,
 396     owns_ids,
 397
 398     // Character indices where line breaks occur.
 399     line_breaks,
 400
 401     // For a table, the cell ids in row-major order, with duplicate entries
 402     // when there's a rowspan or colspan, and with -1 for missing cells.
 403     // There are always exactly rows * columns entries.
 404     cell_ids,
 405
 406     // For a table, the unique cell ids in row-major order of their first
 407     // occurrence.
 408     unique_cell_ids,
 409
 410     // For inline text. This is the pixel position of the end of this
 411     // character within the bounding rectangle of this object, in the
 412     // direction given by AX_ATTR_TEXT_DIRECTION. For example, for left-to-right
 413     // text, the first offset is the right coordinate of the first character
 414     // within the object's bounds, the second offset is the right coordinate
 415     // of the second character, and so on.
 416     character_offsets,
 417
 418     // For inline text. These int lists must be the same size; they represent
 419     // the start and end character index of each word within this text.
 420     word_starts,
 421     word_ends
 422   };
 423
 424   [cpp_enum_prefix_override="ax"] enum AXTextDirection {
 425     text_direction_ltr,
 426     text_direction_rtl,
 427     text_direction_ttb,
 428     text_direction_btt
 429   };
 430
 431   [cpp_enum_prefix_override="ax"] enum AXTextStyle {
 432     text_style_bold,
 433     text_style_italic,
 434     text_style_underline,
 435     text_style_line_through
 436   };
 437
 438   [cpp_enum_prefix_override="ax"] enum AXInvalidState {
 439     invalid_state_false,
 440     invalid_state_true,
 441     invalid_state_spelling,
 442     invalid_state_grammar,
 443     invalid_state_other
 444   };
 445
 446   [cpp_enum_prefix_override="ax"] enum AXSortDirection {
 447     sort_direction_unsorted,
 448     sort_direction_ascending,
 449     sort_direction_descending,
 450     sort_direction_other
 451   };
 452
 453 };