Flutter Engine Uber Docs
Docs for the entire Flutter Engine repo.
 
Loading...
Searching...
No Matches
flutter::AccessibilityPlugin Class Reference

#include <accessibility_plugin.h>

Public Member Functions

 AccessibilityPlugin (FlutterWindowsEngine *engine)
 
virtual void Announce (const FlutterViewId view_id, const std::string_view message)
 

Static Public Member Functions

static void SetUp (BinaryMessenger *binary_messenger, AccessibilityPlugin *plugin)
 

Detailed Description

Definition at line 22 of file accessibility_plugin.h.

Constructor & Destructor Documentation

◆ AccessibilityPlugin()

flutter::AccessibilityPlugin::AccessibilityPlugin ( FlutterWindowsEngine engine)
explicit

Definition at line 88 of file accessibility_plugin.cc.

89 : engine_(engine) {}
FlutterEngine engine
Definition main.cc:84

Member Function Documentation

◆ Announce()

void flutter::AccessibilityPlugin::Announce ( const FlutterViewId  view_id,
const std::string_view  message 
)
virtual

Definition at line 107 of file accessibility_plugin.cc.

108 {
109 if (!engine_->semantics_enabled()) {
110 return;
111 }
112
113 auto view = engine_->view(view_id);
114 if (!view) {
115 return;
116 }
117
118 std::wstring wide_text = fml::Utf8ToWideString(message);
119 view->AnnounceAlert(wide_text);
120}
FlutterWindowsView * view(FlutterViewId view_id) const
FlView * view
const char * message
G_BEGIN_DECLS FlutterViewId view_id
std::wstring Utf8ToWideString(const std::string_view str)

References message, flutter::FlutterWindowsEngine::semantics_enabled(), fml::Utf8ToWideString(), view, flutter::FlutterWindowsEngine::view(), and view_id.

Referenced by flutter::testing::TEST_F().

◆ SetUp()

void flutter::AccessibilityPlugin::SetUp ( BinaryMessenger binary_messenger,
AccessibilityPlugin plugin 
)
static

Definition at line 91 of file accessibility_plugin.cc.

92 {
93 BasicMessageChannel<> channel{binary_messenger, kAccessibilityChannelName,
95
96 channel.SetMessageHandler(
97 [plugin](const EncodableValue& message,
98 const MessageReply<EncodableValue>& reply) {
99 HandleMessage(plugin, message);
100
101 // The accessibility channel does not support error handling.
102 // Always return an empty response even on failure.
103 reply(EncodableValue{std::monostate{}});
104 });
105}
static const StandardMessageCodec & GetInstance(const StandardCodecSerializer *serializer=nullptr)
const gchar * channel
static constexpr char kAccessibilityChannelName[]

References channel, flutter::StandardMessageCodec::GetInstance(), kAccessibilityChannelName, and message.

Referenced by flutter::testing::AccessibilityPluginTest::SetUp().


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