#include <flutter_platform_node_delegate.h>

Inheritance diagram for flutter::FlutterPlatformNodeDelegate:

Classes
class	OwnerBridge

Public Member Functions
	FlutterPlatformNodeDelegate ()

virtual	~FlutterPlatformNodeDelegate () override

const ui::AXUniqueId &	GetUniqueId () const override

const ui::AXNodeData &	GetData () const override

bool	AccessibilityPerformAction (const ui::AXActionData &data) override

gfx::NativeViewAccessible	GetParent () override

gfx::NativeViewAccessible	GetFocus () override

int	GetChildCount () const override

gfx::NativeViewAccessible	ChildAtIndex (int index) override

gfx::Rect	GetBoundsRect (const ui::AXCoordinateSystem coordinate_system, const ui::AXClippingBehavior clipping_behavior, ui::AXOffscreenResult *offscreen_result) const override

gfx::NativeViewAccessible	GetLowestPlatformAncestor () const override

ui::AXNodePosition::AXPositionInstance	CreateTextPositionAt (int offset) const override

virtual void	Init (std::weak_ptr< OwnerBridge > bridge, ui::AXNode *node)
	Called only once, immediately after construction. The constructor doesn't take any arguments because in the Windows subclass we use a special function to construct a COM object. Subclasses must call super.

ui::AXNode *	GetAXNode () const
	Gets the underlying ax node for this platform node delegate.

std::weak_ptr< OwnerBridge >	GetOwnerBridge () const
	Gets the owner of this platform node delegate. This is useful when you want to get the information about surrounding nodes of this platform node delegate, e.g. the global rect of this platform node delegate. This pointer is only safe in the platform thread.

virtual ui::AXPlatformNode *	GetPlatformNode () const

virtual ui::AXPlatformNode *	GetFromNodeID (int32_t id) override

virtual ui::AXPlatformNode *	GetFromTreeIDAndNodeID (const ui::AXTreeID &tree_id, int32_t node_id) override

virtual const ui::AXTree::Selection	GetUnignoredSelection () const override

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

	~AXPlatformNodeDelegateBase () override

const AXTreeData &	GetTreeData () const override

std::u16string	GetInnerText () const override

gfx::NativeViewAccessible	GetNSWindow () override

gfx::NativeViewAccessible	GetNativeViewAccessible () override

int	GetIndexInParent () override

bool	HasModalDialog () const override

gfx::NativeViewAccessible	GetFirstChild () override

gfx::NativeViewAccessible	GetLastChild () override

gfx::NativeViewAccessible	GetNextSibling () override

gfx::NativeViewAccessible	GetPreviousSibling () override

bool	IsChildOfLeaf () const override

bool	IsChildOfPlainTextField () const override

bool	IsLeaf () const override

bool	IsToplevelBrowserWindow () override

gfx::NativeViewAccessible	GetClosestPlatformObject () const override

std::unique_ptr< AXPlatformNodeDelegate::ChildIterator >	ChildrenBegin () override

std::unique_ptr< AXPlatformNodeDelegate::ChildIterator >	ChildrenEnd () override

std::string	GetName () const override

std::u16string	GetHypertext () const override

bool	SetHypertextSelection (int start_offset, int end_offset) override

TextAttributeMap	ComputeTextAttributeMap (const TextAttributeList &default_attributes) const override

std::string	GetInheritedFontFamilyName () const override

gfx::Rect	GetHypertextRangeBoundsRect (const int start_offset, const int end_offset, const AXCoordinateSystem coordinate_system, const AXClippingBehavior clipping_behavior, AXOffscreenResult *offscreen_result) const override

gfx::Rect	GetInnerTextRangeBoundsRect (const int start_offset, const int end_offset, const AXCoordinateSystem coordinate_system, const AXClippingBehavior clipping_behavior, AXOffscreenResult *offscreen_result) const override

gfx::Rect	GetClippedScreenBoundsRect (AXOffscreenResult *offscreen_result=nullptr) const override

gfx::Rect	GetUnclippedScreenBoundsRect (AXOffscreenResult *offscreen_result=nullptr) const

