flutter::SemanticsUpdateBuilder Class Reference

#include <semantics_update_builder.h>

Inheritance diagram for flutter::SemanticsUpdateBuilder:

Public Member Functions
	~SemanticsUpdateBuilder () override
void	updateNode (int id, Dart_Handle flags, int actions, int maxValueLength, int currentValueLength, int textSelectionBase, int textSelectionExtent, int platformViewId, int scrollChildren, int scrollIndex, int traversalParent, double scrollPosition, double scrollExtentMax, double scrollExtentMin, double left, double top, double right, double bottom, std::string identifier, std::string label, const std::vector< NativeStringAttribute * > &labelAttributes, std::string value, const std::vector< NativeStringAttribute * > &valueAttributes, std::string increasedValue, const std::vector< NativeStringAttribute * > &increasedValueAttributes, std::string decreasedValue, const std::vector< NativeStringAttribute * > &decreasedValueAttributes, std::string hint, const std::vector< NativeStringAttribute * > &hintAttributes, std::string tooltip, int textDirection, const tonic::Float64List &transform, const tonic::Float64List &hitTestTransform, const tonic::Int32List &childrenInTraversalOrder, const tonic::Int32List &childrenInHitTestOrder, const tonic::Int32List &customAccessibilityActions, int headingLevel, std::string linkUrl, int role, const std::vector< std::string > &controlsNodes, int validationResult, int hitTestBehavior, int inputType, std::string locale)
void	updateCustomAction (int id, std::string label, std::string hint, int overrideId)
void	build (Dart_Handle semantics_update_handle)
Public Member Functions inherited from flutter::RefCountedDartWrappable< SemanticsUpdateBuilder >
virtual void	RetainDartWrappableReference () const override
virtual void	ReleaseDartWrappableReference () const override
Public Member Functions inherited from fml::RefCountedThreadSafe< T >
void	Release () const
Public Member Functions inherited from fml::internal::RefCountedThreadSafeBase
void	AddRef () const
bool	HasOneRef () const
void	AssertHasOneRef () const
Public Member Functions inherited from tonic::DartWrappable
	DartWrappable ()
virtual const DartWrapperInfo &	GetDartWrapperInfo () const =0
Dart_Handle	CreateDartWrapper (DartState *dart_state)
void	AssociateWithDartWrapper (Dart_Handle wrappable)
void	ClearDartWrapper ()
Dart_WeakPersistentHandle	dart_wrapper () const

Static Public Member Functions
static void	Create (Dart_Handle wrapper)

Additional Inherited Members
Public Types inherited from tonic::DartWrappable
enum	DartNativeFields {   kPeerIndex ,   kNumberOfNativeFields }
Protected Member Functions inherited from fml::RefCountedThreadSafe< T >
	RefCountedThreadSafe ()
	~RefCountedThreadSafe ()
Protected Member Functions inherited from fml::internal::RefCountedThreadSafeBase
	RefCountedThreadSafeBase ()
	~RefCountedThreadSafeBase ()
bool	Release () const
void	Adopt ()
Protected Member Functions inherited from tonic::DartWrappable
virtual	~DartWrappable ()
Static Protected Member Functions inherited from tonic::DartWrappable
static Dart_PersistentHandle	GetTypeForWrapper (tonic::DartState *dart_state, const tonic::DartWrapperInfo &wrapper_info)

Detailed Description

Definition at line 18 of file semantics_update_builder.h.

Constructor & Destructor Documentation

~SemanticsUpdateBuilder()

flutter::SemanticsUpdateBuilder::~SemanticsUpdateBuilder ( )

overridedefault

References build().

Member Function Documentation

build()

void flutter::SemanticsUpdateBuilder::build

(

Dart_Handle

semantics_update_handle

)

Definition at line 156 of file semantics_update_builder.cc.

                                                                      {
  SemanticsUpdate::create(semantics_update_handle, std::move(nodes_),
                          std::move(actions_));
  ClearDartWrapper();
}

