#include <ax_event_generator.h>

Inheritance diagram for ui::AXEventGenerator:

Classes
struct	EventParams

class	Iterator

struct	TargetedEvent

Public Types
enum class	Event : int32_t { ACCESS_KEY_CHANGED , ACTIVE_DESCENDANT_CHANGED , ALERT , ATK_TEXT_OBJECT_ATTRIBUTE_CHANGED , ATOMIC_CHANGED , AUTO_COMPLETE_CHANGED , BUSY_CHANGED , CHECKED_STATE_CHANGED , CHILDREN_CHANGED , CLASS_NAME_CHANGED , COLLAPSED , CONTROLS_CHANGED , DESCRIBED_BY_CHANGED , DESCRIPTION_CHANGED , DOCUMENT_SELECTION_CHANGED , DOCUMENT_TITLE_CHANGED , DROPEFFECT_CHANGED , ENABLED_CHANGED , EXPANDED , FOCUS_CHANGED , FLOW_FROM_CHANGED , FLOW_TO_CHANGED , GRABBED_CHANGED , HASPOPUP_CHANGED , HIERARCHICAL_LEVEL_CHANGED , IGNORED_CHANGED , IMAGE_ANNOTATION_CHANGED , INVALID_STATUS_CHANGED , KEY_SHORTCUTS_CHANGED , LABELED_BY_CHANGED , LANGUAGE_CHANGED , LAYOUT_INVALIDATED , LIVE_REGION_CHANGED , LIVE_REGION_CREATED , LIVE_REGION_NODE_CHANGED , LIVE_RELEVANT_CHANGED , LIVE_STATUS_CHANGED , LOAD_COMPLETE , LOAD_START , MENU_ITEM_SELECTED , MULTILINE_STATE_CHANGED , MULTISELECTABLE_STATE_CHANGED , NAME_CHANGED , OBJECT_ATTRIBUTE_CHANGED , OTHER_ATTRIBUTE_CHANGED , PLACEHOLDER_CHANGED , PORTAL_ACTIVATED , POSITION_IN_SET_CHANGED , RELATED_NODE_CHANGED , READONLY_CHANGED , REQUIRED_STATE_CHANGED , ROLE_CHANGED , ROW_COUNT_CHANGED , SCROLL_HORIZONTAL_POSITION_CHANGED , SCROLL_VERTICAL_POSITION_CHANGED , SELECTED_CHANGED , SELECTED_CHILDREN_CHANGED , SET_SIZE_CHANGED , SORT_CHANGED , STATE_CHANGED , SUBTREE_CREATED , TEXT_ATTRIBUTE_CHANGED , VALUE_CHANGED , VALUE_MAX_CHANGED , VALUE_MIN_CHANGED , VALUE_STEP_CHANGED , WIN_IACCESSIBLE_STATE_CHANGED }

enum class	IgnoredChangedState : uint8_t { kShow , kHide , kCount = 2 }

using	IgnoredChangedStatesBitset = std::bitset< static_cast< size_t >(IgnoredChangedState::kCount)>

using	const_iterator = Iterator

using	iterator = Iterator

using	value_type = TargetedEvent

Public Types inherited from ui::AXTreeObserver
enum	ChangeType { NODE_CREATED , SUBTREE_CREATED , NODE_CHANGED , NODE_REPARENTED , SUBTREE_REPARENTED }

Public Member Functions
	AXEventGenerator ()

	AXEventGenerator (AXTree *tree)

	~AXEventGenerator () override

void	SetTree (AXTree *new_tree)

void	ReleaseTree ()

Iterator	begin () const

Iterator	end () const

void	ClearEvents ()

void	AddEvent (ui::AXNode *node, Event event)

void	set_always_fire_load_complete (bool val)

Public Member Functions inherited from ui::AXTreeObserver
	AXTreeObserver ()

virtual	~AXTreeObserver ()

virtual void	OnNodeDataWillChange (AXTree *tree, const AXNodeData &old_node_data, const AXNodeData &new_node_data)

virtual void	OnStringListAttributeChanged (AXTree tree, AXNode node, ax::mojom::StringListAttribute attr, const std::vector< std::string > &old_value, const std::vector< std::string > &new_value)

virtual void	OnNodeCreated (AXTree tree, AXNode node)

virtual void	OnNodeDeleted (AXTree *tree, int32_t node_id)

virtual void	OnNodeReparented (AXTree tree, AXNode node)

virtual void	OnNodeChanged (AXTree tree, AXNode node)

Protected Member Functions
void	OnNodeDataChanged (AXTree *tree, const AXNodeData &old_node_data, const AXNodeData &new_node_data) override

void	OnRoleChanged (AXTree tree, AXNode node, ax::mojom::Role old_role, ax::mojom::Role new_role) override

void	OnStateChanged (AXTree tree, AXNode node, ax::mojom::State state, bool new_value) override

void	OnStringAttributeChanged (AXTree tree, AXNode node, ax::mojom::StringAttribute attr, const std::string &old_value, const std::string &new_value) override

void	OnIntAttributeChanged (AXTree tree, AXNode node, ax::mojom::IntAttribute attr, int32_t old_value, int32_t new_value) override

void	OnFloatAttributeChanged (AXTree tree, AXNode node, ax::mojom::FloatAttribute attr, float old_value, float new_value) override

void	OnBoolAttributeChanged (AXTree tree, AXNode node, ax::mojom::BoolAttribute attr, bool new_value) override

void	OnIntListAttributeChanged (AXTree tree, AXNode node, ax::mojom::IntListAttribute attr, const std::vector< int32_t > &old_value, const std::vector< int32_t > &new_value) override

void	OnTreeDataChanged (AXTree *tree, const ui::AXTreeData &old_data, const ui::AXTreeData &new_data) override

void	OnNodeWillBeDeleted (AXTree tree, AXNode node) override

void	OnSubtreeWillBeDeleted (AXTree tree, AXNode node) override

void	OnNodeWillBeReparented (AXTree tree, AXNode node) override

void	OnSubtreeWillBeReparented (AXTree tree, AXNode node) override

