Trait UIFocusEnvironment 

pub unsafe trait UIFocusEnvironment: NSObjectProtocol + MainThreadOnly {
    // Provided methods
    fn preferredFocusEnvironments(
        &self,
    ) -> Retained<NSArray<ProtocolObject<dyn UIFocusEnvironment>>>
       where Self: Sized + Message { ... }
    fn parentFocusEnvironment(
        &self,
    ) -> Option<Retained<ProtocolObject<dyn UIFocusEnvironment>>>
       where Self: Sized + Message { ... }
    fn focusItemContainer(
        &self,
    ) -> Option<Retained<ProtocolObject<dyn UIFocusItemContainer>>>
       where Self: Sized + Message { ... }
    fn setNeedsFocusUpdate(&self)
       where Self: Sized + Message { ... }
    fn updateFocusIfNeeded(&self)
       where Self: Sized + Message { ... }
    fn shouldUpdateFocusInContext(&self, context: &UIFocusUpdateContext) -> bool
       where Self: Sized + Message { ... }
    fn didUpdateFocusInContext_withAnimationCoordinator(
        &self,
        context: &UIFocusUpdateContext,
        coordinator: &UIFocusAnimationCoordinator,
    )
       where Self: Sized + Message { ... }
    fn soundIdentifierForFocusUpdateInContext(
        &self,
        context: &UIFocusUpdateContext,
    ) -> Option<Retained<UIFocusSoundIdentifier>>
       where Self: Sized + Message { ... }
    fn preferredFocusedView(&self) -> Option<Retained<UIView>>
       where Self: Sized + Message { ... }
    fn focusGroupIdentifier(&self) -> Option<Retained<NSString>>
       where Self: Sized + Message { ... }
}

Available on crate feature UIFocus only.

Objects conforming to UIFocusEnvironment influence and respond to focus behavior within a specific area of the screen that they control.

See also Apple’s documentation

Provided Methods

fn preferredFocusEnvironments( &self, ) -> Retained<NSArray<ProtocolObject<dyn UIFocusEnvironment>>>

where Self: Sized + Message,

The preferred focus environments define where to search for the default focused item in an environment, such as when focus updates programmatically. Starting from the target environment, each preferred focus environment is recursively searched in the order of the array until an eligible, focusable item is found. Preferred focus environments can include focusable and non-focusable items, in addition to non-item environments. Returning an empty array is equivalent to returning an array containing only ‘self’.

fn parentFocusEnvironment( &self, ) -> Option<Retained<ProtocolObject<dyn UIFocusEnvironment>>>

where Self: Sized + Message,

The parent focus environment of this environment, or nil if no parent exists. NOTE: If you implement this method, you must return a non-nil value for parent focus environment, otherwise your focus environment will not participate in focus interactions.

fn focusItemContainer( &self, ) -> Option<Retained<ProtocolObject<dyn UIFocusItemContainer>>>

where Self: Sized + Message,

The container of any child focus items in this focus environment, or nil if no container exists.

fn setNeedsFocusUpdate(&self)

where Self: Sized + Message,

Marks this environment as needing a focus update, which if accepted will attempt to reset focus to this environment, or one of its preferred focus environments, on the next update cycle. If this environment does not currently contain the focused item, then calling this method has no effect. If a parent of this environment is also requesting focus, then this environment’s request is rejected in favor of the parent’s. NOTE: If you provide your own implementation, it must call [[UIFocusSystem focusSystemForEnvironment:self] requestFocusUpdateToEnvironment:self];

fn updateFocusIfNeeded(&self)

where Self: Sized + Message,

Forces focus to be updated immediately. If there is an environment that has requested a focus update via -setNeedsFocusUpdate, and the request was accepted, then focus will be updated to that environment or one of its preferred focus environments. NOTE: If you provide your own implementation, it must call [[UIFocusSystem focusSystemForEnvironment:self] updateFocusIfNeeded];.

fn shouldUpdateFocusInContext(&self, context: &UIFocusUpdateContext) -> bool

where Self: Sized + Message,

Asks whether the system should allow a focus update to occur.

fn didUpdateFocusInContext_withAnimationCoordinator( &self, context: &UIFocusUpdateContext, coordinator: &UIFocusAnimationCoordinator, )

where Self: Sized + Message,

Available on crate feature UIFocusAnimationCoordinator only.

