#include <ax_node.h>

Classes
class	ChildIteratorBase

class	OwnerTree

Public Types
using	AXID = int32_t

using	UnignoredChildIterator = ChildIteratorBase< AXNode, &AXNode::GetNextUnignoredSibling, &AXNode::GetPreviousUnignoredSibling, &AXNode::GetFirstUnignoredChild, &AXNode::GetLastUnignoredChild >

Public Member Functions
	AXNode (OwnerTree tree, AXNode parent, int32_t id, size_t index_in_parent, size_t unignored_index_in_parent=0)

virtual	~AXNode ()

OwnerTree *	tree () const

AXID	id () const

AXNode *	parent () const

const AXNodeData &	data () const

const std::vector< AXNode * > &	children () const

size_t	index_in_parent () const

AXNodeData &&	TakeData ()

size_t	GetUnignoredChildCount () const

AXNode *	GetUnignoredChildAtIndex (size_t index) const

AXNode *	GetUnignoredParent () const

OwnerTree::Selection	GetUnignoredSelection () const

size_t	GetUnignoredIndexInParent () const

size_t	GetIndexInParent () const

AXNode *	GetFirstUnignoredChild () const

AXNode *	GetLastUnignoredChild () const

AXNode *	GetDeepestFirstUnignoredChild () const

AXNode *	GetDeepestLastUnignoredChild () const

AXNode *	GetNextUnignoredSibling () const

AXNode *	GetPreviousUnignoredSibling () const

AXNode *	GetNextUnignoredInTreeOrder () const

AXNode *	GetPreviousUnignoredInTreeOrder () const

UnignoredChildIterator	UnignoredChildrenBegin () const

UnignoredChildIterator	UnignoredChildrenEnd () const

AXNode *	GetFirstChild () const

AXNode *	GetLastChild () const

AXNode *	GetPreviousSibling () const

AXNode *	GetNextSibling () const

bool	IsText () const

bool	IsLineBreak () const

void	SetData (const AXNodeData &src)

void	SetLocation (int32_t offset_container_id, const gfx::RectF &location, gfx::Transform *transform)

void	SetIndexInParent (size_t index_in_parent)

void	UpdateUnignoredCachedValues ()

void	SwapChildren (std::vector< AXNode * > *children)

void	Destroy ()

bool	IsDescendantOf (const AXNode *ancestor) const

bool	IsDescendantOfCrossingTreeBoundary (const AXNode *ancestor) const

AXNode *	GetParentCrossingTreeBoundary () const

std::vector< int >	GetOrComputeLineStartOffsets ()

bool	HasBoolAttribute (ax::mojom::BoolAttribute attribute) const

bool	GetBoolAttribute (ax::mojom::BoolAttribute attribute) const

bool	GetBoolAttribute (ax::mojom::BoolAttribute attribute, bool *value) const

bool	HasFloatAttribute (ax::mojom::FloatAttribute attribute) const

float	GetFloatAttribute (ax::mojom::FloatAttribute attribute) const

bool	GetFloatAttribute (ax::mojom::FloatAttribute attribute, float *value) const

bool	HasIntAttribute (ax::mojom::IntAttribute attribute) const

int	GetIntAttribute (ax::mojom::IntAttribute attribute) const

bool	GetIntAttribute (ax::mojom::IntAttribute attribute, int *value) const

bool	HasStringAttribute (ax::mojom::StringAttribute attribute) const

const std::string &	GetStringAttribute (ax::mojom::StringAttribute attribute) const

bool	GetStringAttribute (ax::mojom::StringAttribute attribute, std::string *value) const

bool	GetString16Attribute (ax::mojom::StringAttribute attribute, std::u16string *value) const

std::u16string	GetString16Attribute (ax::mojom::StringAttribute attribute) const

bool	HasIntListAttribute (ax::mojom::IntListAttribute attribute) const

const std::vector< int32_t > &	GetIntListAttribute (ax::mojom::IntListAttribute attribute) const

bool	GetIntListAttribute (ax::mojom::IntListAttribute attribute, std::vector< int32_t > *value) const

bool	HasStringListAttribute (ax::mojom::StringListAttribute attribute) const

const std::vector< std::string > &	GetStringListAttribute (ax::mojom::StringListAttribute attribute) const

bool	GetStringListAttribute (ax::mojom::StringListAttribute attribute, std::vector< std::string > *value) const

bool	GetHtmlAttribute (const char attribute, std::u16string value) const

bool	GetHtmlAttribute (const char attribute, std::string value) const

std::optional< int >	GetHierarchicalLevel () const

bool	IsOrderedSetItem () const

bool	IsOrderedSet () const

std::optional< int >	GetPosInSet ()

std::optional< int >	GetSetSize ()

bool	SetRoleMatchesItemRole (const AXNode *ordered_set) const

bool	IsIgnoredContainerForOrderedSet () const

const std::string &	GetInheritedStringAttribute (ax::mojom::StringAttribute attribute) const

std::u16string	GetInheritedString16Attribute (ax::mojom::StringAttribute attribute) const

std::string	GetInnerText () const

std::string	GetLanguage () const

bool	IsTable () const

std::optional< int >	GetTableColCount () const

std::optional< int >	GetTableRowCount () const

std::optional< int >	GetTableAriaColCount () const

std::optional< int >	GetTableAriaRowCount () const

std::optional< int >	GetTableCellCount () const

std::optional< bool >	GetTableHasColumnOrRowHeaderNode () const

AXNode *	GetTableCaption () const

AXNode *	GetTableCellFromIndex (int index) const

AXNode *	GetTableCellFromCoords (int row_index, int col_index) const

std::vector< AXNode::AXID >	GetTableColHeaderNodeIds () const

std::vector< AXNode::AXID >	GetTableColHeaderNodeIds (int col_index) const

std::vector< AXNode::AXID >	GetTableRowHeaderNodeIds (int row_index) const

std::vector< AXNode::AXID >	GetTableUniqueCellIds () const

const std::vector< AXNode * > *	GetExtraMacNodes () const

bool	IsTableRow () const

std::optional< int >	GetTableRowRowIndex () const

std::vector< AXNode::AXID >	GetTableRowNodeIds () const

bool	IsTableCellOrHeader () const

std::optional< int >	GetTableCellIndex () const

std::optional< int >	GetTableCellColIndex () const

std::optional< int >	GetTableCellRowIndex () const

std::optional< int >	GetTableCellColSpan () const

std::optional< int >	GetTableCellRowSpan () const

std::optional< int >	GetTableCellAriaColIndex () const

std::optional< int >	GetTableCellAriaRowIndex () const

std::vector< AXNode::AXID >	GetTableCellColHeaderNodeIds () const

std::vector< AXNode::AXID >	GetTableCellRowHeaderNodeIds () const

void	GetTableCellColHeaders (std::vector< AXNode * > *col_headers) const

void	GetTableCellRowHeaders (std::vector< AXNode * > *row_headers) const

bool	IsCellOrHeaderOfARIATable () const

bool	IsCellOrHeaderOfARIAGrid () const

bool	IsEmbeddedGroup () const

bool	IsIgnored () const

bool	IsChildOfLeaf () const

bool	IsLeaf () const

bool	IsInListMarker () const

bool	IsCollapsedMenuListPopUpButton () const

AXNode *	GetCollapsedMenuListPopUpButtonAncestor () const

AXNode *	GetTextFieldAncestor () const

AXNode *	GetOrderedSet () const

AXNode *	GetLowestPlatformAncestor () const

Static Public Attributes
static constexpr AXID	kInvalidAXID = -1

Detailed Description

Definition at line 33 of file ax_node.h.

Member Typedef Documentation

◆ AXID

using ui::AXNode::AXID = int32_t

Definition at line 36 of file ax_node.h.

◆ UnignoredChildIterator

using ui::AXNode::UnignoredChildIterator = ChildIteratorBase<AXNode, &AXNode::GetNextUnignoredSibling, &AXNode::GetPreviousUnignoredSibling, &AXNode::GetFirstUnignoredChild, &AXNode::GetLastUnignoredChild>

Definition at line 138 of file ax_node.h.

Constructor & Destructor Documentation

◆ AXNode()

