ui::AXPlatformNode Class Reference

#include <ax_platform_node.h>

Inheritance diagram for ui::AXPlatformNode:

Public Types
typedef AXPlatformNode *	NativeWindowHandlerCallback(gfx::NativeWindow)

Public Member Functions
virtual void	Destroy ()
virtual gfx::NativeViewAccessible	GetNativeViewAccessible ()=0
virtual void	NotifyAccessibilityEvent (ax::mojom::Event event_type)=0
virtual AXPlatformNodeDelegate *	GetDelegate () const =0
virtual bool	IsDescendantOf (AXPlatformNode *ancestor) const =0
void	SetIsPrimaryWebContentsForWindow (bool is_primary)
bool	IsPrimaryWebContentsForWindow () const
int32_t	GetUniqueId () const
std::string	ToString ()
std::string	SubtreeToString ()
virtual	~AXPlatformNode ()

Static Public Member Functions
static AXPlatformNode *	Create (AXPlatformNodeDelegate *delegate)
static AXPlatformNode *	FromNativeViewAccessible (gfx::NativeViewAccessible accessible)
static AXPlatformNode *	FromNativeWindow (gfx::NativeWindow native_window)
static void	RegisterNativeWindowHandler (std::function< NativeWindowHandlerCallback > handler)
static void	AddAXModeObserver (AXModeObserver *observer)
static void	RemoveAXModeObserver (AXModeObserver *observer)
static AXMode	GetAccessibilityMode ()
static void	NotifyAddAXModeFlags (AXMode mode_flags)
static gfx::NativeViewAccessible	GetPopupFocusOverride ()
static void	SetPopupFocusOverride (gfx::NativeViewAccessible focus_override)

Protected Member Functions
	AXPlatformNode ()

Friends
std::ostream &	operator<< (std::ostream &stream, AXPlatformNode &node)

Detailed Description

Definition at line 29 of file ax_platform_node.h.

Member Typedef Documentation

NativeWindowHandlerCallback

typedef AXPlatformNode * ui::AXPlatformNode::NativeWindowHandlerCallback(gfx::NativeWindow)

Definition at line 31 of file ax_platform_node.h.

Constructor & Destructor Documentation

~AXPlatformNode()

ui::AXPlatformNode::~AXPlatformNode ( )

virtual

Definition at line 38 of file ax_platform_node.cc.

{}

AXPlatformNode()

ui::AXPlatformNode::AXPlatformNode ( )

protected

Definition at line 36 of file ax_platform_node.cc.

{}

Member Function Documentation

AddAXModeObserver()

void ui::AXPlatformNode::AddAXModeObserver ( AXModeObserver *  observer )

static

Definition at line 68 of file ax_platform_node.cc.

                                                               {
  ax_mode_observers_.push_back(observer);
}

Create()

AXPlatformNode * ui::AXPlatformNode::Create ( AXPlatformNodeDelegate *  delegate )

static

Definition at line 1052 of file ax_platform_node_mac.mm.

                                                                       {
  AXPlatformNodeBase* node = new AXPlatformNodeMac();
  node->Init(delegate);
  return node;
}

Destroy()

void ui::AXPlatformNode::Destroy ( )

virtual

Reimplemented in ui::AXPlatformNodeBase, and ui::AXPlatformNodeMac.

Definition at line 40 of file ax_platform_node.cc.

{}

FromNativeViewAccessible()

AXPlatformNode * ui::AXPlatformNode::FromNativeViewAccessible ( gfx::NativeViewAccessible  accessible )

static

Definition at line 1059 of file ax_platform_node_mac.mm.

                                                                                           {
  if ([accessible isKindOfClass:[AXPlatformNodeCocoa class]])
    return [accessible node];
  return nullptr;
}

FromNativeWindow()

AXPlatformNode * ui::AXPlatformNode::FromNativeWindow ( gfx::NativeWindow  native_window )

static

Definition at line 24 of file ax_platform_node.cc.

                                   {
  if (native_window_handler_)
    return native_window_handler_(native_window);
  return nullptr;
}

GetAccessibilityMode()

static AXMode ui::AXPlatformNode::GetAccessibilityMode ( )

inlinestatic

Definition at line 56 of file ax_platform_node.h.

{ return ax_mode_; }

GetDelegate()

virtual AXPlatformNodeDelegate * ui::AXPlatformNode::GetDelegate ( ) const

pure virtual