gfx::NativeViewAccessible	HitTestSync (int screen_physical_pixel_x, int screen_physical_pixel_y) const override

bool	IsOffscreen () const override

bool	IsMinimized () const override

bool	IsText () const override

bool	IsWebContent () const override

bool	HasVisibleCaretOrSelection () const override

AXPlatformNode *	GetTargetNodeForRelation (ax::mojom::IntAttribute attr) override

std::vector< AXPlatformNode * >	GetTargetNodesForRelation (ax::mojom::IntListAttribute attr) override

std::set< AXPlatformNode * >	GetReverseRelations (ax::mojom::IntAttribute attr) override

std::set< AXPlatformNode * >	GetReverseRelations (ax::mojom::IntListAttribute attr) override

std::u16string	GetAuthorUniqueId () const override

std::optional< int >	FindTextBoundary (ax::mojom::TextBoundary boundary, int offset, ax::mojom::MoveDirection direction, ax::mojom::TextAffinity affinity) const override

const std::vector< gfx::NativeViewAccessible >	GetUIADescendants () const override

std::string	GetLanguage () const override

bool	IsTable () const override

std::optional< int >	GetTableColCount () const override

std::optional< int >	GetTableRowCount () const override

std::optional< int >	GetTableAriaColCount () const override

std::optional< int >	GetTableAriaRowCount () const override

std::optional< int >	GetTableCellCount () const override

std::optional< bool >	GetTableHasColumnOrRowHeaderNode () const override

std::vector< int32_t >	GetColHeaderNodeIds () const override

std::vector< int32_t >	GetColHeaderNodeIds (int col_index) const override

std::vector< int32_t >	GetRowHeaderNodeIds () const override

std::vector< int32_t >	GetRowHeaderNodeIds (int row_index) const override

AXPlatformNode *	GetTableCaption () const override

bool	IsTableRow () const override

std::optional< int >	GetTableRowRowIndex () const override

bool	IsTableCellOrHeader () const override

std::optional< int >	GetTableCellIndex () const override

std::optional< int >	GetTableCellColIndex () const override

std::optional< int >	GetTableCellRowIndex () const override

std::optional< int >	GetTableCellColSpan () const override

std::optional< int >	GetTableCellRowSpan () const override

std::optional< int >	GetTableCellAriaColIndex () const override

std::optional< int >	GetTableCellAriaRowIndex () const override

std::optional< int32_t >	GetCellId (int row_index, int col_index) const override

std::optional< int32_t >	CellIndexToId (int cell_index) const override

bool	IsCellOrHeaderOfARIATable () const override

bool	IsCellOrHeaderOfARIAGrid () const override

bool	IsOrderedSetItem () const override

bool	IsOrderedSet () const override

std::optional< int >	GetPosInSet () const override

std::optional< int >	GetSetSize () const override

gfx::AcceleratedWidget	GetTargetForNativeAccessibilityEvent () override

std::u16string	GetLocalizedStringForImageAnnotationStatus (ax::mojom::ImageAnnotationStatus status) const override

std::u16string	GetLocalizedRoleDescriptionForUnlabeledImage () const override

std::u16string	GetLocalizedStringForLandmarkType () const override

std::u16string	GetLocalizedStringForRoleDescription () const override

std::u16string	GetStyleNameAttributeAsLocalizedString () const override

bool	ShouldIgnoreHoveredStateForTesting () override

Public Member Functions inherited from ui::AXPlatformNodeDelegate
virtual	~AXPlatformNodeDelegate ()=default

std::string	ToString ()

std::string	SubtreeToString ()

Additional Inherited Members
Protected Member Functions inherited from ui::AXPlatformNodeDelegateBase
std::string	SubtreeToStringHelper (size_t level) override

std::set< ui::AXPlatformNode * >	GetNodesForNodeIds (const std::set< int32_t > &ids)

AXPlatformNodeDelegate *	GetParentDelegate ()

Protected Member Functions inherited from ui::AXPlatformNodeDelegate
	AXPlatformNodeDelegate ()=default

Detailed Description