ui::AXNode::AXNode	(	AXNode::OwnerTree *	tree,
		AXNode *	parent,
		int32_t	id,
		size_t	index_in_parent,
		size_t	unignored_index_in_parent = `0`
	)

Definition at line 23 of file ax_node.cc.

    : tree_(tree),
      index_in_parent_(index_in_parent),
      unignored_index_in_parent_(unignored_index_in_parent),
      parent_(parent) {
  data_.id = id;
}

◆ ~AXNode()

ui::AXNode::~AXNode ( )

virtualdefault

Member Function Documentation

◆ children()

const std::vector< AXNode * > & ui::AXNode::children ( ) const

inline

Definition at line 113 of file ax_node.h.

113{ return children_; }

◆ data()

const AXNodeData & ui::AXNode::data ( ) const

inline

Definition at line 112 of file ax_node.h.

112{ return data_; }

◆ Destroy()

void ui::AXNode::Destroy ( )

Definition at line 403 of file ax_node.cc.

                     {
  delete this;
}

◆ GetBoolAttribute() [1/2]

bool ui::AXNode::GetBoolAttribute ( ax::mojom::BoolAttribute attribute ) const

inline

Definition at line 211 of file ax_node.h.

                                                              {
    return data().GetBoolAttribute(attribute);
  }

◆ GetBoolAttribute() [2/2]

bool ui::AXNode::GetBoolAttribute	(	ax::mojom::BoolAttribute	attribute,
		bool *	value
	)		const

inline

Definition at line 214 of file ax_node.h.

                                                                           {
    return data().GetBoolAttribute(attribute, value);
  }

◆ GetCollapsedMenuListPopUpButtonAncestor()

AXNode * ui::AXNode::GetCollapsedMenuListPopUpButtonAncestor ( ) const

Definition at line 1177 of file ax_node.cc.

                                                              {
  AXNode* node = GetOrderedSet();
 
  if (!node)
    return nullptr;
 
  // The ordered set returned is either the popup element child of the popup
  // button (e.g., the AXMenuListPopup) or the popup button itself. We need
  // |node| to point to the popup button itself.
  if (node->data().role != ax::mojom::Role::kPopUpButton) {
    node = node->parent();
    if (!node)
      return nullptr;
  }
 
  return node->IsCollapsedMenuListPopUpButton() ? node : nullptr;
}

◆ GetDeepestFirstUnignoredChild()

AXNode * ui::AXNode::GetDeepestFirstUnignoredChild ( ) const

Definition at line 86 of file ax_node.cc.

                                                    {
  if (!GetUnignoredChildCount())
    return nullptr;
 
  AXNode* deepest_child = GetFirstUnignoredChild();
  while (deepest_child->GetUnignoredChildCount()) {
    deepest_child = deepest_child->GetFirstUnignoredChild();
  }
 
  return deepest_child;
}

◆ GetDeepestLastUnignoredChild()

AXNode * ui::AXNode::GetDeepestLastUnignoredChild ( ) const

Definition at line 98 of file ax_node.cc.

                                                   {
  if (!GetUnignoredChildCount())
    return nullptr;
 
  AXNode* deepest_child = GetLastUnignoredChild();
  while (deepest_child->GetUnignoredChildCount()) {
    deepest_child = deepest_child->GetLastUnignoredChild();
  }
 
  return deepest_child;
}

◆ GetExtraMacNodes()

const std::vector< AXNode * > * ui::AXNode::GetExtraMacNodes ( ) const

Definition at line 678 of file ax_node.cc.

                                                         {
  // Should only be available on the table node itself, not any of its children.
  const AXTableInfo* table_info = tree_->GetTableInfo(this);
  if (!table_info)
    return nullptr;
 
  return &table_info->extra_mac_nodes;
}

◆ GetFirstChild()

AXNode * ui::AXNode::GetFirstChild ( ) const

Definition at line 322 of file ax_node.cc.

                                    {
  if (children().empty())
    return nullptr;
  return children()[0];
}

◆ GetFirstUnignoredChild()

AXNode * ui::AXNode::GetFirstUnignoredChild ( ) const

Definition at line 76 of file ax_node.cc.

                                             {
  BASE_DCHECK(!tree_->GetTreeUpdateInProgressState());
  return ComputeFirstUnignoredChildRecursive();
}

◆ GetFloatAttribute() [1/2]

float ui::AXNode::GetFloatAttribute ( ax::mojom::FloatAttribute attribute ) const

inline

Definition at line 221 of file ax_node.h.

                                                                 {
    return data().GetFloatAttribute(attribute);
  }

◆ GetFloatAttribute() [2/2]

bool ui::AXNode::GetFloatAttribute	(	ax::mojom::FloatAttribute	attribute,
		float *	value
	)		const

inline

Definition at line 224 of file ax_node.h.

                                             {
    return data().GetFloatAttribute(attribute, value);
  }

◆ GetHierarchicalLevel()

std::optional< int > ui::AXNode::GetHierarchicalLevel ( ) const

Definition at line 927 of file ax_node.cc.

                                                    {
  int hierarchical_level =
      GetIntAttribute(ax::mojom::IntAttribute::kHierarchicalLevel);
 
  // According to the WAI_ARIA spec, a defined hierarchical level value is
  // greater than 0.
  // https://www.w3.org/TR/wai-aria-1.1/#aria-level
  if (hierarchical_level > 0)
    return hierarchical_level;
 
  return std::nullopt;
}

◆ GetHtmlAttribute() [1/2]

bool ui::AXNode::GetHtmlAttribute	(	const char *	attribute,
		std::string *	value
	)		const

inline

Definition at line 287 of file ax_node.h.

                                                                       {
    return data().GetHtmlAttribute(attribute, value);
  }

◆ GetHtmlAttribute() [2/2]

bool ui::AXNode::GetHtmlAttribute	(	const char *	attribute,
		std::u16string *	value
	)		const

inline

Definition at line 284 of file ax_node.h.

                                                                          {
    return data().GetHtmlAttribute(attribute, value);
  }

◆ GetIndexInParent()

size_t ui::AXNode::GetIndexInParent ( ) const

Definition at line 71 of file ax_node.cc.

                                      {
  BASE_DCHECK(!tree_->GetTreeUpdateInProgressState());
  return index_in_parent_;
}

◆ GetInheritedString16Attribute()

std::u16string ui::AXNode::GetInheritedString16Attribute ( ax::mojom::StringAttribute attribute ) const

Definition at line 467 of file ax_node.cc.

                                            {
  return base::UTF8ToUTF16(GetInheritedStringAttribute(attribute));
}

◆ GetInheritedStringAttribute()

const std::string & ui::AXNode::GetInheritedStringAttribute ( ax::mojom::StringAttribute attribute ) const

Definition at line 456 of file ax_node.cc.

                                            {
  const AXNode* current_node = this;
  do {
    if (current_node->data().HasStringAttribute(attribute))
      return current_node->data().GetStringAttribute(attribute);
    current_node = current_node->parent();
  } while (current_node);
  return base::EmptyString();
}

◆ GetInnerText()

std::string ui::AXNode::GetInnerText ( ) const