Called when the screen’s focused item has been updated to a new item. Use the animation coordinator to schedule focus-related animations in response to the update.

fn soundIdentifierForFocusUpdateInContext( &self, context: &UIFocusUpdateContext, ) -> Option<Retained<UIFocusSoundIdentifier>>

where Self: Sized + Message,

Specifies an identifier corresponding to a sound that should be played for a focus update. Return UIFocusSoundIdentifierNone to opt out of sounds, UIFocusSoundIdentifierDefault for the system default sounds, a previously registered identifier for a custom sound, or nil to defer the decision to the parent.

fn preferredFocusedView(&self) -> Option<Retained<UIView>>

where Self: Sized + Message,

👎Deprecated

Available on crate features UIResponder and UIView only.

fn focusGroupIdentifier(&self) -> Option<Retained<NSString>>

where Self: Sized + Message,

The identifier of the focus group that this view belongs to. If this is nil, subviews inherit their superview’s focus group.

Trait Implementations

impl ProtocolType for dyn UIFocusEnvironment

const NAME: &'static str = "UIFocusEnvironment"

The name of the Objective-C protocol that this type represents.

fn protocol() -> Option<&'static AnyProtocol>

Get a reference to the Objective-C protocol object that this type represents.

impl<T> ImplementedBy<T> for dyn UIFocusEnvironment

where T: ?Sized + Message + UIFocusEnvironment,

Implementations on Foreign Types

impl<T> UIFocusEnvironment for ProtocolObject<T>

where T: ?Sized + UIFocusEnvironment,

Implementors

impl UIFocusEnvironment for UIActionSheet

Available on crate feature UIActionSheet only.

impl UIFocusEnvironment for UIActivityIndicatorView

Available on crate feature UIActivityIndicatorView only.

impl UIFocusEnvironment for UIActivityViewController

Available on crate feature UIActivityViewController only.

impl UIFocusEnvironment for UIAlertController

Available on crate feature UIAlertController only.

impl UIFocusEnvironment for UIAlertView

Available on crate feature UIAlertView only.

impl UIFocusEnvironment for UIBackgroundExtensionView

Available on crate feature UIBackgroundExtensionView only.

impl UIFocusEnvironment for UIButton

Available on crate feature UIButton only.

impl UIFocusEnvironment for UICalendarView

Available on crate feature UICalendarView only.

impl UIFocusEnvironment for UICloudSharingController

Available on crate feature UICloudSharingController only.

impl UIFocusEnvironment for UICollectionReusableView

Available on crate feature UICollectionViewCell only.

impl UIFocusEnvironment for UICollectionView

Available on crate feature UICollectionView only.

impl UIFocusEnvironment for UICollectionViewCell

Available on crate feature UICollectionViewCell only.

impl UIFocusEnvironment for UICollectionViewController

Available on crate feature UICollectionViewController only.

impl UIFocusEnvironment for UICollectionViewListCell

Available on crate feature UICollectionViewListCell only.

impl UIFocusEnvironment for UIColorPickerViewController

Available on crate feature UIColorPickerViewController only.

impl UIFocusEnvironment for UIColorWell

Available on crate feature UIColorWell only.

impl UIFocusEnvironment for UIContentUnavailableView

Available on crate feature UIContentUnavailableView only.

impl UIFocusEnvironment for UIControl

Available on crate feature UIControl only.

impl UIFocusEnvironment for UIDatePicker

Available on crate feature UIDatePicker only.

impl UIFocusEnvironment for UIDocumentBrowserViewController

Available on crate feature UIDocumentBrowserViewController only.

impl UIFocusEnvironment for UIDocumentMenuViewController

Available on crate feature UIDocumentMenuViewController only.

impl UIFocusEnvironment for UIDocumentPickerExtensionViewController

Available on crate feature UIDocumentPickerExtensionViewController only.

impl UIFocusEnvironment for UIDocumentPickerViewController

Available on crate feature UIDocumentPickerViewController only.

impl UIFocusEnvironment for UIDocumentViewController

Available on crate feature UIDocumentViewController only.

impl UIFocusEnvironment for UIEventAttributionView

Available on crate feature UIEventAttributionView only.

impl UIFocusEnvironment for UIFontPickerViewController

Available on crate feature UIFontPickerViewController only.

impl UIFocusEnvironment for UIImagePickerController

Available on crate feature UIImagePickerController only.