void	OnAtomicUpdateFinished (AXTree *tree, bool root_changed, const std::vector< Change > &changes) override

Detailed Description

Definition at line 25 of file ax_event_generator.h.

Member Typedef Documentation

◆ const_iterator

using ui::AXEventGenerator::const_iterator = Iterator

Definition at line 157 of file ax_event_generator.h.

◆ IgnoredChangedStatesBitset

using ui::AXEventGenerator::IgnoredChangedStatesBitset = std::bitset<static_cast<size_t>(IgnoredChangedState::kCount)>

Definition at line 155 of file ax_event_generator.h.

◆ iterator

using ui::AXEventGenerator::iterator = Iterator

Definition at line 158 of file ax_event_generator.h.

◆ value_type

using ui::AXEventGenerator::value_type = TargetedEvent

Definition at line 159 of file ax_event_generator.h.

Member Enumeration Documentation

◆ Event

enum class ui::AXEventGenerator::Event : int32_t

strong

Enumerator
ACCESS_KEY_CHANGED
ACTIVE_DESCENDANT_CHANGED
ALERT
ATK_TEXT_OBJECT_ATTRIBUTE_CHANGED
ATOMIC_CHANGED
AUTO_COMPLETE_CHANGED
BUSY_CHANGED
CHECKED_STATE_CHANGED
CHILDREN_CHANGED
CLASS_NAME_CHANGED
COLLAPSED
CONTROLS_CHANGED
DESCRIBED_BY_CHANGED
DESCRIPTION_CHANGED
DOCUMENT_SELECTION_CHANGED
DOCUMENT_TITLE_CHANGED
DROPEFFECT_CHANGED
ENABLED_CHANGED
EXPANDED
FOCUS_CHANGED
FLOW_FROM_CHANGED
FLOW_TO_CHANGED
GRABBED_CHANGED
HASPOPUP_CHANGED
HIERARCHICAL_LEVEL_CHANGED
IGNORED_CHANGED
IMAGE_ANNOTATION_CHANGED
INVALID_STATUS_CHANGED
KEY_SHORTCUTS_CHANGED
LABELED_BY_CHANGED
LANGUAGE_CHANGED
LAYOUT_INVALIDATED
LIVE_REGION_CHANGED
LIVE_REGION_CREATED
LIVE_REGION_NODE_CHANGED
LIVE_RELEVANT_CHANGED
LIVE_STATUS_CHANGED
LOAD_COMPLETE
LOAD_START
MENU_ITEM_SELECTED
MULTILINE_STATE_CHANGED
MULTISELECTABLE_STATE_CHANGED
NAME_CHANGED
OBJECT_ATTRIBUTE_CHANGED
OTHER_ATTRIBUTE_CHANGED
PLACEHOLDER_CHANGED
PORTAL_ACTIVATED
POSITION_IN_SET_CHANGED
RELATED_NODE_CHANGED
READONLY_CHANGED
REQUIRED_STATE_CHANGED
ROLE_CHANGED
ROW_COUNT_CHANGED
SCROLL_HORIZONTAL_POSITION_CHANGED
SCROLL_VERTICAL_POSITION_CHANGED
SELECTED_CHANGED
SELECTED_CHILDREN_CHANGED
SET_SIZE_CHANGED
SORT_CHANGED
STATE_CHANGED
SUBTREE_CREATED
TEXT_ATTRIBUTE_CHANGED
VALUE_CHANGED
VALUE_MAX_CHANGED
VALUE_MIN_CHANGED
VALUE_STEP_CHANGED
WIN_IACCESSIBLE_STATE_CHANGED

Definition at line 27 of file ax_event_generator.h.

                   : int32_t {
    ACCESS_KEY_CHANGED,
    ACTIVE_DESCENDANT_CHANGED,
    ALERT,
    // ATK treats alignment, indentation, and other format-related attributes as
    // text attributes even when they are only applicable to the entire object.
    // And it lacks an event for object attributes changing.
    ATK_TEXT_OBJECT_ATTRIBUTE_CHANGED,
    ATOMIC_CHANGED,
    AUTO_COMPLETE_CHANGED,
    BUSY_CHANGED,
    CHECKED_STATE_CHANGED,
    CHILDREN_CHANGED,
    CLASS_NAME_CHANGED,
    COLLAPSED,
    CONTROLS_CHANGED,
    DESCRIBED_BY_CHANGED,
    DESCRIPTION_CHANGED,
    DOCUMENT_SELECTION_CHANGED,
    DOCUMENT_TITLE_CHANGED,
    DROPEFFECT_CHANGED,
    ENABLED_CHANGED,
    EXPANDED,
    FOCUS_CHANGED,
    FLOW_FROM_CHANGED,
    FLOW_TO_CHANGED,
    GRABBED_CHANGED,
    HASPOPUP_CHANGED,
    HIERARCHICAL_LEVEL_CHANGED,
    IGNORED_CHANGED,
    IMAGE_ANNOTATION_CHANGED,
    INVALID_STATUS_CHANGED,
    KEY_SHORTCUTS_CHANGED,
    LABELED_BY_CHANGED,
    LANGUAGE_CHANGED,
    LAYOUT_INVALIDATED,   // Fired when aria-busy goes false
    LIVE_REGION_CHANGED,  // Fired on the root of a live region.
    LIVE_REGION_CREATED,
    LIVE_REGION_NODE_CHANGED,  // Fired on a node within a live region.
    LIVE_RELEVANT_CHANGED,
    LIVE_STATUS_CHANGED,
    LOAD_COMPLETE,
    LOAD_START,
    MENU_ITEM_SELECTED,
    MULTILINE_STATE_CHANGED,
    MULTISELECTABLE_STATE_CHANGED,
    NAME_CHANGED,
    OBJECT_ATTRIBUTE_CHANGED,
    OTHER_ATTRIBUTE_CHANGED,
    PLACEHOLDER_CHANGED,
    PORTAL_ACTIVATED,
    POSITION_IN_SET_CHANGED,
    RELATED_NODE_CHANGED,
    READONLY_CHANGED,
    REQUIRED_STATE_CHANGED,
    ROLE_CHANGED,
    ROW_COUNT_CHANGED,
    SCROLL_HORIZONTAL_POSITION_CHANGED,
    SCROLL_VERTICAL_POSITION_CHANGED,
    SELECTED_CHANGED,
    SELECTED_CHILDREN_CHANGED,
    SET_SIZE_CHANGED,
    SORT_CHANGED,
    STATE_CHANGED,
    SUBTREE_CREATED,
    TEXT_ATTRIBUTE_CHANGED,
    VALUE_CHANGED,
    VALUE_MAX_CHANGED,
    VALUE_MIN_CHANGED,
    VALUE_STEP_CHANGED,
 
    // This event is for the exact set of attributes that affect
    // the MSAA/IAccessible state on Windows. Not needed on other platforms,
    // but very natural to compute here.
    WIN_IACCESSIBLE_STATE_CHANGED,
  };

