ui::AXPlatformRelationWin Class Reference

#include <ax_platform_relation_win.h>

Inheritance diagram for ui::AXPlatformRelationWin:

Public Member Functions
	AXPlatformRelationWin ()
virtual	~AXPlatformRelationWin ()
void	Initialize (const base::string16 &type)
void	Invalidate ()
void	AddTarget (AXPlatformNodeWin *target)
IFACEMETHODIMP	get_relationType (BSTR *relation_type) override
IFACEMETHODIMP	get_nTargets (LONG *n_targets) override
IFACEMETHODIMP	get_target (LONG target_index, IUnknown **target) override
IFACEMETHODIMP	get_targets (LONG max_targets, IUnknown **targets, LONG *n_targets) override
IFACEMETHODIMP	get_localizedRelationType (BSTR *relation_type) override

Static Public Member Functions
static int	EnumerateRelationships (AXPlatformNodeBase *node, int desired_index, const base::string16 &desired_ia2_relation, base::string16 *out_ia2_relation, std::set< AXPlatformNode * > *out_targets)

Detailed Description

Definition at line 32 of file ax_platform_relation_win.h.

Constructor & Destructor Documentation

AXPlatformRelationWin()

ui::AXPlatformRelationWin::AXPlatformRelationWin

(

)

Definition at line 34 of file ax_platform_relation_win.cc.

                                             {
  win::CreateATLModuleIfNeeded();
}

References ui::win::CreateATLModuleIfNeeded().

~AXPlatformRelationWin()

ui::AXPlatformRelationWin::~AXPlatformRelationWin ( )

virtual

Definition at line 38 of file ax_platform_relation_win.cc.

{}

Member Function Documentation

AddTarget()

void ui::AXPlatformRelationWin::AddTarget

(

AXPlatformNodeWin *

target

)

Definition at line 256 of file ax_platform_relation_win.cc.

                                                               {
  targets_.push_back(target);
}

References target.

EnumerateRelationships()

int ui::AXPlatformRelationWin::EnumerateRelationships ( AXPlatformNodeBase *  node, int  desired_index, const base::string16 &  desired_ia2_relation, base::string16 *  out_ia2_relation, std::set< AXPlatformNode * > *  out_targets  )

static

Definition at line 108 of file ax_platform_relation_win.cc.

                                          {
  const AXNodeData& node_data = node->GetData();
  AXPlatformNodeDelegate* delegate = node->GetDelegate();
 
  // The first time this is called, populate vectors with all of the
  // int attributes and intlist attributes that have reverse relations
  // we care about on Windows. Computing these by calling
  // GetIA2ReverseRelationFrom{Int|IntList}Attr on every possible attribute
  // simplifies the work needed to support an additional relation
  // attribute in the future.
  static std::vector<ax::mojom::IntAttribute>
      int_attributes_with_reverse_relations;
  static std::vector<ax::mojom::IntListAttribute>
      intlist_attributes_with_reverse_relations;
  static bool first_time = true;
  if (first_time) {
    for (int32_t attr_index =
             static_cast<int32_t>(ax::mojom::IntAttribute::kNone);
         attr_index <= static_cast<int32_t>(ax::mojom::IntAttribute::kMaxValue);
         ++attr_index) {
      auto attr = static_cast<ax::mojom::IntAttribute>(attr_index);
      if (!GetIA2ReverseRelationFromIntAttr(attr).empty())
        int_attributes_with_reverse_relations.push_back(attr);
    }
    for (int32_t attr_index =
             static_cast<int32_t>(ax::mojom::IntListAttribute::kNone);
         attr_index <=
         static_cast<int32_t>(ax::mojom::IntListAttribute::kMaxValue);
         ++attr_index) {
      auto attr = static_cast<ax::mojom::IntListAttribute>(attr_index);
      if (!GetIA2ReverseRelationFromIntListAttr(attr).empty())
        intlist_attributes_with_reverse_relations.push_back(attr);
    }
    first_time = false;
  }
 
  // Enumerate all of the relations and reverse relations that
  // are exposed via IAccessible2 on Windows. We do this with a series
  // of loops. Every time we encounter one, we check if the caller
  // requested that particular relation by index, and return it.
  // Otherwise we build up and return the total number of relations found.
  int total_count = 0;
 
  // Iterate over all int attributes on this node to check the ones
  // that correspond to IAccessible2 relations.
  for (size_t i = 0; i < node_data.int_attributes.size(); ++i) {
    ax::mojom::IntAttribute int_attribute = node_data.int_attributes[i].first;
    base::string16 relation = GetIA2RelationFromIntAttr(int_attribute);
    if (!relation.empty() &&
        (desired_ia2_relation.empty() || desired_ia2_relation == relation)) {
      // Skip reflexive relations
      if (node_data.int_attributes[i].second == node_data.id)
        continue;
      if (desired_index == total_count) {
        *out_ia2_relation = relation;
        out_targets->insert(
            delegate->GetFromNodeID(node_data.int_attributes[i].second));
        return 1;
      }
      total_count++;
    }
  }
 
  // Iterate over all of the int attributes that have reverse relations
  // in IAccessible2, and query AXTree to see if the reverse relation exists.
  for (ax::mojom::IntAttribute int_attribute :
       int_attributes_with_reverse_relations) {
    base::string16 relation = GetIA2ReverseRelationFromIntAttr(int_attribute);
    std::set<AXPlatformNode*> targets =
        delegate->GetReverseRelations(int_attribute);
    // Erase reflexive relations.
    targets.erase(node);
    if (targets.size()) {
      if (!relation.empty() &&
          (desired_ia2_relation.empty() || desired_ia2_relation == relation)) {
        if (desired_index == total_count) {
          *out_ia2_relation = relation;
          *out_targets = targets;
          return 1;
        }
        total_count++;
      }
    }
  }
 
  // Iterate over all intlist attributes on this node to check the ones
  // that correspond to IAccessible2 relations.
  for (size_t i = 0; i < node_data.intlist_attributes.size(); ++i) {
    ax::mojom::IntListAttribute intlist_attribute =
        node_data.intlist_attributes[i].first;
    base::string16 relation = GetIA2RelationFromIntListAttr(intlist_attribute);
    if (!relation.empty() &&
        (desired_ia2_relation.empty() || desired_ia2_relation == relation)) {
      if (desired_index == total_count) {
        *out_ia2_relation = relation;
        for (int32_t target_id : node_data.intlist_attributes[i].second) {
          // Skip reflexive relations
          if (target_id == node_data.id)
            continue;
          out_targets->insert(delegate->GetFromNodeID(target_id));
        }
        if (out_targets->size() == 0)
          continue;
        return 1;
      }
      total_count++;
    }
  }
 
  // Iterate over all of the intlist attributes that have reverse relations
  // in IAccessible2, and query AXTree to see if the reverse relation exists.
  for (ax::mojom::IntListAttribute intlist_attribute :
       intlist_attributes_with_reverse_relations) {
    base::string16 relation =
        GetIA2ReverseRelationFromIntListAttr(intlist_attribute);
    std::set<AXPlatformNode*> targets =
        delegate->GetReverseRelations(intlist_attribute);
    // Erase reflexive relations.
    targets.erase(node);
    if (targets.size()) {
      if (!relation.empty() &&
          (desired_ia2_relation.empty() || desired_ia2_relation == relation)) {
        if (desired_index == total_count) {
          *out_ia2_relation = relation;
          *out_targets = targets;
          return 1;
        }
        total_count++;
      }
    }
  }
 
  return total_count;
}

