FlutterSemanticsObject Class Reference

#import <SemanticsObject.h>

Inheritance diagram for FlutterSemanticsObject:

Instance Methods
(instancetype)	- initWithBridge:uid: [implementation]
(UIAccessibilityTraits)	- accessibilityTraits [implementation]
Instance Methods inherited from SemanticsObject
(BOOL)	- isAccessibilityBridgeAlive
(void)	- setSemanticsNode:
(void)	- replaceChildAtIndex:withChild:
(BOOL)	- nodeWillCauseLayoutChange:
(BOOL)	- nodeWillCauseScroll:
(BOOL)	- nodeShouldTriggerAnnouncement:
(void)	- collectRoutes:
(NSString *)	- routeName
(BOOL)	- onCustomAccessibilityAction:
(void)	- accessibilityBridgeDidFinishUpdate
((unavailable("Use initWithBridge instead")	- __attribute__
(instancetype)	- initWithBridge:uid:
(void)	- dealloc [implementation]
(void)	- setChildren: [implementation]
(void)	- setChildrenInHitTestOrder: [implementation]
(NSAttributedString *)	- createAttributedStringFromString:withAttributes: [implementation]
(void)	- showOnScreen [implementation]
(BOOL)	- isAccessibilityElement [implementation]
(bool)	- isFocusable [implementation]
(NSString *)	- accessibilityIdentifier [implementation]
(NSString *)	- accessibilityLabel [implementation]
(bool)	- containsPoint: [implementation]
(id)	- search: [implementation]
(id)	- _accessibilityHitTest:withEvent: [implementation]
(BOOL)	- accessibilityScrollToVisible [implementation]
(BOOL)	- accessibilityScrollToVisibleWithChild: [implementation]
(NSAttributedString *)	- accessibilityAttributedLabel [implementation]
(NSString *)	- accessibilityHint [implementation]
(NSAttributedString *)	- accessibilityAttributedHint [implementation]
(NSString *)	- accessibilityValue [implementation]
(NSAttributedString *)	- accessibilityAttributedValue [implementation]
(CGRect)	- accessibilityFrame [implementation]
(CGRect)	- globalRect [implementation]
(void)	- setAccessibilityContainer: [implementation]
(id)	- accessibilityContainer [implementation]
(BOOL)	- accessibilityActivate [implementation]
(void)	- accessibilityIncrement [implementation]
(void)	- accessibilityDecrement [implementation]
(BOOL)	- accessibilityScroll: [implementation]
(BOOL)	- accessibilityPerformEscape [implementation]
(void)	- accessibilityElementDidBecomeFocused [implementation]
(void)	- accessibilityElementDidLoseFocus [implementation]

Additional Inherited Members
Properties inherited from SemanticsObject
int32_t	uid
SemanticsObject *	parent
fml::WeakPtr< flutter::AccessibilityBridgeIos >	bridge
flutter::SemanticsNode	node
BOOL	hasChildren
NSArray< SemanticsObject * > *	children
NSArray< SemanticsObject * > *	childrenInHitTestOrder
id	nativeAccessibility
SemanticsObjectContainer *	container [implementation]

Detailed Description

The default implementation of SemanticsObject for most accessibility elements in the iOS accessibility tree.

Use this implementation for nodes that do not need to be expressed via UIKit-specific protocols (it only implements NSObject).

See also:

• TextInputSemanticsObject, which implements UITextInput protocol to expose editable text widgets to a11y.

Definition at line 154 of file SemanticsObject.h.

Method Documentation

accessibilityTraits

- (UIAccessibilityTraits) accessibilityTraits

implementation

Definition at line 255 of file SemanticsObject.mm.

                                             {
  UIAccessibilityTraits traits = UIAccessibilityTraitNone;
  if (self.node.HasAction(flutter::SemanticsAction::kIncrease) ||
      self.node.HasAction(flutter::SemanticsAction::kDecrease)) {
    traits |= UIAccessibilityTraitAdjustable;
  }
  // This should also capture radio buttons.
  if (self.node.HasFlag(flutter::SemanticsFlags::kHasToggledState) ||
      self.node.HasFlag(flutter::SemanticsFlags::kHasCheckedState)) {
    traits |= UIAccessibilityTraitButton;
  }
  if (self.node.HasFlag(flutter::SemanticsFlags::kIsSelected)) {
    traits |= UIAccessibilityTraitSelected;
  }
  if (self.node.HasFlag(flutter::SemanticsFlags::kIsButton)) {
    traits |= UIAccessibilityTraitButton;
  }
  if (self.node.HasFlag(flutter::SemanticsFlags::kHasEnabledState) &&
      !self.node.HasFlag(flutter::SemanticsFlags::kIsEnabled)) {
    traits |= UIAccessibilityTraitNotEnabled;
  }
  if (self.node.HasFlag(flutter::SemanticsFlags::kIsHeader)) {
    traits |= UIAccessibilityTraitHeader;
  }
  if (self.node.HasFlag(flutter::SemanticsFlags::kIsImage)) {
    traits |= UIAccessibilityTraitImage;
  }
  if (self.node.HasFlag(flutter::SemanticsFlags::kIsLiveRegion)) {
    traits |= UIAccessibilityTraitUpdatesFrequently;
  }
  if (self.node.HasFlag(flutter::SemanticsFlags::kIsLink)) {
    traits |= UIAccessibilityTraitLink;
  }
  if (traits == UIAccessibilityTraitNone && ![self hasChildren] &&
      self.accessibilityLabel.length != 0 &&
      !self.node.HasFlag(flutter::SemanticsFlags::kIsTextField)) {
    traits = UIAccessibilityTraitStaticText;
  }
  return traits;
}

initWithBridge:uid:

- (instancetype) initWithBridge: (fml::WeakPtr<flutter::AccessibilityBridgeIos>)  bridge uid: (int32_t)  uid

implementation

Reimplemented from SemanticsObject.

Definition at line 255 of file SemanticsObject.mm.

                              :(fml::WeakPtr<flutter::AccessibilityBridgeIos>)bridge
                           uid:(int32_t)uid {
  self = [super initWithBridge:bridge uid:uid];
  return self;
}

---

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

• shell/platform/darwin/ios/framework/Source/SemanticsObject.h
• shell/platform/darwin/ios/framework/Source/SemanticsObject.mm