Definition at line 472 of file ax_node.cc.

                                     {
  // If a text field has no descendants, then we compute its inner text from its
  // value or its placeholder. Otherwise we prefer to look at its descendant
  // text nodes because Blink doesn't always add all trailing white space to the
  // value attribute.
  const bool is_plain_text_field_without_descendants =
      (data().IsTextField() && !GetUnignoredChildCount());
  if (is_plain_text_field_without_descendants) {
    std::string value =
        data().GetStringAttribute(ax::mojom::StringAttribute::kValue);
    // If the value is empty, then there might be some placeholder text in the
    // text field, or any other name that is derived from visible contents, even
    // if the text field has no children.
    if (!value.empty())
      return value;
  }
 
  // Ordinarily, plain text fields are leaves. We need to exclude them from the
  // set of leaf nodes when they expose any descendants. This is because we want
  // to compute their inner text from their descendant text nodes as we don't
  // always trust the "value" attribute provided by Blink.
  const bool is_plain_text_field_with_descendants =
      (data().IsTextField() && GetUnignoredChildCount());
  if (IsLeaf() && !is_plain_text_field_with_descendants) {
    switch (data().GetNameFrom()) {
      case ax::mojom::NameFrom::kNone:
      case ax::mojom::NameFrom::kUninitialized:
      // The accessible name is not displayed on screen, e.g. aria-label, or is
      // not displayed directly inside the node, e.g. an associated label
      // element.
      case ax::mojom::NameFrom::kAttribute:
      // The node's accessible name is explicitly empty.
      case ax::mojom::NameFrom::kAttributeExplicitlyEmpty:
      // The accessible name does not represent the entirety of the node's inner
      // text, e.g. a table's caption or a figure's figcaption.
      case ax::mojom::NameFrom::kCaption:
      case ax::mojom::NameFrom::kRelatedElement:
      // The accessible name is not displayed directly inside the node but is
      // visible via e.g. a tooltip.
      case ax::mojom::NameFrom::kTitle:
        return std::string();
 
      case ax::mojom::NameFrom::kContents:
      // The placeholder text is initially displayed inside the text field and
      // takes the place of its value.
      case ax::mojom::NameFrom::kPlaceholder:
      // The value attribute takes the place of the node's inner text, e.g. the
      // value of a submit button is displayed inside the button itself.
      case ax::mojom::NameFrom::kValue:
        return data().GetStringAttribute(ax::mojom::StringAttribute::kName);
    }
  }
 
  std::string inner_text;
  for (auto it = UnignoredChildrenBegin(); it != UnignoredChildrenEnd(); ++it) {
    inner_text += it->GetInnerText();
  }
  return inner_text;
}

◆ GetIntAttribute() [1/2]

int ui::AXNode::GetIntAttribute ( ax::mojom::IntAttribute attribute ) const

inline

Definition at line 232 of file ax_node.h.

                                                           {
    return data().GetIntAttribute(attribute);
  }

◆ GetIntAttribute() [2/2]

bool ui::AXNode::GetIntAttribute	(	ax::mojom::IntAttribute	attribute,
		int *	value
	)		const

inline

Definition at line 235 of file ax_node.h.

                                                                        {
    return data().GetIntAttribute(attribute, value);
  }

◆ GetIntListAttribute() [1/2]

const std::vector< int32_t > & ui::AXNode::GetIntListAttribute ( ax::mojom::IntListAttribute attribute ) const

inline

Definition at line 263 of file ax_node.h.

                                               {
    return data().GetIntListAttribute(attribute);
  }

◆ GetIntListAttribute() [2/2]

bool ui::AXNode::GetIntListAttribute	(	ax::mojom::IntListAttribute	attribute,
		std::vector< int32_t > *	value
	)		const

inline

Definition at line 267 of file ax_node.h.

                                                            {
    return data().GetIntListAttribute(attribute, value);
  }

◆ GetLanguage()

std::string ui::AXNode::GetLanguage ( ) const

Definition at line 532 of file ax_node.cc.

                                    {
  return std::string();
}

◆ GetLastChild()

AXNode * ui::AXNode::GetLastChild ( ) const

Definition at line 329 of file ax_node.cc.

                                   {
  size_t n = children().size();
  if (n == 0)
    return nullptr;
  return children()[n - 1];
}

◆ GetLastUnignoredChild()

AXNode * ui::AXNode::GetLastUnignoredChild ( ) const

Definition at line 81 of file ax_node.cc.

                                            {
  BASE_DCHECK(!tree_->GetTreeUpdateInProgressState());
  return ComputeLastUnignoredChildRecursive();
}

◆ GetLowestPlatformAncestor()

AXNode * ui::AXNode::GetLowestPlatformAncestor ( ) const

Definition at line 1202 of file ax_node.cc.

                                                {
  AXNode* current_node = const_cast<AXNode*>(this);
  AXNode* lowest_unignored_node = current_node;
  for (; lowest_unignored_node && lowest_unignored_node->IsIgnored();
       lowest_unignored_node = lowest_unignored_node->parent()) {
  }
 
  // `highest_leaf_node` could be nullptr.
  AXNode* highest_leaf_node = lowest_unignored_node;
  // For the purposes of this method, a leaf node does not include leaves in the
  // internal accessibility tree, only in the platform exposed tree.
  for (AXNode* ancestor_node = lowest_unignored_node; ancestor_node;
       ancestor_node = ancestor_node->GetUnignoredParent()) {
    if (ancestor_node->IsLeaf())
      highest_leaf_node = ancestor_node;
  }
  if (highest_leaf_node)
    return highest_leaf_node;
 
  if (lowest_unignored_node)
    return lowest_unignored_node;
  return current_node;
}

◆ GetNextSibling()

AXNode * ui::AXNode::GetNextSibling ( ) const

Definition at line 347 of file ax_node.cc.

                                     {
  if (!parent())
    return nullptr;
  size_t nextIndex = index_in_parent() + 1;
  if (nextIndex >= parent()->children().size())
    return nullptr;
  return parent()->children()[nextIndex];
}

◆ GetNextUnignoredInTreeOrder()

AXNode * ui::AXNode::GetNextUnignoredInTreeOrder ( ) const

Definition at line 284 of file ax_node.cc.

                                                  {
  if (GetUnignoredChildCount())
    return GetFirstUnignoredChild();
 
  const AXNode* node = this;
  while (node) {
    AXNode* sibling = node->GetNextUnignoredSibling();
    if (sibling)
      return sibling;
 
    node = node->GetUnignoredParent();
  }
 
  return nullptr;
}

◆ GetNextUnignoredSibling()

AXNode * ui::AXNode::GetNextUnignoredSibling ( ) const

Definition at line 155 of file ax_node.cc.

                                              {
  BASE_DCHECK(!tree_->GetTreeUpdateInProgressState());
  const AXNode* current = this;
 
  // If there are children of the |current| node still to consider.
  bool considerChildren = false;
 
  while (current) {
    // A |candidate| sibling to consider.
    // If it is unignored then we have found our result.
    // Otherwise promote it to |current| and consider its children.
    AXNode* candidate;
 
    if (considerChildren && (candidate = current->GetFirstChild())) {
      if (!candidate->IsIgnored())
        return candidate;
      current = candidate;
 
    } else if ((candidate = current->GetNextSibling())) {
      if (!candidate->IsIgnored())
        return candidate;
      current = candidate;
      // Look through the ignored candidate node to consider their children as
      // though they were siblings.
      considerChildren = true;
 
    } else {
      // Continue our search through a parent iff they are ignored.
      //
      // If |current| has an ignored parent, then we consider the parent's
      // siblings as though they were siblings of |current|.
      //
      // Given a tree:
      //   1
      //   ├── 2(?)
      //   │   └── [4]
      //   └── 3
      //
      // Node 4's view of siblings:
      //   literal tree:   null <-- [4] --> null
      //
      // If node 2 is not ignored, then node 4's view doesn't change, and we
      // have no more nodes to consider:
      //   unignored tree: null <-- [4] --> null
      //
      // If instead node 2 is ignored, then node 4's view of siblings grows to
      // include node 3, and we have more nodes to consider:
      //   unignored tree: null <-- [4] --> 3
      current = current->parent();
      if (!current || !current->IsIgnored())
        return nullptr;
 
      // We have already considered all relevant descendants of |current|.
      considerChildren = false;
    }
  }
 
  return nullptr;
}

◆ GetOrComputeLineStartOffsets()

std::vector< int > ui::AXNode::GetOrComputeLineStartOffsets ( )

Definition at line 416 of file ax_node.cc.

                                                    {
  std::vector<int> line_offsets;
  if (data().GetIntListAttribute(ax::mojom::IntListAttribute::kCachedLineStarts,
                                 &line_offsets)) {
    return line_offsets;
  }
 
  int start_offset = 0;
  ComputeLineStartOffsets(&line_offsets, &start_offset);
  data_.AddIntListAttribute(ax::mojom::IntListAttribute::kCachedLineStarts,
                            line_offsets);
  return line_offsets;
}

◆ GetOrderedSet()

AXNode * ui::AXNode::GetOrderedSet ( ) const

Definition at line 1032 of file ax_node.cc.

                                    {
  AXNode* result = parent();
  // Continue walking up while parent is invalid, ignored, a generic container,
  // unknown, or embedded group.
  while (result && result->IsIgnoredContainerForOrderedSet()) {
    result = result->parent();
  }
 
  return result;
}