◆ IgnoredChangedState

enum class ui::AXEventGenerator::IgnoredChangedState : uint8_t

strong

Enumerator
kShow
kHide
kCount

Definition at line 106 of file ax_event_generator.h.

106: uint8_t { kShow, kHide, kCount = 2 };

ui::AXEventGenerator::IgnoredChangedState::kCount

@ kCount

ui::AXEventGenerator::IgnoredChangedState::kHide

@ kHide

ui::AXEventGenerator::IgnoredChangedState::kShow

@ kShow

Constructor & Destructor Documentation

◆ AXEventGenerator() [1/2]

ui::AXEventGenerator::AXEventGenerator ( )

default

◆ AXEventGenerator() [2/2]

ui::AXEventGenerator::AXEventGenerator ( AXTree * tree )

explicit

Definition at line 150 of file ax_event_generator.cc.

                                               : tree_(tree) {
  if (tree_)
    tree_->AddObserver(this);
}

References ui::AXTree::AddObserver().

◆ ~AXEventGenerator()

ui::AXEventGenerator::~AXEventGenerator ( )

overridedefault

Member Function Documentation

◆ AddEvent()

void ui::AXEventGenerator::AddEvent	(	ui::AXNode *	node,
		AXEventGenerator::Event	event
	)

Definition at line 174 of file ax_event_generator.cc.

                                                                         {
  BASE_DCHECK(node);
 
  if (node->data().role == ax::mojom::Role::kInlineTextBox)
    return;
 
  std::set<EventParams>& node_events = tree_events_[node];
  node_events.emplace(event, ax::mojom::EventFrom::kNone,
                      tree_->event_intents());
}

References BASE_DCHECK, ui::AXNode::data(), ui::AXTree::event_intents(), ax::mojom::kInlineTextBox, ax::mojom::kNone, and ui::AXNodeData::role.

Referenced by OnAtomicUpdateFinished(), OnBoolAttributeChanged(), OnFloatAttributeChanged(), OnIntAttributeChanged(), OnIntListAttributeChanged(), OnRoleChanged(), OnStateChanged(), OnStringAttributeChanged(), and OnTreeDataChanged().

◆ begin()

Iterator ui::AXEventGenerator::begin ( ) const

inline

Definition at line 181 of file ax_event_generator.h.

                         {
    return Iterator(tree_events_, tree_events_.begin());
  }

Referenced by flutter::AccessibilityBridge::GetPendingEvents().

◆ ClearEvents()

void ui::AXEventGenerator::ClearEvents ( )

Definition at line 170 of file ax_event_generator.cc.

                                   {
  tree_events_.clear();
}

Referenced by flutter::AccessibilityBridge::CommitUpdates(), and ui::TEST().

◆ end()

Iterator ui::AXEventGenerator::end ( ) const

inline

Definition at line 184 of file ax_event_generator.h.

184{ return Iterator(tree_events_, tree_events_.end()); }

Referenced by flutter::AccessibilityBridge::GetPendingEvents().

◆ OnAtomicUpdateFinished()

void ui::AXEventGenerator::OnAtomicUpdateFinished	(	AXTree *	tree,
		bool	root_changed,
		const std::vector< Change > &	changes
	)

overrideprotectedvirtual

Reimplemented from ui::AXTreeObserver.

Definition at line 599 of file ax_event_generator.cc.

                                      {
  BASE_DCHECK(tree_ == tree);
 
  if (root_changed && ShouldFireLoadEvents(tree->root())) {
    if (tree->data().loaded)
      AddEvent(tree->root(), Event::LOAD_COMPLETE);
    else
      AddEvent(tree->root(), Event::LOAD_START);
  }
 
  for (const auto& change : changes) {
    if (change.type == SUBTREE_CREATED) {
      AddEvent(change.node, Event::SUBTREE_CREATED);
    } else if (change.type != NODE_CREATED) {
      FireRelationSourceEvents(tree, change.node);
      continue;
    }
 
    if (IsAlert(change.node->data().role))
      AddEvent(change.node, Event::ALERT);
    else if (IsActiveLiveRegion(change))
      AddEvent(change.node, Event::LIVE_REGION_CREATED);
    else if (IsContainedInLiveRegion(change))
      FireLiveRegionEvents(change.node);
  }
 
  FireActiveDescendantEvents();
 
  PostprocessEvents();
}

References AddEvent(), ALERT, BASE_DCHECK, ui::AXTree::data(), ui::IsAlert(), LIVE_REGION_CREATED, LOAD_COMPLETE, LOAD_START, ui::AXTreeData::loaded, ui::AXTreeObserver::NODE_CREATED, ui::AXTree::root(), and SUBTREE_CREATED.

◆ OnBoolAttributeChanged()

void ui::AXEventGenerator::OnBoolAttributeChanged	(	AXTree *	tree,
		AXNode *	node,
		ax::mojom::BoolAttribute	attr,
		bool	new_value
	)

overrideprotectedvirtual

Reimplemented from ui::AXTreeObserver.