Implemented in ui::AXPlatformNodeBase.

GetNativeViewAccessible()

virtual gfx::NativeViewAccessible ui::AXPlatformNode::GetNativeViewAccessible ( )

pure virtual

Implemented in flutter::FlutterTextPlatformNode, ui::AXPlatformNodeBase, and ui::AXPlatformNodeMac.

GetPopupFocusOverride()

gfx::NativeViewAccessible ui::AXPlatformNode::GetPopupFocusOverride ( )

static

Definition at line 99 of file ax_platform_node.cc.

                                                              {
  return popup_focus_override_;
}

GetUniqueId()

int32_t ui::AXPlatformNode::GetUniqueId

(

)

const

Definition at line 42 of file ax_platform_node.cc.

                                          {
  BASE_DCHECK(GetDelegate());
  return GetDelegate() ? GetDelegate()->GetUniqueId().Get() : -1;
}

IsDescendantOf()

virtual bool ui::AXPlatformNode::IsDescendantOf ( AXPlatformNode *  ancestor ) const

pure virtual

Implemented in ui::AXPlatformNodeBase.

IsPrimaryWebContentsForWindow()

bool ui::AXPlatformNode::IsPrimaryWebContentsForWindow

(

)

const

Definition at line 51 of file ax_platform_node.cc.

                                                         {
  return is_primary_web_contents_for_window_;
}

NotifyAccessibilityEvent()

virtual void ui::AXPlatformNode::NotifyAccessibilityEvent ( ax::mojom::Event  event_type )

pure virtual

Implemented in ui::AXPlatformNodeBase, and ui::AXPlatformNodeMac.

NotifyAddAXModeFlags()

void ui::AXPlatformNode::NotifyAddAXModeFlags ( AXMode  mode_flags )

static

Definition at line 79 of file ax_platform_node.cc.

                                                           {
  // Note: this is only called on Windows.
  AXMode new_ax_mode(ax_mode_);
  new_ax_mode |= mode_flags;
 
  if (new_ax_mode == ax_mode_)
    return;  // No change.
 
  ax_mode_ = new_ax_mode;
  for (AXModeObserver* observer : ax_mode_observers_)
    observer->OnAXModeAdded(mode_flags);
}

RegisterNativeWindowHandler()

void ui::AXPlatformNode::RegisterNativeWindowHandler ( std::function< NativeWindowHandlerCallback >  handler )

static

Definition at line 31 of file ax_platform_node.cc.

                                                                    {
  native_window_handler_ = handler;
}

RemoveAXModeObserver()

void ui::AXPlatformNode::RemoveAXModeObserver ( AXModeObserver *  observer )

static

Definition at line 73 of file ax_platform_node.cc.

                                                                  {
  ax_mode_observers_.erase(std::find(ax_mode_observers_.begin(),
                                     ax_mode_observers_.end(), observer));
}

SetIsPrimaryWebContentsForWindow()

void ui::AXPlatformNode::SetIsPrimaryWebContentsForWindow

(

bool

is_primary

)

Definition at line 47 of file ax_platform_node.cc.

                                                                     {
  is_primary_web_contents_for_window_ = is_primary;
}

SetPopupFocusOverride()

void ui::AXPlatformNode::SetPopupFocusOverride ( gfx::NativeViewAccessible  focus_override )

static

Definition at line 93 of file ax_platform_node.cc.

                                                  {
  popup_focus_override_ = popup_focus_override;
}

SubtreeToString()

std::string ui::AXPlatformNode::SubtreeToString

(

)

Definition at line 59 of file ax_platform_node.cc.

                                          {
  return GetDelegate() ? GetDelegate()->SubtreeToString() : "No delegate";
}

ToString()

std::string ui::AXPlatformNode::ToString

(

)

Definition at line 55 of file ax_platform_node.cc.

                                   {
  return GetDelegate() ? GetDelegate()->ToString() : "No delegate";
}

Friends And Related Function Documentation

operator<<

std::ostream & operator<< ( std::ostream &  stream, AXPlatformNode &  node  )

friend

Definition at line 63 of file ax_platform_node.cc.

                                                                 {
  return stream << node.ToString();
}

---

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

• third_party/accessibility/ax/platform/ax_platform_node.h
• third_party/accessibility/ax/platform/ax_platform_node.cc
• third_party/accessibility/ax/platform/ax_platform_node_mac.mm
• third_party/accessibility/ax/platform/ax_platform_node_win.cc