◆ GetParentCrossingTreeBoundary()

AXNode * ui::AXNode::GetParentCrossingTreeBoundary ( ) const

Definition at line 1249 of file ax_node.cc.

                                                    {
  BASE_DCHECK(!tree_->GetTreeUpdateInProgressState());
  if (parent_)
    return parent_;
  const AXTreeManager* manager =
      AXTreeManagerMap::GetInstance().GetManager(tree_->GetAXTreeID());
  if (manager)
    return manager->GetParentNodeFromParentTreeAsAXNode();
  return nullptr;
}

◆ GetPosInSet()

std::optional< int > ui::AXNode::GetPosInSet ( )

Definition at line 949 of file ax_node.cc.

                                     {
  return tree_->GetPosInSet(*this);
}

◆ GetPreviousSibling()

AXNode * ui::AXNode::GetPreviousSibling ( ) const

Definition at line 337 of file ax_node.cc.

                                         {
  // Root nodes lack a parent, their index_in_parent should be 0.
  BASE_DCHECK(!parent() ? index_in_parent() == 0 : true);
  size_t index = index_in_parent();
  if (index == 0)
    return nullptr;
  return parent()->children()[index - 1];
}

◆ GetPreviousUnignoredInTreeOrder()

AXNode * ui::AXNode::GetPreviousUnignoredInTreeOrder ( ) const

Definition at line 300 of file ax_node.cc.

                                                      {
  AXNode* sibling = GetPreviousUnignoredSibling();
  if (!sibling)
    return GetUnignoredParent();
 
  if (sibling->GetUnignoredChildCount())
    return sibling->GetDeepestLastUnignoredChild();
 
  return sibling;
}

◆ GetPreviousUnignoredSibling()

AXNode * ui::AXNode::GetPreviousUnignoredSibling ( ) const

Definition at line 224 of file ax_node.cc.

                                                  {
  BASE_DCHECK(!tree_->GetTreeUpdateInProgressState());
  const AXNode* current = this;
 
  // If there are children of the |current| node still to consider.
  bool considerChildren = false;
 
  while (current) {
    // A |candidate| sibling to consider.
    // If it is unignored then we have found our result.
    // Otherwise promote it to |current| and consider its children.
    AXNode* candidate;
 
    if (considerChildren && (candidate = current->GetLastChild())) {
      if (!candidate->IsIgnored())
        return candidate;
      current = candidate;
 
    } else if ((candidate = current->GetPreviousSibling())) {
      if (!candidate->IsIgnored())
        return candidate;
      current = candidate;
      // Look through the ignored candidate node to consider their children as
      // though they were siblings.
      considerChildren = true;
 
    } else {
      // Continue our search through a parent iff they are ignored.
      //
      // If |current| has an ignored parent, then we consider the parent's
      // siblings as though they were siblings of |current|.
      //
      // Given a tree:
      //   1
      //   ├── 2
      //   └── 3(?)
      //       └── [4]
      //
      // Node 4's view of siblings:
      //   literal tree:   null <-- [4] --> null
      //
      // If node 3 is not ignored, then node 4's view doesn't change, and we
      // have no more nodes to consider:
      //   unignored tree: null <-- [4] --> null
      //
      // If instead node 3 is ignored, then node 4's view of siblings grows to
      // include node 2, and we have more nodes to consider:
      //   unignored tree:    2 <-- [4] --> null
      current = current->parent();
      if (!current || !current->IsIgnored())
        return nullptr;
 
      // We have already considered all relevant descendants of |current|.
      considerChildren = false;
    }
  }
 
  return nullptr;
}

◆ GetSetSize()

std::optional< int > ui::AXNode::GetSetSize ( )

Definition at line 954 of file ax_node.cc.

                                    {
  return tree_->GetSetSize(*this);
}

◆ GetString16Attribute() [1/2]

std::u16string ui::AXNode::GetString16Attribute ( ax::mojom::StringAttribute attribute ) const

inline

Definition at line 255 of file ax_node.h.

                                              {
    return data().GetString16Attribute(attribute);
  }

◆ GetString16Attribute() [2/2]

bool ui::AXNode::GetString16Attribute	(	ax::mojom::StringAttribute	attribute,
		std::u16string *	value
	)		const

inline

Definition at line 251 of file ax_node.h.

                                                       {
    return data().GetString16Attribute(attribute, value);
  }

◆ GetStringAttribute() [1/2]

const std::string & ui::AXNode::GetStringAttribute ( ax::mojom::StringAttribute attribute ) const

inline

Definition at line 242 of file ax_node.h.

                                              {
    return data().GetStringAttribute(attribute);
  }

◆ GetStringAttribute() [2/2]

bool ui::AXNode::GetStringAttribute	(	ax::mojom::StringAttribute	attribute,
		std::string *	value
	)		const

inline

Definition at line 246 of file ax_node.h.

                                                  {
    return data().GetStringAttribute(attribute, value);
  }

◆ GetStringListAttribute() [1/2]

const std::vector< std::string > & ui::AXNode::GetStringListAttribute ( ax::mojom::StringListAttribute attribute ) const

inline

Definition at line 275 of file ax_node.h.

                                                  {
    return data().GetStringListAttribute(attribute);
  }

◆ GetStringListAttribute() [2/2]

bool ui::AXNode::GetStringListAttribute	(	ax::mojom::StringListAttribute	attribute,
		std::vector< std::string > *	value
	)		const

inline

Definition at line 279 of file ax_node.h.

                                                                 {
    return data().GetStringListAttribute(attribute, value);
  }

◆ GetTableAriaColCount()

std::optional< int > ui::AXNode::GetTableAriaColCount ( ) const

Definition at line 558 of file ax_node.cc.

                                                    {
  const AXTableInfo* table_info = GetAncestorTableInfo();
  if (!table_info)
    return std::nullopt;
  return std::make_optional(table_info->aria_col_count);
}

◆ GetTableAriaRowCount()

std::optional< int > ui::AXNode::GetTableAriaRowCount ( ) const

Definition at line 565 of file ax_node.cc.

                                                    {
  const AXTableInfo* table_info = GetAncestorTableInfo();
  if (!table_info)
    return std::nullopt;
  return std::make_optional(table_info->aria_row_count);
}

◆ GetTableCaption()

AXNode * ui::AXNode::GetTableCaption ( ) const

Definition at line 603 of file ax_node.cc.

                                      {
  const AXTableInfo* table_info = GetAncestorTableInfo();
  if (!table_info)
    return nullptr;
 
  return tree_->GetFromId(table_info->caption_id);
}

◆ GetTableCellAriaColIndex()

std::optional< int > ui::AXNode::GetTableCellAriaColIndex ( ) const

Definition at line 822 of file ax_node.cc.

                                                        {
  const AXTableInfo* table_info = GetAncestorTableInfo();
  if (!table_info)
    return std::nullopt;
 
  std::optional<int> index = GetTableCellIndex();
  if (!index)
    return std::nullopt;
 
  return static_cast<int>(table_info->cell_data_vector[*index].aria_col_index);
}

◆ GetTableCellAriaRowIndex()

std::optional< int > ui::AXNode::GetTableCellAriaRowIndex ( ) const

Definition at line 834 of file ax_node.cc.

                                                        {
  const AXTableInfo* table_info = GetAncestorTableInfo();
  if (!table_info)
    return std::nullopt;
 
  std::optional<int> index = GetTableCellIndex();
  if (!index)
    return std::nullopt;
 
  return static_cast<int>(table_info->cell_data_vector[*index].aria_row_index);
}

◆ GetTableCellColHeaderNodeIds()

std::vector< AXNode::AXID > ui::AXNode::GetTableCellColHeaderNodeIds ( ) const

Definition at line 846 of file ax_node.cc.

                                                                 {
  const AXTableInfo* table_info = GetAncestorTableInfo();
  if (!table_info || table_info->col_count <= 0)
    return std::vector<AXNode::AXID>();
 
  // If this node is not a cell, then return the headers for the first column.
  int col_index = GetTableCellColIndex().value_or(0);
 
  return std::vector<AXNode::AXID>(table_info->col_headers[col_index]);
}

◆ GetTableCellColHeaders()

void ui::AXNode::GetTableCellColHeaders ( std::vector< AXNode * > * col_headers ) const