Definition at line 469 of file ax_event_generator.cc.

                                                              {
  BASE_DCHECK(tree_ == tree);
 
  switch (attr) {
    case ax::mojom::BoolAttribute::kBusy:
      AddEvent(node, Event::BUSY_CHANGED);
      AddEvent(node, Event::WIN_IACCESSIBLE_STATE_CHANGED);
      // Fire an 'invalidated' event when aria-busy becomes false
      if (!new_value)
        AddEvent(node, Event::LAYOUT_INVALIDATED);
      break;
    case ax::mojom::BoolAttribute::kGrabbed:
      AddEvent(node, Event::GRABBED_CHANGED);
      break;
    case ax::mojom::BoolAttribute::kLiveAtomic:
      AddEvent(node, Event::ATOMIC_CHANGED);
      break;
    case ax::mojom::BoolAttribute::kSelected: {
      AddEvent(node, Event::SELECTED_CHANGED);
      AddEvent(node, Event::WIN_IACCESSIBLE_STATE_CHANGED);
      AXNode* container = node;
      while (container &&
             !IsContainerWithSelectableChildren(container->data().role))
        container = container->parent();
      if (container)
        AddEvent(container, Event::SELECTED_CHILDREN_CHANGED);
      break;
    }
    default:
      AddEvent(node, Event::OTHER_ATTRIBUTE_CHANGED);
      break;
  }
}

References AddEvent(), ATOMIC_CHANGED, BASE_DCHECK, BUSY_CHANGED, ui::AXNode::data(), GRABBED_CHANGED, ui::IsContainerWithSelectableChildren(), ax::mojom::kBusy, ax::mojom::kGrabbed, ax::mojom::kLiveAtomic, ax::mojom::kSelected, LAYOUT_INVALIDATED, OTHER_ATTRIBUTE_CHANGED, ui::AXNode::parent(), ui::AXNodeData::role, SELECTED_CHANGED, SELECTED_CHILDREN_CHANGED, and WIN_IACCESSIBLE_STATE_CHANGED.

◆ OnFloatAttributeChanged()

void ui::AXEventGenerator::OnFloatAttributeChanged	(	AXTree *	tree,
		AXNode *	node,
		ax::mojom::FloatAttribute	attr,
		float	old_value,
		float	new_value
	)

overrideprotectedvirtual

Reimplemented from ui::AXTreeObserver.

Definition at line 431 of file ax_event_generator.cc.

                                                                {
  BASE_DCHECK(tree_ == tree);
 
  switch (attr) {
    case ax::mojom::FloatAttribute::kMaxValueForRange:
      AddEvent(node, Event::VALUE_MAX_CHANGED);
      break;
    case ax::mojom::FloatAttribute::kMinValueForRange:
      AddEvent(node, Event::VALUE_MIN_CHANGED);
      break;
    case ax::mojom::FloatAttribute::kStepValueForRange:
      AddEvent(node, Event::VALUE_STEP_CHANGED);
      break;
    case ax::mojom::FloatAttribute::kValueForRange:
      AddEvent(node, Event::VALUE_CHANGED);
      break;
    case ax::mojom::FloatAttribute::kFontSize:
    case ax::mojom::FloatAttribute::kFontWeight:
      AddEvent(node, Event::TEXT_ATTRIBUTE_CHANGED);
      break;
    case ax::mojom::FloatAttribute::kTextIndent:
      // Indentation is exposed as an object attribute because it cannot apply
      // to a substring. However, for some platforms (e.g. ATK), alignment is a
      // text attribute. Therefore fire both events to ensure platforms get the
      // expected notifications.
      AddEvent(node, Event::ATK_TEXT_OBJECT_ATTRIBUTE_CHANGED);
      AddEvent(node, Event::OBJECT_ATTRIBUTE_CHANGED);
      break;
    default:
      AddEvent(node, Event::OTHER_ATTRIBUTE_CHANGED);
      break;
  }
}

References AddEvent(), ATK_TEXT_OBJECT_ATTRIBUTE_CHANGED, BASE_DCHECK, ax::mojom::kFontSize, ax::mojom::kFontWeight, ax::mojom::kMaxValueForRange, ax::mojom::kMinValueForRange, ax::mojom::kStepValueForRange, ax::mojom::kTextIndent, ax::mojom::kValueForRange, OBJECT_ATTRIBUTE_CHANGED, OTHER_ATTRIBUTE_CHANGED, TEXT_ATTRIBUTE_CHANGED, VALUE_CHANGED, VALUE_MAX_CHANGED, VALUE_MIN_CHANGED, and VALUE_STEP_CHANGED.

◆ OnIntAttributeChanged()

void ui::AXEventGenerator::OnIntAttributeChanged	(	AXTree *	tree,
		AXNode *	node,
		ax::mojom::IntAttribute	attr,
		int32_t	old_value,
		int32_t	new_value
	)

overrideprotectedvirtual

Reimplemented from ui::AXTreeObserver.

