FocusEnvironment

A set of methods that define the focus behavior for a branch of the view hierarchy.

public protocol FocusEnvironment: AnyObject 

Inheritance

AnyObject

public func soundIdentifierForFocusUpdate(in context: FocusUpdateContext)
      -> FocusSoundIdentifier? 

public var focusGroupIdentifier: String? 

Submits a request to the focus engine for a focus update in this environment.

func setNeedsFocusUpdate()

Tells the focus engine to force a focus update immediately.

func updateFocusIfNeeded()

Returns a boolean value indicating whether the focus engine should allow the focus update described by the specified context to occur.

func shouldUpdateFocus(in context: FocusUpdateContext) -> Bool

Called immediately after the system updates the focus to a new view.

func didUpdateFocus(in context: FocusUpdateContext,
                      with coordinator: FocusAnimationCoordinator)

An array of focus environments, ordered by priority, to which this environment prefers focus to be directed during a focus update.

var preferredFocusEnvironments: [FocusEnvironment] 

Asks the delegate for the identifier of the sound to play when the object gains focus.

func soundIdentifierForFocusUpdate(in context: FocusUpdateContext)
      -> FocusSoundIdentifier?

Returns a boolean value indicating whether the focus environment contains the specified environment.

func contains(_ environment: FocusEnvironment) -> Bool

The parent focus environment for this environment.

var parentFocusEnvironment: FocusEnvironment? 

The container for the child focus items in this focus environment.

var focusItemContainer: FocusItemContainer? 

var focusGroupIdentifier: String? 