Definition at line 857 of file ax_node.cc.

                                                                         {
  BASE_DCHECK(col_headers);
 
  std::vector<int32_t> col_header_ids = GetTableCellColHeaderNodeIds();
  IdVectorToNodeVector(col_header_ids, col_headers);
}

◆ GetTableCellColIndex()

std::optional< int > ui::AXNode::GetTableCellColIndex ( ) const

Definition at line 772 of file ax_node.cc.

                                                    {
  const AXTableInfo* table_info = GetAncestorTableInfo();
  if (!table_info)
    return std::nullopt;
 
  std::optional<int> index = GetTableCellIndex();
  if (!index)
    return std::nullopt;
 
  return static_cast<int>(table_info->cell_data_vector[*index].col_index);
}

◆ GetTableCellColSpan()

std::optional< int > ui::AXNode::GetTableCellColSpan ( ) const

Definition at line 796 of file ax_node.cc.

                                                   {
  // If it's not a table cell, don't return a col span.
  if (!IsTableCellOrHeader())
    return std::nullopt;
 
  // Otherwise, try to return a colspan, with 1 as the default if it's not
  // specified.
  int col_span;
  if (GetIntAttribute(ax::mojom::IntAttribute::kTableCellColumnSpan, &col_span))
    return col_span;
  return 1;
}

◆ GetTableCellCount()

std::optional< int > ui::AXNode::GetTableCellCount ( ) const

Definition at line 572 of file ax_node.cc.

                                                 {
  const AXTableInfo* table_info = GetAncestorTableInfo();
  if (!table_info)
    return std::nullopt;
 
  return static_cast<int>(table_info->unique_cell_ids.size());
}

◆ GetTableCellFromCoords()

AXNode * ui::AXNode::GetTableCellFromCoords	(	int	row_index,
		int	col_index
	)		const

Definition at line 611 of file ax_node.cc.

                                                                         {
  const AXTableInfo* table_info = GetAncestorTableInfo();
  if (!table_info)
    return nullptr;
 
  // There is a table but the given coordinates are outside the table.
  if (row_index < 0 ||
      static_cast<size_t>(row_index) >= table_info->row_count ||
      col_index < 0 ||
      static_cast<size_t>(col_index) >= table_info->col_count) {
    return nullptr;
  }
 
  return tree_->GetFromId(table_info->cell_ids[static_cast<size_t>(row_index)]
                                              [static_cast<size_t>(col_index)]);
}

◆ GetTableCellFromIndex()

AXNode * ui::AXNode::GetTableCellFromIndex ( int index ) const

Definition at line 588 of file ax_node.cc.

                                                     {
  const AXTableInfo* table_info = GetAncestorTableInfo();
  if (!table_info)
    return nullptr;
 
  // There is a table but there is no cell with the given index.
  if (index < 0 ||
      static_cast<size_t>(index) >= table_info->unique_cell_ids.size()) {
    return nullptr;
  }
 
  return tree_->GetFromId(
      table_info->unique_cell_ids[static_cast<size_t>(index)]);
}

◆ GetTableCellIndex()

std::optional< int > ui::AXNode::GetTableCellIndex ( ) const

Definition at line 758 of file ax_node.cc.

                                                 {
  if (!IsTableCellOrHeader())
    return std::nullopt;
 
  const AXTableInfo* table_info = GetAncestorTableInfo();
  if (!table_info)
    return std::nullopt;
 
  const auto& iter = table_info->cell_id_to_index.find(id());
  if (iter != table_info->cell_id_to_index.end())
    return static_cast<int>(iter->second);
  return std::nullopt;
}

◆ GetTableCellRowHeaderNodeIds()

std::vector< AXNode::AXID > ui::AXNode::GetTableCellRowHeaderNodeIds ( ) const

Definition at line 864 of file ax_node.cc.

                                                                 {
  const AXTableInfo* table_info = GetAncestorTableInfo();
  if (!table_info || table_info->row_count <= 0)
    return std::vector<AXNode::AXID>();
 
  // If this node is not a cell, then return the headers for the first row.
  int row_index = GetTableCellRowIndex().value_or(0);
 
  return std::vector<AXNode::AXID>(table_info->row_headers[row_index]);
}

◆ GetTableCellRowHeaders()

void ui::AXNode::GetTableCellRowHeaders ( std::vector< AXNode * > * row_headers ) const

Definition at line 875 of file ax_node.cc.

                                                                         {
  BASE_DCHECK(row_headers);
 
  std::vector<int32_t> row_header_ids = GetTableCellRowHeaderNodeIds();
  IdVectorToNodeVector(row_header_ids, row_headers);
}

◆ GetTableCellRowIndex()

std::optional< int > ui::AXNode::GetTableCellRowIndex ( ) const

Definition at line 784 of file ax_node.cc.

                                                    {
  const AXTableInfo* table_info = GetAncestorTableInfo();
  if (!table_info)
    return std::nullopt;
 
  std::optional<int> index = GetTableCellIndex();
  if (!index)
    return std::nullopt;
 
  return static_cast<int>(table_info->cell_data_vector[*index].row_index);
}

◆ GetTableCellRowSpan()

std::optional< int > ui::AXNode::GetTableCellRowSpan ( ) const

Definition at line 809 of file ax_node.cc.

                                                   {
  // If it's not a table cell, don't return a row span.
  if (!IsTableCellOrHeader())
    return std::nullopt;
 
  // Otherwise, try to return a row span, with 1 as the default if it's not
  // specified.
  int row_span;
  if (GetIntAttribute(ax::mojom::IntAttribute::kTableCellRowSpan, &row_span))
    return row_span;
  return 1;
}

◆ GetTableColCount()

std::optional< int > ui::AXNode::GetTableColCount ( ) const

Definition at line 544 of file ax_node.cc.

                                                {
  const AXTableInfo* table_info = GetAncestorTableInfo();
  if (!table_info)
    return std::nullopt;
  return static_cast<int>(table_info->col_count);
}

◆ GetTableColHeaderNodeIds() [1/2]

std::vector< AXNode::AXID > ui::AXNode::GetTableColHeaderNodeIds ( ) const

Definition at line 628 of file ax_node.cc.

                                                             {
  const AXTableInfo* table_info = GetAncestorTableInfo();
  if (!table_info)
    return std::vector<AXNode::AXID>();
 
  std::vector<AXNode::AXID> col_header_ids;
  // Flatten and add column header ids of each column to |col_header_ids|.
  for (std::vector<AXNode::AXID> col_headers_at_index :
       table_info->col_headers) {
    col_header_ids.insert(col_header_ids.end(), col_headers_at_index.begin(),
                          col_headers_at_index.end());
  }
 
  return col_header_ids;
}

◆ GetTableColHeaderNodeIds() [2/2]

std::vector< AXNode::AXID > ui::AXNode::GetTableColHeaderNodeIds ( int col_index ) const

Definition at line 644 of file ax_node.cc.

                         {
  const AXTableInfo* table_info = GetAncestorTableInfo();
  if (!table_info)
    return std::vector<AXNode::AXID>();
 
  if (col_index < 0 || static_cast<size_t>(col_index) >= table_info->col_count)
    return std::vector<AXNode::AXID>();
 
  return std::vector<AXNode::AXID>(
      table_info->col_headers[static_cast<size_t>(col_index)]);
}

◆ GetTableHasColumnOrRowHeaderNode()

std::optional< bool > ui::AXNode::GetTableHasColumnOrRowHeaderNode ( ) const

Definition at line 580 of file ax_node.cc.

                                                                 {
  const AXTableInfo* table_info = GetAncestorTableInfo();
  if (!table_info)
    return std::nullopt;
 
  return !table_info->all_headers.empty();
}

◆ GetTableRowCount()

std::optional< int > ui::AXNode::GetTableRowCount ( ) const

Definition at line 551 of file ax_node.cc.

                                                {
  const AXTableInfo* table_info = GetAncestorTableInfo();
  if (!table_info)
    return std::nullopt;
  return static_cast<int>(table_info->row_count);
}

◆ GetTableRowHeaderNodeIds()

std::vector< AXNode::AXID > ui::AXNode::GetTableRowHeaderNodeIds ( int row_index ) const