Definition at line 332 of file ax_event_generator.cc.

                                                                {
  BASE_DCHECK(tree_ == tree);
 
  switch (attr) {
    case ax::mojom::IntAttribute::kActivedescendantId:
      // Don't fire on invisible containers, as it confuses some screen readers,
      // such as NVDA.
      if (!node->data().HasState(ax::mojom::State::kInvisible)) {
        AddEvent(node, Event::ACTIVE_DESCENDANT_CHANGED);
        active_descendant_changed_.push_back(node);
      }
      break;
    case ax::mojom::IntAttribute::kCheckedState:
      AddEvent(node, Event::CHECKED_STATE_CHANGED);
      AddEvent(node, Event::WIN_IACCESSIBLE_STATE_CHANGED);
      break;
    case ax::mojom::IntAttribute::kDropeffect:
      AddEvent(node, Event::DROPEFFECT_CHANGED);
      break;
    case ax::mojom::IntAttribute::kHasPopup:
      AddEvent(node, Event::HASPOPUP_CHANGED);
      AddEvent(node, Event::WIN_IACCESSIBLE_STATE_CHANGED);
      break;
    case ax::mojom::IntAttribute::kHierarchicalLevel:
      AddEvent(node, Event::HIERARCHICAL_LEVEL_CHANGED);
      break;
    case ax::mojom::IntAttribute::kInvalidState:
      AddEvent(node, Event::INVALID_STATUS_CHANGED);
      break;
    case ax::mojom::IntAttribute::kPosInSet:
      AddEvent(node, Event::POSITION_IN_SET_CHANGED);
      break;
    case ax::mojom::IntAttribute::kRestriction: {
      bool was_enabled;
      bool was_readonly;
      GetRestrictionStates(static_cast<ax::mojom::Restriction>(old_value),
                           &was_enabled, &was_readonly);
      bool is_enabled;
      bool is_readonly;
      GetRestrictionStates(static_cast<ax::mojom::Restriction>(new_value),
                           &is_enabled, &is_readonly);
 
      if (was_enabled != is_enabled) {
        AddEvent(node, Event::ENABLED_CHANGED);
        AddEvent(node, Event::WIN_IACCESSIBLE_STATE_CHANGED);
      }
      if (was_readonly != is_readonly) {
        AddEvent(node, Event::READONLY_CHANGED);
        AddEvent(node, Event::WIN_IACCESSIBLE_STATE_CHANGED);
      }
      break;
    }
    case ax::mojom::IntAttribute::kScrollX:
      AddEvent(node, Event::SCROLL_HORIZONTAL_POSITION_CHANGED);
      break;
    case ax::mojom::IntAttribute::kScrollY:
      AddEvent(node, Event::SCROLL_VERTICAL_POSITION_CHANGED);
      break;
    case ax::mojom::IntAttribute::kSortDirection:
      // Ignore sort direction changes on roles other than table headers and
      // grid headers.
      if (IsTableHeader(node->data().role))
        AddEvent(node, Event::SORT_CHANGED);
      break;
    case ax::mojom::IntAttribute::kImageAnnotationStatus:
      // The image annotation is reported as part of the accessible name.
      AddEvent(node, Event::IMAGE_ANNOTATION_CHANGED);
      break;
    case ax::mojom::IntAttribute::kSetSize:
      AddEvent(node, Event::SET_SIZE_CHANGED);
      break;
    case ax::mojom::IntAttribute::kBackgroundColor:
    case ax::mojom::IntAttribute::kColor:
    case ax::mojom::IntAttribute::kTextDirection:
    case ax::mojom::IntAttribute::kTextPosition:
    case ax::mojom::IntAttribute::kTextStyle:
    case ax::mojom::IntAttribute::kTextOverlineStyle:
    case ax::mojom::IntAttribute::kTextStrikethroughStyle:
    case ax::mojom::IntAttribute::kTextUnderlineStyle:
      AddEvent(node, Event::TEXT_ATTRIBUTE_CHANGED);
      break;
    case ax::mojom::IntAttribute::kTextAlign:
      // Alignment is exposed as an object attribute because it cannot apply to
      // a substring. However, for some platforms (e.g. ATK), alignment is a
      // text attribute. Therefore fire both events to ensure platforms get the
      // expected notifications.
      AddEvent(node, Event::ATK_TEXT_OBJECT_ATTRIBUTE_CHANGED);
      AddEvent(node, Event::OBJECT_ATTRIBUTE_CHANGED);
      break;
    default:
      AddEvent(node, Event::OTHER_ATTRIBUTE_CHANGED);
      break;
  }
}

References ACTIVE_DESCENDANT_CHANGED, AddEvent(), ATK_TEXT_OBJECT_ATTRIBUTE_CHANGED, BASE_DCHECK, CHECKED_STATE_CHANGED, ui::AXNode::data(), DROPEFFECT_CHANGED, ENABLED_CHANGED, HASPOPUP_CHANGED, ui::AXNodeData::HasState(), HIERARCHICAL_LEVEL_CHANGED, IMAGE_ANNOTATION_CHANGED, INVALID_STATUS_CHANGED, is_enabled(), ui::IsTableHeader(), ax::mojom::kActivedescendantId, ax::mojom::kBackgroundColor, ax::mojom::kCheckedState, ax::mojom::kColor, ax::mojom::kDropeffect, ax::mojom::kHasPopup, ax::mojom::kHierarchicalLevel, ax::mojom::kImageAnnotationStatus, ax::mojom::kInvalidState, ax::mojom::kInvisible, ax::mojom::kPosInSet, ax::mojom::kRestriction, ax::mojom::kScrollX, ax::mojom::kScrollY, ax::mojom::kSetSize, ax::mojom::kSortDirection, ax::mojom::kTextAlign, ax::mojom::kTextDirection, ax::mojom::kTextOverlineStyle, ax::mojom::kTextPosition, ax::mojom::kTextStrikethroughStyle, ax::mojom::kTextStyle, ax::mojom::kTextUnderlineStyle, OBJECT_ATTRIBUTE_CHANGED, OTHER_ATTRIBUTE_CHANGED, POSITION_IN_SET_CHANGED, READONLY_CHANGED, ui::AXNodeData::role, SCROLL_HORIZONTAL_POSITION_CHANGED, SCROLL_VERTICAL_POSITION_CHANGED, SET_SIZE_CHANGED, SORT_CHANGED, TEXT_ATTRIBUTE_CHANGED, and WIN_IACCESSIBLE_STATE_CHANGED.

◆ OnIntListAttributeChanged()

void ui::AXEventGenerator::OnIntListAttributeChanged	(	AXTree *	tree,
		AXNode *	node,
		ax::mojom::IntListAttribute	attr,
		const std::vector< int32_t > &	old_value,
		const std::vector< int32_t > &	new_value
	)

overrideprotectedvirtual

Reimplemented from ui::AXTreeObserver.