The platform node delegate to be used in accessibility bridge. This class is responsible for providing native accessibility object with appropriate information, such as accessibility label/value/bounds.

While most methods have default implementations and are ready to be used as-is, the subclasses must override the GetNativeViewAccessible to return native accessibility objects. To do that, subclasses should create and maintain AXPlatformNode[s] which delegate their accessibility attributes to this class.

For desktop platforms, subclasses also need to override the GetBoundsRect to apply window-to-screen transform.

This class transforms bounds assuming the device pixel ratio is 1.0. See the https://github.com/flutter/flutter/issues/74283 for more information.

Definition at line 33 of file flutter_platform_node_delegate.h.

Constructor & Destructor Documentation

◆ FlutterPlatformNodeDelegate()

flutter::FlutterPlatformNodeDelegate::FlutterPlatformNodeDelegate ( )

default

◆ ~FlutterPlatformNodeDelegate()

flutter::FlutterPlatformNodeDelegate::~FlutterPlatformNodeDelegate ( )

overridevirtualdefault

Member Function Documentation

◆ AccessibilityPerformAction()

bool flutter::FlutterPlatformNodeDelegate::AccessibilityPerformAction ( const ui::AXActionData & data )

overridevirtual

Reimplemented from ui::AXPlatformNodeDelegateBase.

Definition at line 30 of file flutter_platform_node_delegate.cc.

                                {
  AccessibilityNodeId target = ax_node_->id();
  auto bridge_ptr = bridge_.lock();
  BASE_DCHECK(bridge_ptr);
  switch (data.action) {
    case ax::mojom::Action::kDoDefault:
      bridge_ptr->DispatchAccessibilityAction(
          target, FlutterSemanticsAction::kFlutterSemanticsActionTap, {});
      return true;
    case ax::mojom::Action::kFocus:
      bridge_ptr->SetLastFocusedId(target);
      bridge_ptr->DispatchAccessibilityAction(
          target,
          FlutterSemanticsAction::
              kFlutterSemanticsActionDidGainAccessibilityFocus,
          {});
      return true;
    case ax::mojom::Action::kScrollToMakeVisible:
      bridge_ptr->DispatchAccessibilityAction(
          target, FlutterSemanticsAction::kFlutterSemanticsActionShowOnScreen,
          {});
      return true;
    // TODO(chunhtai): support more actions.
    default:
      return false;
  }
  return false;
}

◆ ChildAtIndex()

gfx::NativeViewAccessible flutter::FlutterPlatformNodeDelegate::ChildAtIndex ( int index )

overridevirtual

Reimplemented from ui::AXPlatformNodeDelegateBase.

Definition at line 87 of file flutter_platform_node_delegate.cc.

                                                                           {
  auto bridge_ptr = bridge_.lock();
  BASE_DCHECK(bridge_ptr);
  AccessibilityNodeId child = ax_node_->GetUnignoredChildAtIndex(index)->id();
  return bridge_ptr->GetNativeAccessibleFromId(child);
}

◆ CreateTextPositionAt()

ui::AXNodePosition::AXPositionInstance flutter::FlutterPlatformNodeDelegate::CreateTextPositionAt ( int offset ) const

overridevirtual

Reimplemented from ui::AXPlatformNodeDelegateBase.

Definition at line 136 of file flutter_platform_node_delegate.cc.

                                                                  {
  return ui::AXNodePosition::CreatePosition(*ax_node_, offset);
}

◆ GetAXNode()

ui::AXNode * flutter::FlutterPlatformNodeDelegate::GetAXNode ( ) const

Gets the underlying ax node for this platform node delegate.

Definition at line 26 of file flutter_platform_node_delegate.cc.

                                                       {
  return ax_node_;
}

◆ GetBoundsRect()

gfx::Rect flutter::FlutterPlatformNodeDelegate::GetBoundsRect	(	const ui::AXCoordinateSystem	coordinate_system,
		const ui::AXClippingBehavior	clipping_behavior,
		ui::AXOffscreenResult *	offscreen_result
	)		const

overridevirtual