Definition at line 657 of file ax_node.cc.

                         {
  const AXTableInfo* table_info = GetAncestorTableInfo();
  if (!table_info)
    return std::vector<AXNode::AXID>();
 
  if (row_index < 0 || static_cast<size_t>(row_index) >= table_info->row_count)
    return std::vector<AXNode::AXID>();
 
  return std::vector<AXNode::AXID>(
      table_info->row_headers[static_cast<size_t>(row_index)]);
}

◆ GetTableRowNodeIds()

std::vector< AXNode::AXID > ui::AXNode::GetTableRowNodeIds ( ) const

Definition at line 709 of file ax_node.cc.

                                                       {
  std::vector<AXNode::AXID> row_node_ids;
  const AXTableInfo* table_info = GetAncestorTableInfo();
  if (!table_info)
    return row_node_ids;
 
  for (AXNode* node : table_info->row_nodes)
    row_node_ids.push_back(node->data().id);
 
  return row_node_ids;
}

◆ GetTableRowRowIndex()

std::optional< int > ui::AXNode::GetTableRowRowIndex ( ) const

Definition at line 695 of file ax_node.cc.

                                                   {
  if (!IsTableRow())
    return std::nullopt;
 
  const AXTableInfo* table_info = GetAncestorTableInfo();
  if (!table_info)
    return std::nullopt;
 
  const auto& iter = table_info->row_id_to_index.find(id());
  if (iter == table_info->row_id_to_index.end())
    return std::nullopt;
  return static_cast<int>(iter->second);
}

◆ GetTableUniqueCellIds()

std::vector< AXNode::AXID > ui::AXNode::GetTableUniqueCellIds ( ) const

Definition at line 670 of file ax_node.cc.

                                                          {
  const AXTableInfo* table_info = GetAncestorTableInfo();
  if (!table_info)
    return std::vector<AXNode::AXID>();
 
  return std::vector<AXNode::AXID>(table_info->unique_cell_ids);
}

◆ GetTextFieldAncestor()

AXNode * ui::AXNode::GetTextFieldAncestor ( ) const

Definition at line 1226 of file ax_node.cc.

                                           {
  AXNode* parent = GetUnignoredParent();
 
  while (parent && parent->data().HasState(ax::mojom::State::kEditable)) {
    if (parent->data().IsPlainTextField() || parent->data().IsRichTextField())
      return parent;
 
    parent = parent->GetUnignoredParent();
  }
 
  return nullptr;
}

◆ GetUnignoredChildAtIndex()

AXNode * ui::AXNode::GetUnignoredChildAtIndex ( size_t index ) const

Definition at line 47 of file ax_node.cc.

                                                           {
  BASE_DCHECK(!tree_->GetTreeUpdateInProgressState());
  size_t count = 0;
  for (auto it = UnignoredChildrenBegin(); it != UnignoredChildrenEnd(); ++it) {
    if (count == index)
      return it.get();
    ++count;
  }
  return nullptr;
}

◆ GetUnignoredChildCount()

size_t ui::AXNode::GetUnignoredChildCount ( ) const

Definition at line 37 of file ax_node.cc.

                                            {
  // TODO(nektar): Should BASE_DCHECK if the node is not ignored.
  BASE_DCHECK(!tree_->GetTreeUpdateInProgressState());
  return unignored_child_count_;
}

◆ GetUnignoredIndexInParent()

size_t ui::AXNode::GetUnignoredIndexInParent ( ) const

Definition at line 66 of file ax_node.cc.

                                               {
  BASE_DCHECK(!tree_->GetTreeUpdateInProgressState());
  return unignored_index_in_parent_;
}

◆ GetUnignoredParent()

AXNode * ui::AXNode::GetUnignoredParent ( ) const

Definition at line 58 of file ax_node.cc.

                                         {
  BASE_DCHECK(!tree_->GetTreeUpdateInProgressState());
  AXNode* result = parent();
  while (result && result->IsIgnored())
    result = result->parent();
  return result;
}

◆ GetUnignoredSelection()

AXTree::Selection ui::AXNode::GetUnignoredSelection ( ) const

Definition at line 1260 of file ax_node.cc.

                                                    {
  BASE_DCHECK(tree())
      << "Cannot retrieve the current selection if the node is not "
         "attached to an accessibility tree.\n"
      << *this;
  AXTree::Selection selection = tree()->GetUnignoredSelection();
 
  // "selection.anchor_offset" and "selection.focus_ofset" might need to be
  // adjusted if the anchor or the focus nodes include ignored children.
  //
  // TODO(nektar): Move this logic into its own "AXSelection" class and cache
  // the result for faster reuse.
  const AXNode* anchor = tree()->GetFromId(selection.anchor_object_id);
  if (anchor && !anchor->IsLeaf()) {
    BASE_DCHECK(selection.anchor_offset >= 0);
    if (static_cast<size_t>(selection.anchor_offset) <
        anchor->children().size()) {
      const AXNode* anchor_child = anchor->children()[selection.anchor_offset];
      BASE_DCHECK(anchor_child);
      selection.anchor_offset =
          static_cast<int>(anchor_child->GetUnignoredIndexInParent());
    } else {
      selection.anchor_offset =
          static_cast<int>(anchor->GetUnignoredChildCount());
    }
  }
 
  const AXNode* focus = tree()->GetFromId(selection.focus_object_id);
  if (focus && !focus->IsLeaf()) {
    BASE_DCHECK(selection.focus_offset >= 0);
    if (static_cast<size_t>(selection.focus_offset) <
        focus->children().size()) {
      const AXNode* focus_child = focus->children()[selection.focus_offset];
      BASE_DCHECK(focus_child);
      selection.focus_offset =
          static_cast<int>(focus_child->GetUnignoredIndexInParent());
    } else {
      selection.focus_offset =
          static_cast<int>(focus->GetUnignoredChildCount());
    }
  }
  return selection;
}

◆ HasBoolAttribute()

bool ui::AXNode::HasBoolAttribute ( ax::mojom::BoolAttribute attribute ) const

inline

Definition at line 208 of file ax_node.h.

                                                              {
    return data().HasBoolAttribute(attribute);
  }

◆ HasFloatAttribute()

bool ui::AXNode::HasFloatAttribute ( ax::mojom::FloatAttribute attribute ) const

inline

Definition at line 218 of file ax_node.h.

                                                                {
    return data().HasFloatAttribute(attribute);
  }

◆ HasIntAttribute()

bool ui::AXNode::HasIntAttribute ( ax::mojom::IntAttribute attribute ) const

inline

Definition at line 229 of file ax_node.h.

                                                            {
    return data().HasIntAttribute(attribute);
  }

◆ HasIntListAttribute()

bool ui::AXNode::HasIntListAttribute ( ax::mojom::IntListAttribute attribute ) const

inline

Definition at line 260 of file ax_node.h.

                                                                    {
    return data().HasIntListAttribute(attribute);
  }

◆ HasStringAttribute()

bool ui::AXNode::HasStringAttribute ( ax::mojom::StringAttribute attribute ) const

inline

Definition at line 239 of file ax_node.h.

                                                                  {
    return data().HasStringAttribute(attribute);
  }

◆ HasStringListAttribute()

bool ui::AXNode::HasStringListAttribute ( ax::mojom::StringListAttribute attribute ) const

inline

Definition at line 272 of file ax_node.h.

                                                                          {
    return data().HasStringListAttribute(attribute);
  }

◆ id()

AXID ui::AXNode::id ( ) const

inline

Definition at line 110 of file ax_node.h.

110{ return data_.id; }

◆ index_in_parent()

size_t ui::AXNode::index_in_parent ( ) const

inline

Definition at line 114 of file ax_node.h.

114{ return index_in_parent_; }

◆ IsCellOrHeaderOfARIAGrid()

bool ui::AXNode::IsCellOrHeaderOfARIAGrid ( ) const

Definition at line 895 of file ax_node.cc.

                                            {
  if (!IsTableCellOrHeader())
    return false;
 
  const AXNode* node = this;
  while (node && !node->IsTable())
    node = node->parent();
  if (!node)
    return false;
 
  return node->data().role == ax::mojom::Role::kGrid ||
         node->data().role == ax::mojom::Role::kTreeGrid;
}

◆ IsCellOrHeaderOfARIATable()