Definition at line 506 of file ax_event_generator.cc.

                                         {
  BASE_DCHECK(tree_ == tree);
 
  switch (attr) {
    case ax::mojom::IntListAttribute::kControlsIds:
      AddEvent(node, Event::CONTROLS_CHANGED);
      break;
    case ax::mojom::IntListAttribute::kDescribedbyIds:
      AddEvent(node, Event::DESCRIBED_BY_CHANGED);
      break;
    case ax::mojom::IntListAttribute::kFlowtoIds: {
      AddEvent(node, Event::FLOW_TO_CHANGED);
 
      // Fire FLOW_FROM_CHANGED for all nodes added or removed
      for (int32_t id : ComputeIntListDifference(old_value, new_value)) {
        if (auto* target_node = tree->GetFromId(id))
          AddEvent(target_node, Event::FLOW_FROM_CHANGED);
      }
      break;
    }
    case ax::mojom::IntListAttribute::kLabelledbyIds:
      AddEvent(node, Event::LABELED_BY_CHANGED);
      break;
    case ax::mojom::IntListAttribute::kMarkerEnds:
    case ax::mojom::IntListAttribute::kMarkerStarts:
    case ax::mojom::IntListAttribute::kMarkerTypes:
      // On a native text field, the spelling- and grammar-error markers are
      // associated with children not exposed on any platform. Therefore, we
      // adjust the node we fire that event on here.
      if (AXNode* text_field = node->GetTextFieldAncestor())
        AddEvent(text_field, Event::TEXT_ATTRIBUTE_CHANGED);
      else
        AddEvent(node, Event::TEXT_ATTRIBUTE_CHANGED);
      break;
    default:
      AddEvent(node, Event::OTHER_ATTRIBUTE_CHANGED);
      break;
  }
}

References AddEvent(), BASE_DCHECK, CONTROLS_CHANGED, DESCRIBED_BY_CHANGED, FLOW_FROM_CHANGED, FLOW_TO_CHANGED, ui::AXTree::GetFromId(), ui::AXNode::GetTextFieldAncestor(), ax::mojom::kControlsIds, ax::mojom::kDescribedbyIds, ax::mojom::kFlowtoIds, ax::mojom::kLabelledbyIds, ax::mojom::kMarkerEnds, ax::mojom::kMarkerStarts, ax::mojom::kMarkerTypes, LABELED_BY_CHANGED, OTHER_ATTRIBUTE_CHANGED, and TEXT_ATTRIBUTE_CHANGED.

◆ OnNodeDataChanged()

void ui::AXEventGenerator::OnNodeDataChanged	(	AXTree *	tree,
		const AXNodeData &	old_node_data,
		const AXNodeData &	new_node_data
	)

overrideprotectedvirtual

Reimplemented from ui::AXTreeObserver.

Definition at line 185 of file ax_event_generator.cc.

                                                                          {
  BASE_DCHECK(tree_ == tree);
  // Fire CHILDREN_CHANGED events when the list of children updates.
  // Internally we store inline text box nodes as children of a static text
  // node or a line break node, which enables us to determine character bounds
  // and line layout. We don't expose those to platform APIs, though, so
  // suppress CHILDREN_CHANGED events on static text nodes.
  if (new_node_data.child_ids != old_node_data.child_ids &&
      !ui::IsText(new_node_data.role)) {
    AXNode* node = tree_->GetFromId(new_node_data.id);
    tree_events_[node].emplace(Event::CHILDREN_CHANGED,
                               ax::mojom::EventFrom::kNone,
                               tree_->event_intents());
  }
}

References BASE_DCHECK, ui::AXNodeData::child_ids, CHILDREN_CHANGED, ui::AXTree::event_intents(), ui::AXTree::GetFromId(), ui::AXNodeData::id, ui::IsText(), ax::mojom::kNone, and ui::AXNodeData::role.

◆ OnNodeWillBeDeleted()

void ui::AXEventGenerator::OnNodeWillBeDeleted	(	AXTree *	tree,
		AXNode *	node
	)

overrideprotectedvirtual

Reimplemented from ui::AXTreeObserver.

Definition at line 581 of file ax_event_generator.cc.

                                                                     {
  BASE_DCHECK(tree_ == tree);
  tree_events_.erase(node);
}

References BASE_DCHECK.

◆ OnNodeWillBeReparented()

void ui::AXEventGenerator::OnNodeWillBeReparented	(	AXTree *	tree,
		AXNode *	node
	)

overrideprotectedvirtual

Reimplemented from ui::AXTreeObserver.

Definition at line 590 of file ax_event_generator.cc.

                                                                        {
  BASE_DCHECK(tree_ == tree);
  tree_events_.erase(node);
}

References BASE_DCHECK.

◆ OnRoleChanged()

void ui::AXEventGenerator::OnRoleChanged	(	AXTree *	tree,
		AXNode *	node,
		ax::mojom::Role	old_role,
		ax::mojom::Role	new_role
	)

overrideprotectedvirtual

Reimplemented from ui::AXTreeObserver.

Definition at line 203 of file ax_event_generator.cc.

                                                           {
  BASE_DCHECK(tree_ == tree);
  AddEvent(node, Event::ROLE_CHANGED);
}

References AddEvent(), BASE_DCHECK, and ROLE_CHANGED.

◆ OnStateChanged()

void ui::AXEventGenerator::OnStateChanged	(	AXTree *	tree,
		AXNode *	node,
		ax::mojom::State	state,
		bool	new_value
	)

overrideprotectedvirtual

Reimplemented from ui::AXTreeObserver.

Definition at line 211 of file ax_event_generator.cc.

                                                      {
  BASE_DCHECK(tree_ == tree);
 
  if (state != ax::mojom::State::kIgnored) {
    AddEvent(node, Event::STATE_CHANGED);
    AddEvent(node, Event::WIN_IACCESSIBLE_STATE_CHANGED);
  }
 
  switch (state) {
    case ax::mojom::State::kExpanded:
      AddEvent(node, new_value ? Event::EXPANDED : Event::COLLAPSED);
 
      if (node->data().role == ax::mojom::Role::kRow ||
          node->data().role == ax::mojom::Role::kTreeItem) {
        AXNode* container = node;
        while (container && !IsRowContainer(container->data().role))
          container = container->parent();
        if (container)
          AddEvent(container, Event::ROW_COUNT_CHANGED);
      }
      break;
    case ax::mojom::State::kIgnored: {
      AXNode* unignored_parent = node->GetUnignoredParent();
      if (unignored_parent)
        AddEvent(unignored_parent, Event::CHILDREN_CHANGED);
      AddEvent(node, Event::IGNORED_CHANGED);
      if (!new_value)
        AddEvent(node, Event::SUBTREE_CREATED);
      break;
    }
    case ax::mojom::State::kMultiline:
      AddEvent(node, Event::MULTILINE_STATE_CHANGED);
      break;
    case ax::mojom::State::kMultiselectable:
      AddEvent(node, Event::MULTISELECTABLE_STATE_CHANGED);
      break;
    case ax::mojom::State::kRequired:
      AddEvent(node, Event::REQUIRED_STATE_CHANGED);
      break;
    default:
      break;
  }
}