impl UIFocusEnvironment for UIImageView

Available on crate feature UIImageView only.

impl UIFocusEnvironment for UIInputView

Available on crate feature UIInputView only.

impl UIFocusEnvironment for UIInputViewController

Available on crate feature UIInputViewController only.

impl UIFocusEnvironment for UILabel

Available on crate feature UILabel only.

impl UIFocusEnvironment for UIListContentView

Available on crate feature UIListContentConfiguration only.

impl UIFocusEnvironment for UINavigationBar

Available on crate feature UINavigationBar only.

impl UIFocusEnvironment for UINavigationController

Available on crate feature UINavigationController only.

impl UIFocusEnvironment for UIPageControl

Available on crate feature UIPageControl only.

impl UIFocusEnvironment for UIPageViewController

Available on crate feature UIPageViewController only.

impl UIFocusEnvironment for UIPasteControl

Available on crate feature UIPasteControl only.

impl UIFocusEnvironment for UIPickerView

Available on crate feature UIPickerView only.

impl UIFocusEnvironment for UIPopoverBackgroundView

Available on crate feature UIPopoverBackgroundView only.

impl UIFocusEnvironment for UIPopoverPresentationController

Available on crate feature UIPopoverPresentationController only.

impl UIFocusEnvironment for UIPresentationController

Available on crate feature UIPresentationController only.

impl UIFocusEnvironment for UIProgressView

Available on crate feature UIProgressView only.

impl UIFocusEnvironment for UIReferenceLibraryViewController

Available on crate feature UIReferenceLibraryViewController only.

impl UIFocusEnvironment for UIRefreshControl

Available on crate feature UIRefreshControl only.

impl UIFocusEnvironment for UIScrollView

Available on crate feature UIScrollView only.

impl UIFocusEnvironment for UISearchBar

Available on crate feature UISearchBar only.

impl UIFocusEnvironment for UISearchContainerViewController

Available on crate feature UISearchContainerViewController only.

impl UIFocusEnvironment for UISearchController

Available on crate feature UISearchController only.

impl UIFocusEnvironment for UISearchTextField

Available on crate feature UISearchTextField only.

impl UIFocusEnvironment for UISegmentedControl

Available on crate feature UISegmentedControl only.

impl UIFocusEnvironment for UISheetPresentationController

Available on crate feature UISheetPresentationController only.

impl UIFocusEnvironment for UISlider

Available on crate feature UISlider only.

impl UIFocusEnvironment for UISplitViewController

Available on crate feature UISplitViewController only.

impl UIFocusEnvironment for UIStackView

Available on crate feature UIStackView only.

impl UIFocusEnvironment for UIStandardTextCursorView

Available on crate feature UIStandardTextCursorView only.

impl UIFocusEnvironment for UIStepper

Available on crate feature UIStepper only.

impl UIFocusEnvironment for UISwitch

Available on crate feature UISwitch only.

impl UIFocusEnvironment for UITabBar

Available on crate feature UITabBar only.

impl UIFocusEnvironment for UITabBarController

Available on crate feature UITabBarController only.

impl UIFocusEnvironment for UITableView

Available on crate feature UITableView only.

impl UIFocusEnvironment for UITableViewCell

Available on crate feature UITableViewCell only.

impl UIFocusEnvironment for UITableViewController

Available on crate feature UITableViewController only.

impl UIFocusEnvironment for UITableViewHeaderFooterView

Available on crate feature UITableViewHeaderFooterView only.

impl UIFocusEnvironment for UITextField

Available on crate feature UITextField only.

impl UIFocusEnvironment for UITextFormattingViewController

Available on crate feature UITextFormattingViewController only.

impl UIFocusEnvironment for UITextView

Available on crate feature UITextView only.

impl UIFocusEnvironment for UIToolbar

Available on crate feature UIToolbar only.

impl UIFocusEnvironment for UIVideoEditorController

Available on crate feature UIVideoEditorController only.

impl UIFocusEnvironment for UIView

Available on crate feature UIView only.

impl UIFocusEnvironment for UIViewController

Available on crate feature UIViewController only.

impl UIFocusEnvironment for UIVisualEffectView

Available on crate feature UIVisualEffectView only.

impl UIFocusEnvironment for UIWebView

Available on crate feature UIWebView only.

impl UIFocusEnvironment for UIWindow

Available on crate feature UIWindow only.