bool ui::AXNode::IsCellOrHeaderOfARIATable ( ) const

Definition at line 882 of file ax_node.cc.

                                             {
  if (!IsTableCellOrHeader())
    return false;
 
  const AXNode* node = this;
  while (node && !node->IsTable())
    node = node->parent();
  if (!node)
    return false;
 
  return node->data().role == ax::mojom::Role::kTable;
}

◆ IsChildOfLeaf()

bool ui::AXNode::IsChildOfLeaf ( ) const

Definition at line 1078 of file ax_node.cc.

                                 {
  const AXNode* ancestor = GetUnignoredParent();
  while (ancestor) {
    if (ancestor->IsLeaf())
      return true;
    ancestor = ancestor->GetUnignoredParent();
  }
  return false;
}

◆ IsCollapsedMenuListPopUpButton()

bool ui::AXNode::IsCollapsedMenuListPopUpButton ( ) const

Definition at line 1162 of file ax_node.cc.

                                                  {
  if (data().role != ax::mojom::Role::kPopUpButton ||
      !data().HasState(ax::mojom::State::kCollapsed)) {
    return false;
  }
 
  // When a popup button contains a menu list popup, its only child is unignored
  // and is a menu list popup.
  AXNode* node = GetFirstUnignoredChild();
  if (!node)
    return false;
 
  return node->data().role == ax::mojom::Role::kMenuListPopup;
}

◆ IsDescendantOf()

bool ui::AXNode::IsDescendantOf ( const AXNode * ancestor ) const

Definition at line 407 of file ax_node.cc.

                                                        {
  if (this == ancestor)
    return true;
  if (parent())
    return parent()->IsDescendantOf(ancestor);
 
  return false;
}

◆ IsDescendantOfCrossingTreeBoundary()

bool ui::AXNode::IsDescendantOfCrossingTreeBoundary ( const AXNode * ancestor ) const

Definition at line 1239 of file ax_node.cc.

                                                                            {
  if (!ancestor)
    return false;
  if (this == ancestor)
    return true;
  if (const AXNode* parent = GetParentCrossingTreeBoundary())
    return parent->IsDescendantOfCrossingTreeBoundary(ancestor);
  return false;
}

◆ IsEmbeddedGroup()

bool ui::AXNode::IsEmbeddedGroup ( ) const

Definition at line 1195 of file ax_node.cc.

                                   {
  if (data().role != ax::mojom::Role::kGroup || !parent())
    return false;
 
  return ui::IsSetLike(parent()->data().role);
}

◆ IsIgnored()

bool ui::AXNode::IsIgnored ( ) const

Definition at line 1074 of file ax_node.cc.

                             {
  return data().IsIgnored();
}

◆ IsIgnoredContainerForOrderedSet()

bool ui::AXNode::IsIgnoredContainerForOrderedSet ( ) const

Definition at line 1009 of file ax_node.cc.

                                                   {
  return IsIgnored() || IsEmbeddedGroup() ||
         data().role == ax::mojom::Role::kListItem ||
         data().role == ax::mojom::Role::kGenericContainer ||
         data().role == ax::mojom::Role::kUnknown;
}

◆ IsInListMarker()

bool ui::AXNode::IsInListMarker ( ) const

Definition at line 1139 of file ax_node.cc.

                                  {
  if (data().role == ax::mojom::Role::kListMarker)
    return true;
 
  // List marker node's children can only be text elements.
  if (!IsText())
    return false;
 
  // There is no need to iterate over all the ancestors of the current anchor
  // since a list marker node only has children on 2 levels.
  // i.e.:
  // AXLayoutObject role=kListMarker
  // ++StaticText
  // ++++InlineTextBox
  AXNode* parent_node = GetUnignoredParent();
  if (parent_node && parent_node->data().role == ax::mojom::Role::kListMarker)
    return true;
 
  AXNode* grandparent_node = parent_node->GetUnignoredParent();
  return grandparent_node &&
         grandparent_node->data().role == ax::mojom::Role::kListMarker;
}

◆ IsLeaf()

bool ui::AXNode::IsLeaf ( ) const

Definition at line 1088 of file ax_node.cc.

                          {
  // A node is also a leaf if all of it's descendants are ignored.
  if (children().empty() || !GetUnignoredChildCount())
    return true;
 
#if defined(OS_WIN)
  // On Windows, we want to hide the subtree of a collapsed <select> element.
  // Otherwise, ATs are always going to announce its options whether it's
  // collapsed or expanded. In the AXTree, this element corresponds to a node
  // with role ax::mojom::Role::kPopUpButton that is the parent of a node with
  // role ax::mojom::Role::kMenuListPopup.
  if (IsCollapsedMenuListPopUpButton())
    return true;
#endif  // defined(OS_WIN)
 
  // These types of objects may have children that we use as internal
  // implementation details, but we want to expose them as leaves to platform
  // accessibility APIs because screen readers might be confused if they find
  // any children.
  if (data().IsPlainTextField() || IsText())
    return true;
 
  // Roles whose children are only presentational according to the ARIA and
  // HTML5 Specs should be hidden from screen readers.
  switch (data().role) {
    // According to the ARIA and Core-AAM specs:
    // https://w3c.github.io/aria/#button,
    // https://www.w3.org/TR/core-aam-1.1/#exclude_elements
    // buttons' children are presentational only and should be hidden from
    // screen readers. However, we cannot enforce the leafiness of buttons
    // because they may contain many rich, interactive descendants such as a day
    // in a calendar, and screen readers will need to interact with these
    // contents. See https://crbug.com/689204.
    // So we decided to not enforce the leafiness of buttons and expose all
    // children.
    case ax::mojom::Role::kButton:
      return false;
    case ax::mojom::Role::kDocCover:
    case ax::mojom::Role::kGraphicsSymbol:
    case ax::mojom::Role::kImage:
    case ax::mojom::Role::kMeter:
    case ax::mojom::Role::kScrollBar:
    case ax::mojom::Role::kSlider:
    case ax::mojom::Role::kSplitter:
    case ax::mojom::Role::kProgressIndicator:
      return true;
    default:
      return false;
  }
}

◆ IsLineBreak()

bool ui::AXNode::IsLineBreak ( ) const

Definition at line 366 of file ax_node.cc.

                               {
  return data().role == ax::mojom::Role::kLineBreak ||
         (data().role == ax::mojom::Role::kInlineTextBox &&
          data().GetBoolAttribute(
              ax::mojom::BoolAttribute::kIsLineBreakingObject));
}

◆ IsOrderedSet()

bool ui::AXNode::IsOrderedSet ( ) const

Definition at line 944 of file ax_node.cc.

                                {
  return ui::IsSetLike(data().role);
}

◆ IsOrderedSetItem()

bool ui::AXNode::IsOrderedSetItem ( ) const

Definition at line 940 of file ax_node.cc.

                                    {
  return ui::IsItemLike(data().role);
}

◆ IsTable()

bool ui::AXNode::IsTable ( ) const

Definition at line 540 of file ax_node.cc.

                           {
  return IsTableLike(data().role);
}

◆ IsTableCellOrHeader()

bool ui::AXNode::IsTableCellOrHeader ( ) const

Definition at line 754 of file ax_node.cc.

                                       {
  return IsCellOrTableHeader(data().role);
}

◆ IsTableRow()

bool ui::AXNode::IsTableRow ( ) const

Definition at line 691 of file ax_node.cc.

                              {
  return ui::IsTableRow(data().role);
}

◆ IsText()

bool ui::AXNode::IsText ( ) const

Definition at line 356 of file ax_node.cc.

                          {
  // In Legacy Layout, a list marker has no children and is thus represented on
  // all platforms as a leaf node that exposes the marker itself, i.e., it forms
  // part of the AX tree's text representation. In contrast, in Layout NG, a
  // list marker has a static text child.
  if (data().role == ax::mojom::Role::kListMarker)
    return !children().size();
  return ui::IsText(data().role);
}

◆ parent()

AXNode * ui::AXNode::parent ( ) const

inline

Definition at line 111 of file ax_node.h.

111{ return parent_; }

◆ SetData()

void ui::AXNode::SetData ( const AXNodeData & src )

Definition at line 373 of file ax_node.cc.

                                          {
  data_ = src;
}