Reimplemented from ui::AXPlatformNodeDelegateBase.

Reimplemented in flutter::FlutterPlatformNodeDelegateMac, and flutter::FlutterPlatformNodeDelegateWindows.

Definition at line 94 of file flutter_platform_node_delegate.cc.

                                                 {
  auto bridge_ptr = bridge_.lock();
  BASE_DCHECK(bridge_ptr);
  // TODO(chunhtai): We need to apply screen dpr in here.
  // https://github.com/flutter/flutter/issues/74283
  const bool clip_bounds =
      clipping_behavior == ui::AXClippingBehavior::kClipped;
  bool offscreen = false;
  gfx::RectF bounds =
      bridge_ptr->RelativeToGlobalBounds(ax_node_, offscreen, clip_bounds);
  if (offscreen_result != nullptr) {
    *offscreen_result = offscreen ? ui::AXOffscreenResult::kOffscreen
                                  : ui::AXOffscreenResult::kOnscreen;
  }
  return gfx::ToEnclosingRect(bounds);
}

◆ GetChildCount()

int flutter::FlutterPlatformNodeDelegate::GetChildCount ( ) const

overridevirtual

Reimplemented from ui::AXPlatformNodeDelegateBase.

Definition at line 83 of file flutter_platform_node_delegate.cc.

                                                     {
  return static_cast<int>(ax_node_->GetUnignoredChildCount());
}

◆ GetData()

const ui::AXNodeData & flutter::FlutterPlatformNodeDelegate::GetData ( ) const

overridevirtual

Reimplemented from ui::AXPlatformNodeDelegateBase.

Definition at line 60 of file flutter_platform_node_delegate.cc.

                                                               {
  return ax_node_->data();
}

◆ GetFocus()

gfx::NativeViewAccessible flutter::FlutterPlatformNodeDelegate::GetFocus ( )

overridevirtual

Reimplemented from ui::AXPlatformNodeDelegateBase.

Definition at line 73 of file flutter_platform_node_delegate.cc.

                                                              {
  auto bridge_ptr = bridge_.lock();
  BASE_DCHECK(bridge_ptr);
  AccessibilityNodeId last_focused = bridge_ptr->GetLastFocusedId();
  if (last_focused == ui::AXNode::kInvalidAXID) {
    return nullptr;
  }
  return bridge_ptr->GetNativeAccessibleFromId(last_focused);
}

◆ GetFromNodeID()

ui::AXPlatformNode * flutter::FlutterPlatformNodeDelegate::GetFromNodeID ( int32_t id )

overridevirtual

Reimplemented from ui::AXPlatformNodeDelegateBase.

Definition at line 140 of file flutter_platform_node_delegate.cc.

                     {
  ui::AXTreeManager* tree_manager =
      ui::AXTreeManagerMap::GetInstance().GetManager(
          ax_node_->tree()->GetAXTreeID());
  AccessibilityBridge* platform_manager =
      static_cast<AccessibilityBridge*>(tree_manager);
  return platform_manager->GetPlatformNodeFromTree(node_id);
}

◆ GetFromTreeIDAndNodeID()

ui::AXPlatformNode * flutter::FlutterPlatformNodeDelegate::GetFromTreeIDAndNodeID	(	const ui::AXTreeID &	tree_id,
		int32_t	node_id
	)

overridevirtual

Reimplemented from ui::AXPlatformNodeDelegateBase.

Definition at line 150 of file flutter_platform_node_delegate.cc.

                     {
  ui::AXTreeManager* tree_manager =
      ui::AXTreeManagerMap::GetInstance().GetManager(tree_id);
  AccessibilityBridge* platform_manager =
      static_cast<AccessibilityBridge*>(tree_manager);
  return platform_manager->GetPlatformNodeFromTree(node_id);
}

◆ GetLowestPlatformAncestor()

gfx::NativeViewAccessible flutter::FlutterPlatformNodeDelegate::GetLowestPlatformAncestor ( ) const

overridevirtual

Reimplemented from ui::AXPlatformNodeDelegateBase.