References AddEvent(), BASE_DCHECK, CHILDREN_CHANGED, COLLAPSED, ui::AXNode::data(), EXPANDED, ui::AXNode::GetUnignoredParent(), IGNORED_CHANGED, ui::IsRowContainer(), ax::mojom::kExpanded, ax::mojom::kIgnored, ax::mojom::kMultiline, ax::mojom::kMultiselectable, ax::mojom::kRequired, ax::mojom::kRow, ax::mojom::kTreeItem, MULTILINE_STATE_CHANGED, MULTISELECTABLE_STATE_CHANGED, ui::AXNode::parent(), REQUIRED_STATE_CHANGED, ui::AXNodeData::role, ROW_COUNT_CHANGED, STATE_CHANGED, SUBTREE_CREATED, and WIN_IACCESSIBLE_STATE_CHANGED.

◆ OnStringAttributeChanged()

void ui::AXEventGenerator::OnStringAttributeChanged	(	AXTree *	tree,
		AXNode *	node,
		ax::mojom::StringAttribute	attr,
		const std::string &	old_value,
		const std::string &	new_value
	)

overrideprotectedvirtual

Reimplemented from ui::AXTreeObserver.

Definition at line 258 of file ax_event_generator.cc.

                                                                            {
  BASE_DCHECK(tree_ == tree);
 
  switch (attr) {
    case ax::mojom::StringAttribute::kAccessKey:
      AddEvent(node, Event::ACCESS_KEY_CHANGED);
      break;
    case ax::mojom::StringAttribute::kAriaInvalidValue:
      AddEvent(node, Event::INVALID_STATUS_CHANGED);
      break;
    case ax::mojom::StringAttribute::kAutoComplete:
      AddEvent(node, Event::AUTO_COMPLETE_CHANGED);
      break;
    case ax::mojom::StringAttribute::kClassName:
      AddEvent(node, Event::CLASS_NAME_CHANGED);
      break;
    case ax::mojom::StringAttribute::kDescription:
      AddEvent(node, Event::DESCRIPTION_CHANGED);
      break;
    case ax::mojom::StringAttribute::kKeyShortcuts:
      AddEvent(node, Event::KEY_SHORTCUTS_CHANGED);
      break;
    case ax::mojom::StringAttribute::kLanguage:
      AddEvent(node, Event::LANGUAGE_CHANGED);
      break;
    case ax::mojom::StringAttribute::kLiveRelevant:
      AddEvent(node, Event::LIVE_RELEVANT_CHANGED);
      break;
    case ax::mojom::StringAttribute::kLiveStatus:
      AddEvent(node, Event::LIVE_STATUS_CHANGED);
 
      // Fire a LIVE_REGION_CREATED if the previous value was off, and the new
      // value is not-off.
      if (!IsAlert(node->data().role)) {
        bool old_state = !old_value.empty() && old_value != "off";
        bool new_state = !new_value.empty() && new_value != "off";
        if (!old_state && new_state)
          AddEvent(node, Event::LIVE_REGION_CREATED);
      }
      break;
    case ax::mojom::StringAttribute::kName:
      // If the name of the root node changes, we expect OnTreeDataChanged to
      // add a DOCUMENT_TITLE_CHANGED event instead.
      if (node != tree->root())
        AddEvent(node, Event::NAME_CHANGED);
 
      if (node->data().HasStringAttribute(
              ax::mojom::StringAttribute::kContainerLiveStatus)) {
        FireLiveRegionEvents(node);
      }
      break;
    case ax::mojom::StringAttribute::kPlaceholder:
      AddEvent(node, Event::PLACEHOLDER_CHANGED);
      break;
    case ax::mojom::StringAttribute::kValue:
      AddEvent(node, Event::VALUE_CHANGED);
      break;
    case ax::mojom::StringAttribute::kImageAnnotation:
      // The image annotation is reported as part of the accessible name.
      AddEvent(node, Event::IMAGE_ANNOTATION_CHANGED);
      break;
    case ax::mojom::StringAttribute::kFontFamily:
      AddEvent(node, Event::TEXT_ATTRIBUTE_CHANGED);
      break;
    default:
      AddEvent(node, Event::OTHER_ATTRIBUTE_CHANGED);
      break;
  }
}

References ACCESS_KEY_CHANGED, AddEvent(), AUTO_COMPLETE_CHANGED, BASE_DCHECK, CLASS_NAME_CHANGED, ui::AXNode::data(), DESCRIPTION_CHANGED, ui::AXNodeData::HasStringAttribute(), IMAGE_ANNOTATION_CHANGED, INVALID_STATUS_CHANGED, ui::IsAlert(), ax::mojom::kAccessKey, ax::mojom::kAriaInvalidValue, ax::mojom::kAutoComplete, ax::mojom::kClassName, ax::mojom::kContainerLiveStatus, ax::mojom::kDescription, KEY_SHORTCUTS_CHANGED, ax::mojom::kFontFamily, ax::mojom::kImageAnnotation, ax::mojom::kKeyShortcuts, ax::mojom::kLanguage, ax::mojom::kLiveRelevant, ax::mojom::kLiveStatus, ax::mojom::kName, ax::mojom::kPlaceholder, ax::mojom::kValue, LANGUAGE_CHANGED, LIVE_REGION_CREATED, LIVE_RELEVANT_CHANGED, LIVE_STATUS_CHANGED, NAME_CHANGED, OTHER_ATTRIBUTE_CHANGED, PLACEHOLDER_CHANGED, ui::AXNodeData::role, ui::AXTree::root(), TEXT_ATTRIBUTE_CHANGED, and VALUE_CHANGED.

