third_party/WebKit/public/web/WebAXEnums.h

   1 /*
   2  * Copyright (C) 2013 Google Inc. All rights reserved.
   3  *
   4  * Redistribution and use in source and binary forms, with or without
   5  * modification, are permitted provided that the following conditions are
   6  * met:
   7  *
   8  *     * Redistributions of source code must retain the above copyright
   9  * notice, this list of conditions and the following disclaimer.
  10  *     * Redistributions in binary form must reproduce the above
  11  * copyright notice, this list of conditions and the following disclaimer
  12  * in the documentation and/or other materials provided with the
  13  * distribution.
  14  *     * Neither the name of Google Inc. nor the names of its
  15  * contributors may be used to endorse or promote products derived from
  16  * this software without specific prior written permission.
  17  *
  18  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  19  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  20  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  21  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  22  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  23  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  24  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  25  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  26  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  27  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  28  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  29  */
  30
  31 #ifndef WebAXEnums_h
  32 #define WebAXEnums_h
  33
  34 namespace blink {
  35
  36 // Accessibility events sent from Blink to the embedder.
  37 // These values must match blink::AXObjectCache::AXNotification values.
  38 // Enforced in AssertMatchingEnums.cpp.
  39 enum WebAXEvent {
  40     WebAXEventActiveDescendantChanged,
  41     WebAXEventAlert,
  42     WebAXEventAriaAttributeChanged,
  43     WebAXEventAutocorrectionOccured,
  44     WebAXEventBlur,
  45     WebAXEventCheckedStateChanged,
  46     WebAXEventChildrenChanged,
  47     WebAXEventFocus,
  48     WebAXEventHide,
  49     WebAXEventInvalidStatusChanged,
  50     WebAXEventLayoutComplete,
  51     WebAXEventLiveRegionChanged,
  52     WebAXEventLoadComplete,
  53     WebAXEventLocationChanged,
  54     WebAXEventMenuListItemSelected,
  55     WebAXEventMenuListItemUnselected,
  56     WebAXEventMenuListValueChanged,
  57     WebAXEventRowCollapsed,
  58     WebAXEventRowCountChanged,
  59     WebAXEventRowExpanded,
  60     WebAXEventScrollPositionChanged,
  61     WebAXEventScrolledToAnchor,
  62     WebAXEventSelectedChildrenChanged,
  63     WebAXEventSelectedTextChanged,
  64     WebAXEventShow,
  65     WebAXEventTextChanged,
  66     WebAXEventTextInserted,
  67     WebAXEventTextRemoved,
  68     WebAXEventValueChanged
  69 };
  70
  71 // Accessibility roles.
  72 // These values must match blink::AccessibilityRole values.
  73 // Enforced in AssertMatchingEnums.cpp.
  74 enum WebAXRole {
  75     WebAXRoleUnknown = 0,
  76     WebAXRoleAlertDialog,
  77     WebAXRoleAlert,
  78     WebAXRoleAnnotation,
  79     WebAXRoleApplication,
  80     WebAXRoleArticle,
  81     WebAXRoleBanner,
  82     WebAXRoleBlockquote,
  83     WebAXRoleBusyIndicator,
  84     WebAXRoleButton,
  85     WebAXRoleCanvas,
  86     WebAXRoleCaption,
  87     WebAXRoleCell,
  88     WebAXRoleCheckBox,
  89     WebAXRoleColorWell,
  90     WebAXRoleColumnHeader,
  91     WebAXRoleColumn,
  92     WebAXRoleComboBox,
  93     WebAXRoleComplementary,
  94     WebAXRoleContentInfo,
  95     WebAXRoleDate,
  96     WebAXRoleDateTime,
  97     WebAXRoleDefinition,
  98     WebAXRoleDescriptionListDetail,
  99     WebAXRoleDescriptionList,
 100     WebAXRoleDescriptionListTerm,
 101     WebAXRoleDetails,
 102     WebAXRoleDialog,
 103     WebAXRoleDirectory,
 104     WebAXRoleDisclosureTriangle,
 105     WebAXRoleDiv,
 106     WebAXRoleDocument,
 107     WebAXRoleEmbeddedObject,
 108     WebAXRoleFigcaption,
 109     WebAXRoleFigure,
 110     WebAXRoleFooter,
 111     WebAXRoleForm,
 112     WebAXRoleGrid,
 113     WebAXRoleGroup,
 114     WebAXRoleHeading,
 115     WebAXRoleIframePresentational,
 116     WebAXRoleIframe,
 117     WebAXRoleIgnored,
 118     WebAXRoleImageMapLink,
 119     WebAXRoleImageMap,
 120     WebAXRoleImage,
 121     WebAXRoleInlineTextBox,
 122     WebAXRoleInputTime,
 123     WebAXRoleLabel,
 124     WebAXRoleLegend,
 125     WebAXRoleLink,
 126     WebAXRoleListBoxOption,
 127     WebAXRoleListBox,
 128     WebAXRoleListItem,
 129     WebAXRoleListMarker,
 130     WebAXRoleList,
 131     WebAXRoleLog,
 132     WebAXRoleMain,
 133     WebAXRoleMark,
 134     WebAXRoleMarquee,
 135     WebAXRoleMath,
 136     WebAXRoleMenuBar,
 137     WebAXRoleMenuButton,
 138     WebAXRoleMenuItem,
 139     WebAXRoleMenuItemCheckBox,
 140     WebAXRoleMenuItemRadio,
 141     WebAXRoleMenuListOption,
 142     WebAXRoleMenuListPopup,
 143     WebAXRoleMenu,
 144     WebAXRoleMeter,
 145     WebAXRoleNavigation,
 146     WebAXRoleNone,
 147     WebAXRoleNote,
 148     WebAXRoleOutline,
 149     WebAXRoleParagraph,
 150     WebAXRolePopUpButton,
 151     WebAXRolePre,
 152     WebAXRolePresentational,
 153     WebAXRoleProgressIndicator,
 154     WebAXRoleRadioButton,
 155     WebAXRoleRadioGroup,
 156     WebAXRoleRegion,
 157     WebAXRoleRootWebArea,
 158     WebAXRoleRowHeader,
 159     WebAXRoleRow,
 160     WebAXRoleRuby,
 161     WebAXRoleRuler,
 162     WebAXRoleSVGRoot,
 163     WebAXRoleScrollArea,
 164     WebAXRoleScrollBar,
 165     WebAXRoleSeamlessWebArea,
 166     WebAXRoleSearch,
 167     WebAXRoleSearchBox,
 168     WebAXRoleSlider,
 169     WebAXRoleSliderThumb,
 170     WebAXRoleSpinButtonPart,
 171     WebAXRoleSpinButton,
 172     WebAXRoleSplitter,
 173     WebAXRoleStaticText,
 174     WebAXRoleStatus,
 175     WebAXRoleSwitch,
 176     WebAXRoleTabGroup,
 177     WebAXRoleTabList,
 178     WebAXRoleTabPanel,
 179     WebAXRoleTab,
 180     WebAXRoleTableHeaderContainer,
 181     WebAXRoleTable,
 182     WebAXRoleTextField,
 183     WebAXRoleTime,
 184     WebAXRoleTimer,
 185     WebAXRoleToggleButton,
 186     WebAXRoleToolbar,
 187     WebAXRoleTreeGrid,
 188     WebAXRoleTreeItem,
 189     WebAXRoleTree,
 190     WebAXRoleUserInterfaceTooltip,
 191     WebAXRoleWebArea,
 192     WebAXRoleLineBreak,
 193     WebAXRoleWindow,
 194 };
 195
 196 // Accessibility states, used as a bitmask.
 197 enum WebAXState {
 198     WebAXStateBusy,
 199     WebAXStateChecked,
 200     WebAXStateEnabled,
 201     WebAXStateExpanded,
 202     WebAXStateFocusable,
 203     WebAXStateFocused,
 204     WebAXStateHaspopup,
 205     WebAXStateHovered,
 206     WebAXStateIndeterminate,
 207     WebAXStateInvisible,
 208     WebAXStateLinked,
 209     WebAXStateMultiline,
 210     WebAXStateMultiselectable,
 211     WebAXStateOffscreen,
 212     WebAXStatePressed,
 213     WebAXStateProtected,
 214     WebAXStateReadonly,
 215     WebAXStateRequired,
 216     WebAXStateSelectable,
 217     WebAXStateSelected,
 218     WebAXStateVertical,
 219     WebAXStateVisited,
 220 };
 221
 222 enum WebAXTextDirection {
 223     WebAXTextDirectionLR,
 224     WebAXTextDirectionRL,
 225     WebAXTextDirectionTB,
 226     WebAXTextDirectionBT
 227 };
 228
 229 // Sort direction, only used for roles = WebAXRoleRowHeader and
 230 // WebAXRoleColumnHeader.
 231 enum WebAXSortDirection {
 232     WebAXSortDirectionUndefined = 0,
 233     WebAXSortDirectionNone,
 234     WebAXSortDirectionAscending,
 235     WebAXSortDirectionDescending,
 236     WebAXSortDirectionOther
 237 };
 238
 239 // Expanded State.
 240 // These values must match blink::AccessibilityExpanded values.
 241 // Enforced in AssertMatchingEnums.cpp.
 242 enum WebAXExpanded {
 243     WebAXExpandedUndefined = 0,
 244     WebAXExpandedCollapsed,
 245     WebAXExpandedExpanded
 246 };
 247
 248 // These values must match blink::AccessibilityOrientation values.
 249 // Enforced in AssertMatchingEnums.cpp.
 250 enum WebAXOrientation {
 251     WebAXOrientationUndefined = 0,
 252     WebAXOrientationVertical,
 253     WebAXOrientationHorizontal,
 254 };
 255
 256 // Only used by HTML form controls and any other element that has
 257 // an aria-invalid attribute specified.
 258 enum WebAXInvalidState {
 259     WebAXInvalidStateUndefined = 0,
 260     WebAXInvalidStateFalse,
 261     WebAXInvalidStateTrue,
 262     WebAXInvalidStateSpelling,
 263     WebAXInvalidStateGrammar,
 264     WebAXInvalidStateOther
 265 };
 266
 267 // Used for exposing text attributes.
 268 enum WebAXTextStyle {
 269     WebAXTextStyleNone = 0,
 270     WebAXTextStyleBold = 1 << 0,
 271     WebAXTextStyleItalic = 1 << 1,
 272     WebAXTextStyleUnderline = 1 << 2,
 273     WebAXTextStyleLineThrough = 1 << 3
 274 };
 275
 276 // The source of the accessible name of an element. This is needed
 277 // because on some platforms this determines how the accessible name
 278 // is exposed.
 279 enum WebAXNameFrom {
 280     WebAXNameFromUninitialized = -1,
 281     WebAXNameFromAttribute = 0,
 282     WebAXNameFromContents,
 283     WebAXNameFromPlaceholder,
 284     WebAXNameFromRelatedElement,
 285 };
 286
 287 // The source of the accessible description of an element. This is needed
 288 // because on some platforms this determines how the accessible description
 289 // is exposed.
 290 enum WebAXDescriptionFrom {
 291     WebAXDescriptionFromPlaceholder,
 292     WebAXDescriptionFromRelatedElement
 293 };
 294
 295 } // namespace blink
 296
 297 #endif