third_party/WebKit/public/web/WebAXEnums.h

/*
 * Copyright (C) 2013 Google Inc. All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are
 * met:
 *
 *     * Redistributions of source code must retain the above copyright
 * notice, this list of conditions and the following disclaimer.
 *     * Redistributions in binary form must reproduce the above
 * copyright notice, this list of conditions and the following disclaimer
 * in the documentation and/or other materials provided with the
 * distribution.
 *     * Neither the name of Google Inc. nor the names of its
 * contributors may be used to endorse or promote products derived from
 * this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

#ifndef WebAXEnums_h
#define WebAXEnums_h

namespace blink {

// Accessibility events sent from Blink to the embedder.
// These values must match blink::AXObjectCache::AXNotification values.
// Enforced in AssertMatchingEnums.cpp.
enum WebAXEvent {
  WebAXEventActiveDescendantChanged,
  WebAXEventAlert,
  WebAXEventAriaAttributeChanged,
  WebAXEventAutocorrectionOccured,
  WebAXEventBlur,
  WebAXEventCheckedStateChanged,
  WebAXEventChildrenChanged,
  WebAXEventClicked,
  WebAXEventDocumentSelectionChanged,
  WebAXEventExpandedChanged,
  WebAXEventFocus,
  WebAXEventHide,
  WebAXEventHover,
  WebAXEventInvalidStatusChanged,
  WebAXEventLayoutComplete,
  WebAXEventLiveRegionChanged,
  WebAXEventLoadComplete,
  WebAXEventLocationChanged,
  WebAXEventMenuListItemSelected,
  WebAXEventMenuListItemUnselected,
  WebAXEventMenuListValueChanged,
  WebAXEventRowCollapsed,
  WebAXEventRowCountChanged,
  WebAXEventRowExpanded,
  WebAXEventScrollPositionChanged,
  WebAXEventScrolledToAnchor,
  WebAXEventSelectedChildrenChanged,
  WebAXEventSelectedTextChanged,
  WebAXEventShow,
  WebAXEventTextChanged,
  WebAXEventTextInserted,
  WebAXEventTextRemoved,
  WebAXEventValueChanged
};

// Accessibility roles.
// These values must match blink::AccessibilityRole values.
// Enforced in AssertMatchingEnums.cpp.
enum WebAXRole {
  WebAXRoleUnknown = 0,
  WebAXRoleAbbr,
  WebAXRoleAlertDialog,
  WebAXRoleAlert,
  WebAXRoleAnnotation,
  WebAXRoleApplication,
  WebAXRoleArticle,
  WebAXRoleAudio,
  WebAXRoleBanner,
  WebAXRoleBlockquote,
  WebAXRoleBusyIndicator,
  WebAXRoleButton,
  WebAXRoleCanvas,
  WebAXRoleCaption,
  WebAXRoleCell,
  WebAXRoleCheckBox,
  WebAXRoleColorWell,
  WebAXRoleColumnHeader,
  WebAXRoleColumn,
  WebAXRoleComboBox,
  WebAXRoleComplementary,
  WebAXRoleContentInfo,
  WebAXRoleDate,
  WebAXRoleDateTime,
  WebAXRoleDefinition,
  WebAXRoleDescriptionListDetail,
  WebAXRoleDescriptionList,
  WebAXRoleDescriptionListTerm,
  WebAXRoleDetails,
  WebAXRoleDialog,
  WebAXRoleDirectory,
  WebAXRoleDisclosureTriangle,
  WebAXRoleDiv,
  WebAXRoleDocument,
  WebAXRoleEmbeddedObject,
  WebAXRoleFeed,
  WebAXRoleFigcaption,
  WebAXRoleFigure,
  WebAXRoleFooter,
  WebAXRoleForm,
  WebAXRoleGrid,
  WebAXRoleGroup,
  WebAXRoleHeading,
  WebAXRoleIframePresentational,
  WebAXRoleIframe,
  WebAXRoleIgnored,
  WebAXRoleImageMapLink,
  WebAXRoleImageMap,
  WebAXRoleImage,
  WebAXRoleInlineTextBox,
  WebAXRoleInputTime,
  WebAXRoleLabel,
  WebAXRoleLegend,
  WebAXRoleLineBreak,
  WebAXRoleLink,
  WebAXRoleListBoxOption,
  WebAXRoleListBox,
  WebAXRoleListItem,
  WebAXRoleListMarker,
  WebAXRoleList,
  WebAXRoleLog,
  WebAXRoleMain,
  WebAXRoleMark,
  WebAXRoleMarquee,
  WebAXRoleMath,
  WebAXRoleMenuBar,
  WebAXRoleMenuButton,
  WebAXRoleMenuItem,
  WebAXRoleMenuItemCheckBox,
  WebAXRoleMenuItemRadio,
  WebAXRoleMenuListOption,
  WebAXRoleMenuListPopup,
  WebAXRoleMenu,
  WebAXRoleMeter,
  WebAXRoleNavigation,
  WebAXRoleNone,
  WebAXRoleNote,
  WebAXRoleOutline,
  WebAXRoleParagraph,
  WebAXRolePopUpButton,
  WebAXRolePre,
  WebAXRolePresentational,
  WebAXRoleProgressIndicator,
  WebAXRoleRadioButton,
  WebAXRoleRadioGroup,
  WebAXRoleRegion,
  WebAXRoleRootWebArea,
  WebAXRoleRowHeader,
  WebAXRoleRow,
  WebAXRoleRuby,
  WebAXRoleRuler,
  WebAXRoleSVGRoot,
  WebAXRoleScrollArea,
  WebAXRoleScrollBar,
  WebAXRoleSeamlessWebArea,
  WebAXRoleSearch,
  WebAXRoleSearchBox,
  WebAXRoleSlider,
  WebAXRoleSliderThumb,
  WebAXRoleSpinButtonPart,
  WebAXRoleSpinButton,
  WebAXRoleSplitter,
  WebAXRoleStaticText,
  WebAXRoleStatus,
  WebAXRoleSwitch,
  WebAXRoleTabGroup,
  WebAXRoleTabList,
  WebAXRoleTabPanel,
  WebAXRoleTab,
  WebAXRoleTableHeaderContainer,
  WebAXRoleTable,
  WebAXRoleTerm,
  WebAXRoleTextField,
  WebAXRoleTime,
  WebAXRoleTimer,
  WebAXRoleToggleButton,
  WebAXRoleToolbar,
  WebAXRoleTreeGrid,
  WebAXRoleTreeItem,
  WebAXRoleTree,
  WebAXRoleUserInterfaceTooltip,
  WebAXRoleVideo,
  WebAXRoleWebArea,
  WebAXRoleWindow,
};

// Accessibility states, used as a bitmask.
enum WebAXState {
  WebAXStateBusy,
  WebAXStateChecked,
  WebAXStateEnabled,
  WebAXStateExpanded,
  WebAXStateFocusable,
  WebAXStateFocused,
  WebAXStateHaspopup,
  WebAXStateHovered,
  WebAXStateInvisible,
  WebAXStateLinked,
  WebAXStateMultiline,
  WebAXStateMultiselectable,
  WebAXStateOffscreen,
  WebAXStatePressed,
  WebAXStateProtected,
  WebAXStateReadonly,
  WebAXStateRequired,
  WebAXStateSelectable,
  WebAXStateSelected,
  WebAXStateVertical,
  WebAXStateVisited,
};

enum class WebAXSupportedAction {
  None = 0,
  Activate,
  Check,
  Click,
  Jump,
  Open,
  Press,
  Select,
  Uncheck
};

enum WebAXTextDirection {
  WebAXTextDirectionLR,
  WebAXTextDirectionRL,
  WebAXTextDirectionTB,
  WebAXTextDirectionBT
};

// Sort direction, only used for roles = WebAXRoleRowHeader and
// WebAXRoleColumnHeader.
enum WebAXSortDirection {
  WebAXSortDirectionUndefined = 0,
  WebAXSortDirectionNone,
  WebAXSortDirectionAscending,
  WebAXSortDirectionDescending,
  WebAXSortDirectionOther
};

// Expanded State.
// These values must match blink::AccessibilityExpanded values.
// Enforced in AssertMatchingEnums.cpp.
enum WebAXExpanded {
  WebAXExpandedUndefined = 0,
  WebAXExpandedCollapsed,
  WebAXExpandedExpanded
};

// These values must match blink::AccessibilityOrientation values.
// Enforced in AssertMatchingEnums.cpp.
enum WebAXOrientation {
  WebAXOrientationUndefined = 0,
  WebAXOrientationVertical,
  WebAXOrientationHorizontal,
};

enum WebAXAriaCurrentState {
  WebAXAriaCurrentStateUndefined = 0,
  WebAXAriaCurrentStateFalse,
  WebAXAriaCurrentStateTrue,
  WebAXAriaCurrentStatePage,
  WebAXAriaCurrentStateStep,
  WebAXAriaCurrentStateLocation,
  WebAXAriaCurrentStateDate,
  WebAXAriaCurrentStateTime
};

// Only used by HTML form controls and any other element that has
// an aria-invalid attribute specified.
enum WebAXInvalidState {
  WebAXInvalidStateUndefined = 0,
  WebAXInvalidStateFalse,
  WebAXInvalidStateTrue,
  WebAXInvalidStateSpelling,
  WebAXInvalidStateGrammar,
  WebAXInvalidStateOther
};

enum WebAXMarkerType {
  WebAXMarkerTypeSpelling = 1 << 0,
  WebAXMarkerTypeGrammar = 1 << 1,
  WebAXMarkerTypeTextMatch = 1 << 2
};

// Used for exposing text attributes.
enum WebAXTextStyle {
  WebAXTextStyleNone = 0,
  WebAXTextStyleBold = 1 << 0,
  WebAXTextStyleItalic = 1 << 1,
  WebAXTextStyleUnderline = 1 << 2,
  WebAXTextStyleLineThrough = 1 << 3
};

// The source of the accessible name of an element. This is needed
// because on some platforms this determines how the accessible name
// is exposed.
enum WebAXNameFrom {
  WebAXNameFromUninitialized = -1,
  WebAXNameFromAttribute = 0,
  WebAXNameFromCaption,
  WebAXNameFromContents,
  WebAXNameFromPlaceholder,
  WebAXNameFromRelatedElement,
  WebAXNameFromValue,
  WebAXNameFromTitle,
};

// The source of the accessible description of an element. This is needed
// because on some platforms this determines how the accessible description
// is exposed.
enum WebAXDescriptionFrom {
  WebAXDescriptionFromUninitialized = -1,
  WebAXDescriptionFromAttribute = 0,
  WebAXDescriptionFromContents,
  WebAXDescriptionFromRelatedElement,
};

// Text affinity for the start or end of a selection.
enum WebAXTextAffinity {
  WebAXTextAffinityUpstream,
  WebAXTextAffinityDownstream
};

//
// Sparse accessibility attributes
//
// The following enums represent accessibility attributes that apply
// to only a small fraction of WebAXObjects. Rather than the client
// asking each WebAXObject for the value of each accessibility
// attribute, it can call a single function to query for all
// sparse attributes at the same time. Any sparse attributes that
// are present are returned via a callback consisting of an attribute
// key enum and an attribute value.
//

// Sparse attributes of a WebAXObject whose value is either true or
// false. In order for it to be a sparse attribute the default value
// must be false.
enum class WebAXBoolAttribute {};

// Sparse attributes of a WebAXObject whose value is a string.
// In order for it to be a sparse attribute the default value
// must be "".
enum class WebAXStringAttribute {
  AriaKeyShortcuts,
  AriaRoleDescription,
};

// Sparse attributes of a WebAXObject whose value is a reference to
// another WebAXObject within the same frame. In order for it to be a
// sparse attribute the default value must be the null WebAXObject.
enum class WebAXObjectAttribute {
  AriaActiveDescendant,
  AriaErrorMessage,
};

// Sparse attributes of a WebAXObject whose value is a vector of
// references to other WebAXObjects within the same frame. In order
// for it to be a sparse attribute the default value must be the
// empty vector.
enum class WebAXObjectVectorAttribute {
  AriaControls,
  AriaDetails,
  AriaFlowTo,
};

}  // namespace blink

#endif