◆ OnSubtreeWillBeDeleted()

void ui::AXEventGenerator::OnSubtreeWillBeDeleted	(	AXTree *	tree,
		AXNode *	node
	)

overrideprotectedvirtual

Reimplemented from ui::AXTreeObserver.

Definition at line 586 of file ax_event_generator.cc.

                                                                        {
  BASE_DCHECK(tree_ == tree);
}

References BASE_DCHECK.

◆ OnSubtreeWillBeReparented()

void ui::AXEventGenerator::OnSubtreeWillBeReparented	(	AXTree *	tree,
		AXNode *	node
	)

overrideprotectedvirtual

Reimplemented from ui::AXTreeObserver.

Definition at line 595 of file ax_event_generator.cc.

                                                                           {
  BASE_DCHECK(tree_ == tree);
}

References BASE_DCHECK.

◆ OnTreeDataChanged()

void ui::AXEventGenerator::OnTreeDataChanged	(	AXTree *	tree,
		const ui::AXTreeData &	old_data,
		const ui::AXTreeData &	new_data
	)

overrideprotectedvirtual

Reimplemented from ui::AXTreeObserver.

Definition at line 551 of file ax_event_generator.cc.

                                                                          {
  BASE_DCHECK(tree_ == tree);
 
  if (new_tree_data.loaded && !old_tree_data.loaded &&
      ShouldFireLoadEvents(tree->root())) {
    AddEvent(tree->root(), Event::LOAD_COMPLETE);
  }
 
  if (new_tree_data.sel_is_backward != old_tree_data.sel_is_backward ||
      new_tree_data.sel_anchor_object_id !=
          old_tree_data.sel_anchor_object_id ||
      new_tree_data.sel_anchor_offset != old_tree_data.sel_anchor_offset ||
      new_tree_data.sel_anchor_affinity != old_tree_data.sel_anchor_affinity ||
      new_tree_data.sel_focus_object_id != old_tree_data.sel_focus_object_id ||
      new_tree_data.sel_focus_offset != old_tree_data.sel_focus_offset ||
      new_tree_data.sel_focus_affinity != old_tree_data.sel_focus_affinity) {
    AddEvent(tree->root(), Event::DOCUMENT_SELECTION_CHANGED);
  }
  if (new_tree_data.title != old_tree_data.title)
    AddEvent(tree->root(), Event::DOCUMENT_TITLE_CHANGED);
  if (new_tree_data.focus_id != old_tree_data.focus_id) {
    AXNode* focus_node = tree->GetFromId(new_tree_data.focus_id);
    if (focus_node) {
      AddEvent(focus_node, Event::FOCUS_CHANGED);
    }
  }
}

References AddEvent(), BASE_DCHECK, DOCUMENT_SELECTION_CHANGED, DOCUMENT_TITLE_CHANGED, FOCUS_CHANGED, ui::AXTreeData::focus_id, ui::AXTree::GetFromId(), LOAD_COMPLETE, ui::AXTreeData::loaded, ui::AXTree::root(), ui::AXTreeData::sel_anchor_affinity, ui::AXTreeData::sel_anchor_object_id, ui::AXTreeData::sel_anchor_offset, ui::AXTreeData::sel_focus_affinity, ui::AXTreeData::sel_focus_object_id, ui::AXTreeData::sel_focus_offset, ui::AXTreeData::sel_is_backward, and ui::AXTreeData::title.

◆ ReleaseTree()

void ui::AXEventGenerator::ReleaseTree ( )

Definition at line 165 of file ax_event_generator.cc.

                                   {
  tree_->RemoveObserver(this);
  tree_ = nullptr;
}

References ui::AXTree::RemoveObserver().

Referenced by flutter::AccessibilityBridge::~AccessibilityBridge().

◆ set_always_fire_load_complete()

void ui::AXEventGenerator::set_always_fire_load_complete ( bool val )

inline

Definition at line 198 of file ax_event_generator.h.

                                               {
    always_fire_load_complete_ = val;
  }

◆ SetTree()

void ui::AXEventGenerator::SetTree ( AXTree * new_tree )

Definition at line 157 of file ax_event_generator.cc.

                                               {
  if (tree_)
    tree_->RemoveObserver(this);
  tree_ = new_tree;
  if (tree_)
    tree_->AddObserver(this);
}

References ui::AXTree::AddObserver(), and ui::AXTree::RemoveObserver().

Referenced by flutter::AccessibilityBridge::AccessibilityBridge().

The documentation for this class was generated from the following files:

third_party/accessibility/ax/ax_event_generator.h
third_party/accessibility/ax/ax_event_generator.cc

Classes

Public Types

Public Member Functions

Protected Member Functions

Detailed Description

Member Typedef Documentation

◆ const_iterator

◆ IgnoredChangedStatesBitset

◆ iterator

◆ value_type

Member Enumeration Documentation

◆ Event

◆ IgnoredChangedState

Constructor & Destructor Documentation

◆ AXEventGenerator() [1/2]

◆ AXEventGenerator() [2/2]

◆ ~AXEventGenerator()

Member Function Documentation

◆ AddEvent()

◆ begin()

◆ ClearEvents()

◆ end()

◆ OnAtomicUpdateFinished()

◆ OnBoolAttributeChanged()

◆ OnFloatAttributeChanged()

◆ OnIntAttributeChanged()

◆ OnIntListAttributeChanged()

◆ OnNodeDataChanged()

◆ OnNodeWillBeDeleted()

◆ OnNodeWillBeReparented()

◆ OnRoleChanged()

◆ OnStateChanged()

◆ OnStringAttributeChanged()

◆ OnSubtreeWillBeDeleted()

◆ OnSubtreeWillBeReparented()

◆ OnTreeDataChanged()

◆ ReleaseTree()

◆ set_always_fire_load_complete()

◆ SetTree()