15 UIAccessibilityScrollDirection direction) {
22 case UIAccessibilityScrollDirectionRight:
23 case UIAccessibilityScrollDirectionPrevious:
25 return flutter::SemanticsAction::kScrollRight;
26 case UIAccessibilityScrollDirectionLeft:
27 case UIAccessibilityScrollDirectionNext:
29 return flutter::SemanticsAction::kScrollLeft;
30 case UIAccessibilityScrollDirectionUp:
31 return flutter::SemanticsAction::kScrollDown;
32 case UIAccessibilityScrollDirectionDown:
33 return flutter::SemanticsAction::kScrollUp;
36 return flutter::SemanticsAction::kScrollUp;
40 SkM44 globalTransform = [reference node].transform;
42 globalTransform = parent.node.transform * globalTransform;
44 return globalTransform;
48 SkV4 vector = transform.map(point.x(), point.y(), 0, 1);
49 return SkPoint::Make(vector.x / vector.w, vector.y / vector.w);
53 UIView* containerView = [reference bridgeView];
58 SkPoint point = SkPoint::Make(local_point.x, local_point.y);
63 UIScreen* screen = containerView.window.screen;
65 CGFloat scale = (screen ?: UIScreen.mainScreen).scale;
66 auto result = CGPointMake(point.x() / scale, point.y() / scale);
67 return [containerView convertPoint:result toView:nil];
71 UIView* containerView = [reference bridgeView];
78 SkPoint::Make(local_rect.origin.x, local_rect.origin.y),
79 SkPoint::Make(local_rect.origin.x + local_rect.size.width, local_rect.origin.y),
80 SkPoint::Make(local_rect.origin.x + local_rect.size.width,
81 local_rect.origin.y + local_rect.size.height),
82 SkPoint::Make(local_rect.origin.x,
83 local_rect.origin.y + local_rect.size.height)
85 for (
auto& point : quad) {
89 NSCAssert(rect.setBoundsCheck({quad, 4}),
@"Transformed points can't form a rect");
90 rect.setBounds({quad, 4});
95 UIScreen* screen = containerView.window.screen;
97 CGFloat scale = (screen ?: UIScreen.mainScreen).scale;
99 CGRectMake(rect.x() / scale, rect.y() / scale, rect.width() / scale, rect.height() / scale);
100 return UIAccessibilityConvertFrameToScreenCoordinates(result, containerView);
106 @property(nonatomic, retain, readonly) UISwitch* nativeSwitch;
111 - (instancetype)initWithBridge:(
fml::WeakPtr<
flutter::AccessibilityBridgeIos>)bridge
113 self = [
super initWithBridge:bridge uid:uid];
115 _nativeSwitch = [[UISwitch alloc] init];
120 - (NSMethodSignature*)methodSignatureForSelector:(
SEL)sel {
121 NSMethodSignature* result = [
super methodSignatureForSelector:sel];
123 result = [
self.nativeSwitch methodSignatureForSelector:sel];
128 - (void)forwardInvocation:(NSInvocation*)anInvocation {
129 anInvocation.target =
self.nativeSwitch;
130 [anInvocation invoke];
133 - (NSString*)accessibilityValue {
134 self.nativeSwitch.on =
self.node.flags.isToggled == flutter::SemanticsTristate::kTrue ||
135 self.node.flags.isChecked == flutter::SemanticsCheckState::kTrue;
140 return self.nativeSwitch.accessibilityValue;
144 - (UIAccessibilityTraits)accessibilityTraits {
145 self.nativeSwitch.enabled =
self.node.flags.isEnabled == flutter::SemanticsTristate::kTrue;
147 return self.nativeSwitch.accessibilityTraits;
154 - (UIView*)reattachScrollViewToCurrentBridgeView;
155 - (void)updateScrollViewForCurrentBridgeView;
156 - (void)updateScrollViewGeometry;
161 - (instancetype)initWithBridge:(
fml::WeakPtr<
flutter::AccessibilityBridgeIos>)bridge
163 self = [
super initWithBridge:bridge uid:uid];
166 [_scrollView setShowsHorizontalScrollIndicator:NO];
167 [_scrollView setShowsVerticalScrollIndicator:NO];
168 [_scrollView setContentInset:UIEdgeInsetsZero];
169 [_scrollView setContentInsetAdjustmentBehavior:UIScrollViewContentInsetAdjustmentNever];
176 [_scrollView removeFromSuperview];
180 [
self updateScrollViewForCurrentBridgeView];
184 [
self updateScrollViewForCurrentBridgeView];
193 - (UIView*)reattachScrollViewToCurrentBridgeView {
194 UIView* view =
self.bridgeView;
195 if (_scrollView.superview != view) {
196 [_scrollView removeFromSuperview];
197 [view addSubview:_scrollView];
202 - (void)updateScrollViewForCurrentBridgeView {
203 UIView* view = [
self reattachScrollViewToCurrentBridgeView];
205 [
self updateScrollViewGeometry];
209 - (void)updateScrollViewGeometry {
218 _scrollView.frame =
self.accessibilityFrame;
219 _scrollView.contentSize = [
self contentSizeInternal];
221 if (!_scrollView.isDoingSystemScrolling) {
222 [_scrollView setContentOffset:self.contentOffsetInternal animated:NO];
226 - (float)scrollExtentMax {
230 float scrollExtentMax =
self.node.scrollExtentMax;
231 if (isnan(scrollExtentMax)) {
232 scrollExtentMax = 0.0f;
233 }
else if (!isfinite(scrollExtentMax)) {
236 return scrollExtentMax;
239 - (float)scrollPosition {
243 float scrollPosition =
self.node.scrollPosition;
244 if (isnan(scrollPosition)) {
245 scrollPosition = 0.0f;
247 NSCAssert(isfinite(scrollPosition),
@"The scrollPosition must not be infinity");
248 return scrollPosition;
251 - (CGSize)contentSizeInternal {
253 const SkRect& rect =
self.node.rect;
255 if (
self.
node.actions & flutter::kVerticalScrollSemanticsActions) {
256 result = CGRectMake(rect.x(), rect.y(), rect.width(), rect.height() + [
self scrollExtentMax]);
257 }
else if (
self.
node.actions & flutter::kHorizontalScrollSemanticsActions) {
258 result = CGRectMake(rect.x(), rect.y(), rect.width() + [
self scrollExtentMax], rect.height());
260 result = CGRectMake(rect.x(), rect.y(), rect.width(), rect.height());
265 - (CGPoint)contentOffsetInternal {
267 CGPoint origin = _scrollView.frame.origin;
268 const SkRect& rect =
self.node.rect;
269 if (
self.
node.actions & flutter::kVerticalScrollSemanticsActions) {
271 }
else if (
self.
node.actions & flutter::kHorizontalScrollSemanticsActions) {
276 return CGPointMake(result.x - origin.x, result.y - origin.y);
294 fml::WeakPtr<flutter::AccessibilityBridgeIos> _weakBridge;
299 #pragma mark - Designated initializers
301 - (instancetype)initWithBridge:(
fml::WeakPtr<
flutter::AccessibilityBridgeIos>)bridge
303 FML_DCHECK(bridge) <<
"bridge must be set";
306 if (!accessibility_bridge) {
313 UIView* accessibilityContainer =
315 self = [
super initWithAccessibilityContainer:accessibilityContainer];
318 _weakBridge = bridge;
320 _children = [[NSMutableArray alloc] init];
321 _childrenInHitTestOrder = [[NSArray alloc] init];
335 if (child.parent ==
self) {
339 [_children removeAllObjects];
345 #pragma mark - Semantic object property accesser
348 return [_children copy];
353 if (child.parent ==
self) {
363 - (void)setChildrenInHitTestOrder:(NSArray<
SemanticsObject*>*)childrenInHitTestOrder {
364 _childrenInHitTestOrder = [childrenInHitTestOrder copy];
367 - (BOOL)hasChildren {
368 return [
self.children count] != 0;
371 #pragma mark - Semantic object method
373 - (
flutter::AccessibilityBridgeIos*)bridge {
374 return _weakBridge.get();
377 - (UIView*)bridgeView {
382 - (void)setSemanticsNode:(const
flutter::SemanticsNode*)node {
386 - (void)accessibilityBridgeDidFinishUpdate {
389 - (void)accessibilityBridgeDidChangeView {
395 - (BOOL)nodeWillCauseLayoutChange:(const
flutter::SemanticsNode*)node {
396 return self.node.rect != node->rect ||
self.node.transform != node->transform;
402 - (BOOL)nodeWillCauseScroll:(const
flutter::SemanticsNode*)node {
403 return !isnan(
self.node.scrollPosition) && !isnan(node->scrollPosition) &&
404 self.node.scrollPosition != node->scrollPosition;
411 - (BOOL)nodeShouldTriggerAnnouncement:(const
flutter::SemanticsNode*)node {
413 if (!node || !node->flags.isLiveRegion) {
418 if (!
self.node.flags.isLiveRegion) {
423 return self.node.label != node->label;
426 - (void)replaceChildAtIndex:(NSInteger)index withChild:(
SemanticsObject*)child {
430 [_children replaceObjectAtIndex:index withObject:child];
433 - (NSString*)routeName {
436 if (
self.node.flags.namesRoute) {
437 NSString* newName =
self.accessibilityLabel;
438 if (newName != nil && [newName length] > 0) {
442 if ([
self hasChildren]) {
444 NSString* newName = [child routeName];
445 if (newName != nil && [newName length] > 0) {
453 - (id)nativeAccessibility {
457 - (NSAttributedString*)createAttributedStringFromString:(NSString*)string
459 (const
flutter::StringAttributes&)attributes {
460 NSMutableAttributedString* attributedString =
461 [[NSMutableAttributedString alloc] initWithString:string];
462 for (
const auto& attribute : attributes) {
463 NSRange range = NSMakeRange(attribute->start, attribute->end - attribute->start);
464 switch (attribute->type) {
465 case flutter::StringAttributeType::kLocale: {
466 std::shared_ptr<flutter::LocaleStringAttribute> locale_attribute =
467 std::static_pointer_cast<flutter::LocaleStringAttribute>(attribute);
468 NSDictionary* attributeDict = @{
469 UIAccessibilitySpeechAttributeLanguage : @(locale_attribute->locale.data()),
471 [attributedString setAttributes:attributeDict range:range];
474 case flutter::StringAttributeType::kSpellOut: {
475 NSDictionary* attributeDict = @{
476 UIAccessibilitySpeechAttributeSpellOut : @YES,
478 [attributedString setAttributes:attributeDict range:range];
483 return attributedString;
486 - (void)showOnScreen {
494 #pragma mark - UIAccessibility overrides
496 - (BOOL)isAccessibilityElement {
506 if (
self.node.flags.scopesRoute) {
510 return [
self isFocusable];
513 - (NSString*)accessibilityLanguage {
519 if (!
self.node.locale.empty()) {
520 return @(
self.node.locale.data());
525 - (bool)isFocusable {
534 return (
self.node.flags.hasImplicitScrolling &&
self.node.flags.isHidden)
536 || !
self.node.label.empty() || !
self.node.value.empty() || !
self.node.hint.empty() ||
537 (
self.node.actions & ~
flutter::kScrollableSemanticsActions) != 0;
541 if (
self.node.flags.scopesRoute) {
542 [edges addObject:self];
544 if ([
self hasChildren]) {
546 [child collectRoutes:edges];
556 if (!
self.node.HasAction(flutter::SemanticsAction::kCustomAction)) {
559 int32_t action_id = action.
uid;
560 std::vector<uint8_t> args;
562 args.push_back(action_id);
563 args.push_back(action_id >> 8);
564 args.push_back(action_id >> 16);
565 args.push_back(action_id >> 24);
567 self.uid, flutter::SemanticsAction::kCustomAction,
568 fml::MallocMapping::Copy(args.data(), args.size() *
sizeof(uint8_t)));
572 - (NSString*)accessibilityIdentifier {
577 if (
self.node.identifier.empty()) {
580 return @(
self.node.identifier.data());
583 - (NSString*)accessibilityLabel {
587 NSString* label = nil;
588 if (!
self.node.label.empty()) {
589 label = @(
self.node.label.data());
591 if (!
self.node.tooltip.empty()) {
592 label = label ? [NSString stringWithFormat:@"%@\n%@", label, @(self.node.tooltip.data())]
593 : @(
self.node.tooltip.data());
598 - (bool)containsPoint:(CGPoint)point {
600 return CGRectContainsPoint([
self globalRect], point);
604 - (id)search:(CGPoint)point {
607 if ([child containsPoint:point]) {
608 id childSearchResult = [child search:point];
609 if (childSearchResult != nil) {
610 return childSearchResult;
615 if ([
self containsPoint:point] && [
self isFocusable]) {
616 return self.nativeAccessibility;
628 - (id)_accessibilityHitTest:(CGPoint)point withEvent:(UIEvent*)event {
632 return [
self search:point];
636 - (BOOL)accessibilityScrollToVisible {
642 - (BOOL)accessibilityScrollToVisibleWithChild:(
id)child {
644 [child showOnScreen];
650 - (NSAttributedString*)accessibilityAttributedLabel {
651 NSString* label =
self.accessibilityLabel;
652 if (label.length == 0) {
655 return [
self createAttributedStringFromString:label withAttributes:self.node.labelAttributes];
658 - (NSString*)accessibilityHint {
663 if (
self.node.hint.empty()) {
666 return @(
self.node.hint.data());
669 - (NSAttributedString*)accessibilityAttributedHint {
670 NSString* hint = [
self accessibilityHint];
671 if (hint.length == 0) {
674 return [
self createAttributedStringFromString:hint withAttributes:self.node.hintAttributes];
677 - (NSString*)accessibilityValue {
682 if (!
self.node.value.empty()) {
683 return @(
self.node.value.data());
687 if (
self.node.flags.isInMutuallyExclusiveGroup) {
693 if (
self.node.flags.isToggled == flutter::SemanticsTristate::kTrue ||
694 self.node.flags.isChecked == flutter::SemanticsCheckState::kTrue) {
696 }
else if (
self.node.flags.isToggled == flutter::SemanticsTristate::kFalse ||
697 self.node.flags.isChecked == flutter::SemanticsCheckState::kFalse) {
704 - (NSAttributedString*)accessibilityAttributedValue {
705 NSString* value = [
self accessibilityValue];
706 if (value.length == 0) {
709 return [
self createAttributedStringFromString:value withAttributes:self.node.valueAttributes];
712 - (CGRect)accessibilityFrame {
717 if (
self.node.flags.isHidden) {
718 return [
super accessibilityFrame];
720 return [
self globalRect];
723 - (CGRect)globalRect {
724 const SkRect& rect =
self.node.rect;
725 CGRect localRect = CGRectMake(rect.x(), rect.y(), rect.width(), rect.height());
729 #pragma mark - UIAccessibilityElement protocol
731 - (void)setAccessibilityContainer:(
id)container {
736 - (id)accessibilityContainer {
749 if ([
self hasChildren] ||
self.uid ==
kRootNodeId) {
750 if (
self.container == nil) {
753 return self.container;
755 if (
self.parent == nil) {
761 return self.parent.accessibilityContainer;
764 #pragma mark - UIAccessibilityAction overrides
766 - (BOOL)accessibilityActivate {
771 if (!
self.node.HasAction(flutter::SemanticsAction::kTap)) {
776 if (
self.node.flags.isSlider) {
785 - (void)accessibilityIncrement {
790 if (
self.node.HasAction(flutter::SemanticsAction::kIncrease)) {
791 self.node.value =
self.node.increasedValue;
796 - (void)accessibilityDecrement {
801 if (
self.node.HasAction(flutter::SemanticsAction::kDecrease)) {
802 self.node.value =
self.node.decreasedValue;
807 - (BOOL)accessibilityScroll:(UIAccessibilityScrollDirection)direction {
813 if (!
self.node.HasAction(action)) {
820 - (BOOL)accessibilityPerformEscape {
825 if (!
self.node.HasAction(flutter::SemanticsAction::kDismiss)) {
832 #pragma mark UIAccessibilityFocus overrides
834 - (void)accessibilityElementDidBecomeFocused {
840 if (
self.node.flags.isHidden ||
self.node.flags.isHeader) {
843 if (
self.node.HasAction(flutter::SemanticsAction::kDidGainAccessibilityFocus)) {
848 - (void)accessibilityElementDidLoseFocus {
854 if (
self.node.HasAction(flutter::SemanticsAction::kDidLoseAccessibilityFocus)) {
859 - (BOOL)accessibilityRespondsToUserInteraction {
860 if (
self.node.flags.isAccessibilityFocusBlocked) {
865 if ((
self.node.actions & ~flutter::kSystemActions) != 0) {
869 if (!
self.node.customAccessibilityActions.empty()) {
880 #pragma mark - Designated initializers
882 - (instancetype)initWithBridge:(
fml::WeakPtr<
flutter::AccessibilityBridgeIos>)bridge
884 self = [
super initWithBridge:bridge uid:uid];
888 #pragma mark - UIAccessibility overrides
890 - (UIAccessibilityTraits)accessibilityTraits {
891 UIAccessibilityTraits traits = UIAccessibilityTraitNone;
892 if (
self.
node.HasAction(flutter::SemanticsAction::kIncrease) ||
893 self.node.HasAction(flutter::SemanticsAction::kDecrease)) {
894 traits |= UIAccessibilityTraitAdjustable;
897 if (
self.
node.flags.isToggled != flutter::SemanticsTristate::kNone ||
898 self.node.flags.isChecked != flutter::SemanticsCheckState::kNone) {
899 traits |= UIAccessibilityTraitButton;
901 if (
self.
node.flags.isSelected == flutter::SemanticsTristate::kTrue) {
902 traits |= UIAccessibilityTraitSelected;
904 if (
self.
node.flags.isButton) {
905 traits |= UIAccessibilityTraitButton;
907 if (
self.
node.flags.isEnabled == flutter::SemanticsTristate::kFalse) {
908 traits |= UIAccessibilityTraitNotEnabled;
910 if (
self.
node.headingLevel > 0) {
912 traits |= UIAccessibilityTraitHeader;
914 if (
self.
node.flags.isImage) {
915 traits |= UIAccessibilityTraitImage;
917 if (
self.
node.flags.isLiveRegion) {
918 traits |= UIAccessibilityTraitUpdatesFrequently;
920 if (
self.
node.flags.isLink) {
921 traits |= UIAccessibilityTraitLink;
923 if (traits == UIAccessibilityTraitNone && ![
self hasChildren] &&
924 self.accessibilityLabel.length != 0 && !
self.node.flags.isTextField) {
925 traits = UIAccessibilityTraitStaticText;
933 @property(nonatomic, weak) UIView* platformView;
938 - (instancetype)initWithBridge:(
fml::WeakPtr<
flutter::AccessibilityBridgeIos>)bridge
942 _platformView = platformView;
943 [platformView setFlutterAccessibilityContainer:self];
949 return self.platformView;
957 #pragma mark - initializers
959 - (instancetype)initWithSemanticsObject:(
SemanticsObject*)semanticsObject {
960 FML_DCHECK(semanticsObject) <<
"semanticsObject must be set";
962 if (!accessibility_bridge) {
969 UIView* accessibilityContainer =
971 self = [
super initWithAccessibilityContainer:accessibilityContainer];
974 _semanticsObject = semanticsObject;
980 #pragma mark - UIAccessibilityContainer overrides
982 - (NSInteger)accessibilityElementCount {
983 return self.semanticsObject.
children.count + 1;
986 - (nullable id)accessibilityElementAtIndex:(NSInteger)index {
987 if (index < 0 || index >= [
self accessibilityElementCount]) {
991 return self.semanticsObject.nativeAccessibility;
996 if ([child hasChildren]) {
997 return child.accessibilityContainer;
1002 - (NSInteger)indexOfAccessibilityElement:(
id)element {
1007 NSArray<SemanticsObject*>* children =
self.semanticsObject.children;
1008 for (
size_t i = 0; i < [children count]; i++) {
1018 #pragma mark - UIAccessibilityElement protocol
1020 - (BOOL)isAccessibilityElement {
1024 - (CGRect)accessibilityFrame {
1032 UIScreen* screen =
self.semanticsObject.
bridgeView.window.windowScene.screen;
1033 return (screen ?: UIScreen.mainScreen).bounds;
1036 - (id)accessibilityContainer {
1037 return ([
self.semanticsObject uid] ==
kRootNodeId)
1039 :
self.semanticsObject.parent.accessibilityContainer;
1042 #pragma mark - UIAccessibilityAction overrides
1044 - (BOOL)accessibilityScroll:(UIAccessibilityScrollDirection)direction {
1045 return [
self.semanticsObject accessibilityScroll:direction];
constexpr NS_ASSUME_NONNULL_BEGIN int32_t kRootNodeId
constexpr float kScrollExtentMaxForInf
NSMutableArray< SemanticsObject * > * _children
Interface that represents an accessibility bridge for iOS.
virtual void DispatchSemanticsAction(int32_t id, flutter::SemanticsAction action)=0
virtual void AccessibilityObjectDidLoseFocus(int32_t id)=0
virtual void AccessibilityObjectDidBecomeFocused(int32_t id)=0
virtual UIView * ViewIfLoaded() const =0
virtual UIView * AccessibilityElementInitializationContainer() const =0
virtual NSString * GetDefaultLocale()=0
void accessibilityBridgeDidChangeView()
NSArray< SemanticsObject * > * children
nullable UIView * bridgeView()
void accessibilityBridgeDidFinishUpdate()
nullable flutter::AccessibilityBridgeIos * bridge()
flutter::SemanticsNode node
CGRect ConvertRectToGlobal(SemanticsObject *reference, CGRect local_rect)
flutter::SemanticsAction GetSemanticsActionForScrollDirection(UIAccessibilityScrollDirection direction)
CGPoint ConvertPointToGlobal(SemanticsObject *reference, CGPoint local_point)
SkM44 GetGlobalTransform(SemanticsObject *reference)
SkPoint ApplyTransform(SkPoint &point, const SkM44 &transform)