Definition at line 124 of file flutter_platform_node_delegate.cc.

                                                             {
  auto bridge_ptr = bridge_.lock();
  BASE_DCHECK(bridge_ptr);
  auto lowest_platform_ancestor = ax_node_->GetLowestPlatformAncestor();
  if (lowest_platform_ancestor) {
    return bridge_ptr->GetNativeAccessibleFromId(
        ax_node_->GetLowestPlatformAncestor()->id());
  }
  return nullptr;
}

◆ GetOwnerBridge()

std::weak_ptr< FlutterPlatformNodeDelegate::OwnerBridge > flutter::FlutterPlatformNodeDelegate::GetOwnerBridge ( ) const

Gets the owner of this platform node delegate. This is useful when you want to get the information about surrounding nodes of this platform node delegate, e.g. the global rect of this platform node delegate. This pointer is only safe in the platform thread.

Definition at line 115 of file flutter_platform_node_delegate.cc.

                                                  {
  return bridge_;
}

◆ GetParent()

gfx::NativeViewAccessible flutter::FlutterPlatformNodeDelegate::GetParent ( )

overridevirtual

Reimplemented from ui::AXPlatformNodeDelegateBase.

Reimplemented in flutter::FlutterPlatformNodeDelegateMac.

Definition at line 64 of file flutter_platform_node_delegate.cc.

                                                               {
  if (!ax_node_->parent()) {
    return nullptr;
  }
  auto bridge_ptr = bridge_.lock();
  BASE_DCHECK(bridge_ptr);
  return bridge_ptr->GetNativeAccessibleFromId(ax_node_->parent()->id());
}

◆ GetPlatformNode()

ui::AXPlatformNode * flutter::FlutterPlatformNodeDelegate::GetPlatformNode ( ) const

virtual

Reimplemented in flutter::FlutterPlatformNodeDelegateWindows.

Definition at line 119 of file flutter_platform_node_delegate.cc.

                                                                     {
  return nullptr;
}

◆ GetUnignoredSelection()

const ui::AXTree::Selection flutter::FlutterPlatformNodeDelegate::GetUnignoredSelection ( ) const

overridevirtual

Reimplemented from ui::AXPlatformNodeDelegateBase.

Definition at line 160 of file flutter_platform_node_delegate.cc.

          {
  return ax_node_->GetUnignoredSelection();
}

◆ GetUniqueId()

const ui::AXUniqueId & flutter::FlutterPlatformNodeDelegate::GetUniqueId ( ) const

inlineoverridevirtual

Reimplemented from ui::AXPlatformNodeDelegateBase.

Definition at line 102 of file flutter_platform_node_delegate.h.

102{ return unique_id_; }

◆ Init()

void flutter::FlutterPlatformNodeDelegate::Init	(	std::weak_ptr< OwnerBridge >	bridge,
		ui::AXNode *	node
	)

virtual

Called only once, immediately after construction. The constructor doesn't take any arguments because in the Windows subclass we use a special function to construct a COM object. Subclasses must call super.

Reimplemented in flutter::FlutterPlatformNodeDelegateMac, and flutter::FlutterPlatformNodeDelegateWindows.

Definition at line 20 of file flutter_platform_node_delegate.cc.

                                                       {
  bridge_ = std::move(bridge);
  ax_node_ = node;
}

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

shell/platform/common/flutter_platform_node_delegate.h
shell/platform/common/flutter_platform_node_delegate.cc

Classes

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ FlutterPlatformNodeDelegate()

◆ ~FlutterPlatformNodeDelegate()

Member Function Documentation

◆ AccessibilityPerformAction()

◆ ChildAtIndex()

◆ CreateTextPositionAt()

◆ GetAXNode()

◆ GetBoundsRect()

◆ GetChildCount()

◆ GetData()

◆ GetFocus()

◆ GetFromNodeID()

◆ GetFromTreeIDAndNodeID()

◆ GetLowestPlatformAncestor()

◆ GetOwnerBridge()

◆ GetParent()

◆ GetPlatformNode()

◆ GetUnignoredSelection()

◆ GetUniqueId()

◆ Init()