◆ SetIndexInParent()

void ui::AXNode::SetIndexInParent ( size_t index_in_parent )

Definition at line 390 of file ax_node.cc.

                                                    {
  index_in_parent_ = index_in_parent;
}

◆ SetLocation()

void ui::AXNode::SetLocation	(	int32_t	offset_container_id,
		const gfx::RectF &	location,
		gfx::Transform *	transform
	)

Definition at line 377 of file ax_node.cc.

                                                  {
  data_.relative_bounds.offset_container_id = offset_container_id;
  data_.relative_bounds.bounds = location;
  if (transform) {
    data_.relative_bounds.transform =
        std::make_unique<gfx::Transform>(*transform);
  } else {
    data_.relative_bounds.transform.reset();
  }
}

◆ SetRoleMatchesItemRole()

bool ui::AXNode::SetRoleMatchesItemRole ( const AXNode * ordered_set ) const

Definition at line 960 of file ax_node.cc.

                                                                   {
  ax::mojom::Role item_role = data().role;
  // Switch on role of ordered set
  switch (ordered_set->data().role) {
    case ax::mojom::Role::kFeed:
      return item_role == ax::mojom::Role::kArticle;
    case ax::mojom::Role::kList:
      return item_role == ax::mojom::Role::kListItem;
    case ax::mojom::Role::kGroup:
      return item_role == ax::mojom::Role::kComment ||
             item_role == ax::mojom::Role::kListItem ||
             item_role == ax::mojom::Role::kMenuItem ||
             item_role == ax::mojom::Role::kMenuItemRadio ||
             item_role == ax::mojom::Role::kListBoxOption ||
             item_role == ax::mojom::Role::kTreeItem;
    case ax::mojom::Role::kMenu:
      return item_role == ax::mojom::Role::kMenuItem ||
             item_role == ax::mojom::Role::kMenuItemRadio ||
             item_role == ax::mojom::Role::kMenuItemCheckBox;
    case ax::mojom::Role::kMenuBar:
      return item_role == ax::mojom::Role::kMenuItem ||
             item_role == ax::mojom::Role::kMenuItemRadio ||
             item_role == ax::mojom::Role::kMenuItemCheckBox;
    case ax::mojom::Role::kTabList:
      return item_role == ax::mojom::Role::kTab;
    case ax::mojom::Role::kTree:
      return item_role == ax::mojom::Role::kTreeItem;
    case ax::mojom::Role::kListBox:
      return item_role == ax::mojom::Role::kListBoxOption;
    case ax::mojom::Role::kMenuListPopup:
      return item_role == ax::mojom::Role::kMenuListOption ||
             item_role == ax::mojom::Role::kMenuItem ||
             item_role == ax::mojom::Role::kMenuItemRadio ||
             item_role == ax::mojom::Role::kMenuItemCheckBox;
    case ax::mojom::Role::kRadioGroup:
      return item_role == ax::mojom::Role::kRadioButton;
    case ax::mojom::Role::kDescriptionList:
      // Only the term for each description list entry should receive posinset
      // and setsize.
      return item_role == ax::mojom::Role::kDescriptionListTerm ||
             item_role == ax::mojom::Role::kTerm;
    case ax::mojom::Role::kPopUpButton:
      // kPopUpButtons can wrap a kMenuListPopUp.
      return item_role == ax::mojom::Role::kMenuListPopup;
    default:
      return false;
  }
}

◆ SwapChildren()

void ui::AXNode::SwapChildren ( std::vector< AXNode * > * children )

Definition at line 399 of file ax_node.cc.

                                                      {
  children->swap(children_);
}

◆ TakeData()

AXNodeData && ui::AXNode::TakeData ( )

Definition at line 43 of file ax_node.cc.

                              {
  return std::move(data_);
}

◆ tree()

OwnerTree * ui::AXNode::tree ( ) const

inline

Definition at line 109 of file ax_node.h.

109{ return tree_; }

◆ UnignoredChildrenBegin()

AXNode::UnignoredChildIterator ui::AXNode::UnignoredChildrenBegin ( ) const

Definition at line 311 of file ax_node.cc.

                                                                  {
  BASE_DCHECK(!tree_->GetTreeUpdateInProgressState());
  return UnignoredChildIterator(this, GetFirstUnignoredChild());
}

◆ UnignoredChildrenEnd()

AXNode::UnignoredChildIterator ui::AXNode::UnignoredChildrenEnd ( ) const

Definition at line 316 of file ax_node.cc.

                                                                {
  BASE_DCHECK(!tree_->GetTreeUpdateInProgressState());
  return UnignoredChildIterator(this, nullptr);
}

◆ UpdateUnignoredCachedValues()

void ui::AXNode::UpdateUnignoredCachedValues ( )

Definition at line 394 of file ax_node.cc.

                                         {
  if (!IsIgnored())
    UpdateUnignoredCachedValuesRecursive(0);
}

Member Data Documentation

◆ kInvalidAXID

constexpr AXNode::AXID ui::AXNode::kInvalidAXID = -1

staticconstexpr

Definition at line 41 of file ax_node.h.

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

third_party/accessibility/ax/ax_node.h
third_party/accessibility/ax/ax_node.cc

Classes

Public Types

Public Member Functions

Static Public Attributes

Detailed Description

Member Typedef Documentation

◆ AXID

◆ UnignoredChildIterator

Constructor & Destructor Documentation

◆ AXNode()

◆ ~AXNode()

Member Function Documentation

◆ children()

◆ data()

◆ Destroy()

◆ GetBoolAttribute() [1/2]

◆ GetBoolAttribute() [2/2]

◆ GetCollapsedMenuListPopUpButtonAncestor()

◆ GetDeepestFirstUnignoredChild()

◆ GetDeepestLastUnignoredChild()

◆ GetExtraMacNodes()

◆ GetFirstChild()

◆ GetFirstUnignoredChild()

◆ GetFloatAttribute() [1/2]

◆ GetFloatAttribute() [2/2]

◆ GetHierarchicalLevel()

◆ GetHtmlAttribute() [1/2]

◆ GetHtmlAttribute() [2/2]

◆ GetIndexInParent()

◆ GetInheritedString16Attribute()

◆ GetInheritedStringAttribute()

◆ GetInnerText()

◆ GetIntAttribute() [1/2]

◆ GetIntAttribute() [2/2]

◆ GetIntListAttribute() [1/2]

◆ GetIntListAttribute() [2/2]

◆ GetLanguage()

◆ GetLastChild()

◆ GetLastUnignoredChild()

◆ GetLowestPlatformAncestor()

◆ GetNextSibling()

◆ GetNextUnignoredInTreeOrder()

◆ GetNextUnignoredSibling()

◆ GetOrComputeLineStartOffsets()

◆ GetOrderedSet()

◆ GetParentCrossingTreeBoundary()

◆ GetPosInSet()

◆ GetPreviousSibling()

◆ GetPreviousUnignoredInTreeOrder()

◆ GetPreviousUnignoredSibling()

◆ GetSetSize()

◆ GetString16Attribute() [1/2]

◆ GetString16Attribute() [2/2]

◆ GetStringAttribute() [1/2]

◆ GetStringAttribute() [2/2]

◆ GetStringListAttribute() [1/2]

◆ GetStringListAttribute() [2/2]

◆ GetTableAriaColCount()

◆ GetTableAriaRowCount()

◆ GetTableCaption()

◆ GetTableCellAriaColIndex()

◆ GetTableCellAriaRowIndex()

◆ GetTableCellColHeaderNodeIds()

◆ GetTableCellColHeaders()

◆ GetTableCellColIndex()

◆ GetTableCellColSpan()

◆ GetTableCellCount()

◆ GetTableCellFromCoords()

◆ GetTableCellFromIndex()

◆ GetTableCellIndex()

◆ GetTableCellRowHeaderNodeIds()

◆ GetTableCellRowHeaders()

◆ GetTableCellRowIndex()

◆ GetTableCellRowSpan()

◆ GetTableColCount()

◆ GetTableColHeaderNodeIds() [1/2]

◆ GetTableColHeaderNodeIds() [2/2]

◆ GetTableHasColumnOrRowHeaderNode()

◆ GetTableRowCount()

◆ GetTableRowHeaderNodeIds()