References ui::AXPlatformNodeBase::GetData(), ui::AXPlatformNodeBase::GetDelegate(), ui::AXPlatformNodeDelegate::GetFromNodeID(), ui::GetIA2RelationFromIntAttr(), ui::GetIA2RelationFromIntListAttr(), ui::GetIA2ReverseRelationFromIntAttr(), ui::GetIA2ReverseRelationFromIntListAttr(), ui::AXPlatformNodeDelegate::GetReverseRelations(), i, ui::AXNodeData::id, ui::AXNodeData::int_attributes, ui::AXNodeData::intlist_attributes, ax::mojom::kMaxValue, and ax::mojom::kNone.

get_localizedRelationType()

IFACEMETHODIMP ui::AXPlatformRelationWin::get_localizedRelationType ( BSTR *  relation_type )

override

Definition at line 315 of file ax_platform_relation_win.cc.

                                                                    {
  return E_NOTIMPL;
}

get_nTargets()

IFACEMETHODIMP ui::AXPlatformRelationWin::get_nTargets ( LONG *  n_targets )

override

Definition at line 269 of file ax_platform_relation_win.cc.

                                                                  {
  if (!n_targets)
    return E_INVALIDARG;
 
  *n_targets = static_cast<LONG>(targets_.size());
  return S_OK;
}

get_relationType()

IFACEMETHODIMP ui::AXPlatformRelationWin::get_relationType ( BSTR *  relation_type )

override

Definition at line 260 of file ax_platform_relation_win.cc.

                                                                          {
  if (!relation_type)
    return E_INVALIDARG;
 
  *relation_type = SysAllocString(type_.c_str());
  DCHECK(*relation_type);
  return S_OK;
}

get_target()

IFACEMETHODIMP ui::AXPlatformRelationWin::get_target ( LONG  target_index, IUnknown **  target  )

override

Definition at line 277 of file ax_platform_relation_win.cc.

                                                                    {
  if (!target)
    return E_INVALIDARG;
 
  if (target_index < 0 || target_index >= static_cast<LONG>(targets_.size())) {
    return E_INVALIDARG;
  }
 
  *target = static_cast<IAccessible*>(targets_[target_index].Get());
  (*target)->AddRef();
  return S_OK;
}

References target.

Referenced by get_targets().

get_targets()

IFACEMETHODIMP ui::AXPlatformRelationWin::get_targets ( LONG  max_targets, IUnknown **  targets, LONG *  n_targets  )

override

Definition at line 291 of file ax_platform_relation_win.cc.

                                                                   {
  if (!targets || !n_targets)
    return E_INVALIDARG;
 
  LONG count = static_cast<LONG>(targets_.size());
  if (count > max_targets)
    count = max_targets;
 
  *n_targets = count;
  if (count == 0)
    return S_FALSE;
 
  for (LONG i = 0; i < count; ++i) {
    HRESULT result = get_target(i, &targets[i]);
    if (result != S_OK)
      return result;
  }
 
  return S_OK;
}

References get_target(), and i.

Initialize()

void ui::AXPlatformRelationWin::Initialize

(

const base::string16 &

type

)

Definition at line 248 of file ax_platform_relation_win.cc.

                                                               {
  type_ = type;
}

References type.

Invalidate()

void ui::AXPlatformRelationWin::Invalidate

(

)

Definition at line 252 of file ax_platform_relation_win.cc.

                                       {
  targets_.clear();
}

---

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

• third_party/accessibility/ax/platform/ax_platform_relation_win.h
• third_party/accessibility/ax/platform/ax_platform_relation_win.cc