References tonic::DartWrappable::ClearDartWrapper(), and flutter::SemanticsUpdate::create().

Referenced by ~SemanticsUpdateBuilder().

Create()

static void flutter::SemanticsUpdateBuilder::Create ( Dart_Handle  wrapper )

inlinestatic

Definition at line 24 of file semantics_update_builder.h.

                                          {
    UIDartState::ThrowIfUIOperationsProhibited();
    auto res = fml::MakeRefCounted<SemanticsUpdateBuilder>();
    res->AssociateWithDartWrapper(wrapper);
  }

References flutter::UIDartState::ThrowIfUIOperationsProhibited().

updateCustomAction()

void flutter::SemanticsUpdateBuilder::updateCustomAction	(	int	id,
		std::string	label,
		std::string	hint,
		int	overrideId
	)

Definition at line 144 of file semantics_update_builder.cc.

                                                                {
  CustomAccessibilityAction action;
  action.id = id;
  action.overrideId = overrideId;
  action.label = std::move(label);
  action.hint = std::move(hint);
  actions_[id] = action;
}

References action, id, and flutter::CustomAccessibilityAction::id.

updateNode()

void flutter::SemanticsUpdateBuilder::updateNode	(	int	id,
		Dart_Handle	flags,
		int	actions,
		int	maxValueLength,
		int	currentValueLength,
		int	textSelectionBase,
		int	textSelectionExtent,
		int	platformViewId,
		int	scrollChildren,
		int	scrollIndex,
		int	traversalParent,
		double	scrollPosition,
		double	scrollExtentMax,
		double	scrollExtentMin,
		double	left,
		double	top,
		double	right,
		double	bottom,
		std::string	identifier,
		std::string	label,
		const std::vector< NativeStringAttribute * > &	labelAttributes,
		std::string	value,
		const std::vector< NativeStringAttribute * > &	valueAttributes,
		std::string	increasedValue,
		const std::vector< NativeStringAttribute * > &	increasedValueAttributes,
		std::string	decreasedValue,
		const std::vector< NativeStringAttribute * > &	decreasedValueAttributes,
		std::string	hint,
		const std::vector< NativeStringAttribute * > &	hintAttributes,
		std::string	tooltip,
		int	textDirection,
		const tonic::Float64List &	transform,
		const tonic::Float64List &	hitTestTransform,
		const tonic::Int32List &	childrenInTraversalOrder,
		const tonic::Int32List &	childrenInHitTestOrder,
		const tonic::Int32List &	customAccessibilityActions,
		int	headingLevel,
		std::string	linkUrl,
		int	role,
		const std::vector< std::string > &	controlsNodes,
		int	validationResult,
		int	hitTestBehavior,
		int	inputType,
		std::string	locale
	)

Definition at line 33 of file semantics_update_builder.cc.

                      {
  FML_CHECK(scrollChildren == 0 ||
            (scrollChildren > 0 && childrenInHitTestOrder.data()))
      << "Semantics update contained scrollChildren but did not have "
         "childrenInHitTestOrder";
  SemanticsNode node;
  node.id = id;
  auto* flags_object =
      tonic::DartConverter<flutter::NativeSemanticsFlags*>::FromDart(flags);
  node.flags = flags_object->GetFlags();
  node.actions = actions;
  node.maxValueLength = maxValueLength;
  node.currentValueLength = currentValueLength;
  node.textSelectionBase = textSelectionBase;
  node.textSelectionExtent = textSelectionExtent;
  node.platformViewId = platformViewId;
  node.scrollChildren = scrollChildren;
  node.scrollIndex = scrollIndex;
  node.traversalParent = traversalParent;
  node.scrollPosition = scrollPosition;
  node.scrollExtentMax = scrollExtentMax;
  node.scrollExtentMin = scrollExtentMin;
  node.rect = SkRect::MakeLTRB(SafeNarrow(left), SafeNarrow(top),
                               SafeNarrow(right), SafeNarrow(bottom));
  node.identifier = std::move(identifier);
  node.label = std::move(label);
  pushStringAttributes(node.labelAttributes, labelAttributes);
  node.value = std::move(value);
  pushStringAttributes(node.valueAttributes, valueAttributes);
  node.increasedValue = std::move(increasedValue);
  pushStringAttributes(node.increasedValueAttributes, increasedValueAttributes);
  node.decreasedValue = std::move(decreasedValue);
  pushStringAttributes(node.decreasedValueAttributes, decreasedValueAttributes);
  node.hint = std::move(hint);
  pushStringAttributes(node.hintAttributes, hintAttributes);
  node.tooltip = std::move(tooltip);
  node.textDirection = textDirection;
  SkScalar scalarTransform[16];
  for (int i = 0; i < 16; ++i) {
    scalarTransform[i] = SafeNarrow(transform.data()[i]);
  }
  node.transform = SkM44::ColMajor(scalarTransform);
  SkScalar scalarHitTestTransform[16];
  for (int i = 0; i < 16; ++i) {
    scalarHitTestTransform[i] = SafeNarrow(hitTestTransform.data()[i]);
  }
  node.hitTestTransform = SkM44::ColMajor(scalarHitTestTransform);
  node.childrenInTraversalOrder =
      std::vector<int32_t>(childrenInTraversalOrder.data(),
                           childrenInTraversalOrder.data() +
                               childrenInTraversalOrder.num_elements());
  node.childrenInHitTestOrder = std::vector<int32_t>(
      childrenInHitTestOrder.data(),
      childrenInHitTestOrder.data() + childrenInHitTestOrder.num_elements());
  node.customAccessibilityActions = std::vector<int32_t>(
      localContextActions.data(),
      localContextActions.data() + localContextActions.num_elements());
  node.headingLevel = headingLevel;
  node.linkUrl = std::move(linkUrl);
  node.role = static_cast<SemanticsRole>(role);
  node.validationResult =
      static_cast<SemanticsValidationResult>(validationResult);
  node.locale = std::move(locale);
 
  nodes_[id] = node;
}

References flutter::SemanticsNode::actions, flutter::SemanticsNode::childrenInHitTestOrder, flutter::SemanticsNode::childrenInTraversalOrder, flutter::SemanticsNode::currentValueLength, flutter::SemanticsNode::customAccessibilityActions, flutter::SemanticsNode::decreasedValue, flutter::SemanticsNode::decreasedValueAttributes, flutter::SemanticsNode::flags, FML_CHECK, flutter::SemanticsNode::headingLevel, flutter::SemanticsNode::hint, flutter::SemanticsNode::hintAttributes, flutter::SemanticsNode::hitTestTransform, i, id, flutter::SemanticsNode::id, flutter::SemanticsNode::identifier, flutter::SemanticsNode::increasedValue, flutter::SemanticsNode::increasedValueAttributes, flutter::SemanticsNode::label, flutter::SemanticsNode::labelAttributes, flutter::SemanticsNode::linkUrl, flutter::SemanticsNode::locale, flutter::SemanticsNode::maxValueLength, flutter::SemanticsNode::platformViewId, flutter::pushStringAttributes(), flutter::SemanticsNode::rect, flutter::SemanticsNode::role, flutter::SafeNarrow(), flutter::SemanticsNode::scrollChildren, flutter::SemanticsNode::scrollExtentMax, flutter::SemanticsNode::scrollExtentMin, flutter::SemanticsNode::scrollIndex, flutter::SemanticsNode::scrollPosition, flutter::SemanticsNode::textDirection, flutter::SemanticsNode::textSelectionBase, flutter::SemanticsNode::textSelectionExtent, flutter::SemanticsNode::tooltip, transform, flutter::SemanticsNode::transform, flutter::SemanticsNode::traversalParent, flutter::SemanticsNode::validationResult, value, flutter::SemanticsNode::value, and flutter::SemanticsNode::valueAttributes.

---

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

• lib/ui/semantics/semantics_update_builder.h
• lib/ui/semantics/semantics_update_builder.cc