Trait UIFocusEnvironment

Source

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

Available on crate feature UIFocus only.

Expand description

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

Provided Methods§

Source

unsafe 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’.

Source

unsafe 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.

Source

unsafe 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.

Source

unsafe 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];

Source

unsafe 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];.

Source

unsafe fn shouldUpdateFocusInContext( &self, context: &UIFocusUpdateContext, ) -> bool
where Self: Sized + Message,

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

Source

unsafe 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.

Source

unsafe 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.

Source

unsafe fn preferredFocusedView(&self) -> Option<Retained<UIView>>
where Self: Sized + Message,

👎Deprecated

Available on crate features UIResponder and UIView only.

Source

unsafe 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 UIFocusEnvironmentCopy item path

Provided Methods§

unsafe fn preferredFocusEnvironments( &self, ) -> Retained<NSArray<ProtocolObject<dyn UIFocusEnvironment>>>where Self: Sized + Message,

unsafe fn parentFocusEnvironment( &self, ) -> Option<Retained<ProtocolObject<dyn UIFocusEnvironment>>>where Self: Sized + Message,

unsafe fn focusItemContainer( &self, ) -> Option<Retained<ProtocolObject<dyn UIFocusItemContainer>>>where Self: Sized + Message,

unsafe fn setNeedsFocusUpdate(&self)where Self: Sized + Message,

unsafe fn updateFocusIfNeeded(&self)where Self: Sized + Message,

unsafe fn shouldUpdateFocusInContext( &self, context: &UIFocusUpdateContext, ) -> boolwhere Self: Sized + Message,

unsafe fn didUpdateFocusInContext_withAnimationCoordinator( &self, context: &UIFocusUpdateContext, coordinator: &UIFocusAnimationCoordinator, )where Self: Sized + Message,

unsafe fn soundIdentifierForFocusUpdateInContext( &self, context: &UIFocusUpdateContext, ) -> Option<Retained<UIFocusSoundIdentifier>>where Self: Sized + Message,

unsafe fn preferredFocusedView(&self) -> Option<Retained<UIView>>where Self: Sized + Message,

unsafe fn focusGroupIdentifier(&self) -> Option<Retained<NSString>>where Self: Sized + Message,

Trait Implementations§

impl ProtocolType for dyn UIFocusEnvironment

const NAME: &'static str = "UIFocusEnvironment"

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

impl<T> ImplementedBy<T> for dyn UIFocusEnvironmentwhere T: ?Sized + Message + UIFocusEnvironment,

Implementations on Foreign Types§

impl<T> UIFocusEnvironment for ProtocolObject<T>where T: ?Sized + UIFocusEnvironment,

Implementors§

impl UIFocusEnvironment for UIActionSheet

impl UIFocusEnvironment for UIActivityIndicatorView

impl UIFocusEnvironment for UIActivityViewController

impl UIFocusEnvironment for UIAlertController

impl UIFocusEnvironment for UIAlertView

impl UIFocusEnvironment for UIButton

impl UIFocusEnvironment for UICalendarView

impl UIFocusEnvironment for UICloudSharingController

impl UIFocusEnvironment for UICollectionReusableView

impl UIFocusEnvironment for UICollectionView

impl UIFocusEnvironment for UICollectionViewCell

impl UIFocusEnvironment for UICollectionViewController

impl UIFocusEnvironment for UICollectionViewListCell

impl UIFocusEnvironment for UIColorPickerViewController

impl UIFocusEnvironment for UIColorWell

impl UIFocusEnvironment for UIContentUnavailableView

impl UIFocusEnvironment for UIControl

impl UIFocusEnvironment for UIDatePicker

impl UIFocusEnvironment for UIDocumentBrowserViewController

impl UIFocusEnvironment for UIDocumentMenuViewController

impl UIFocusEnvironment for UIDocumentPickerExtensionViewController

impl UIFocusEnvironment for UIDocumentPickerViewController

impl UIFocusEnvironment for UIDocumentViewController

impl UIFocusEnvironment for UIEventAttributionView

impl UIFocusEnvironment for UIFontPickerViewController

impl UIFocusEnvironment for UIImagePickerController

impl UIFocusEnvironment for UIImageView

impl UIFocusEnvironment for UIInputView

impl UIFocusEnvironment for UIInputViewController

impl UIFocusEnvironment for UILabel

impl UIFocusEnvironment for UIListContentView

impl UIFocusEnvironment for UINavigationBar

impl UIFocusEnvironment for UINavigationController

impl UIFocusEnvironment for UIPageControl

impl UIFocusEnvironment for UIPageViewController

impl UIFocusEnvironment for UIPasteControl

impl UIFocusEnvironment for UIPickerView

impl UIFocusEnvironment for UIPopoverBackgroundView

impl UIFocusEnvironment for UIPopoverPresentationController

impl UIFocusEnvironment for UIPresentationController

impl UIFocusEnvironment for UIProgressView

impl UIFocusEnvironment for UIReferenceLibraryViewController

impl UIFocusEnvironment for UIRefreshControl

impl UIFocusEnvironment for UIScrollView

impl UIFocusEnvironment for UISearchBar

impl UIFocusEnvironment for UISearchContainerViewController

impl UIFocusEnvironment for UISearchController

impl UIFocusEnvironment for UISearchTextField

impl UIFocusEnvironment for UISegmentedControl

impl UIFocusEnvironment for UISheetPresentationController

impl UIFocusEnvironment for UISlider

impl UIFocusEnvironment for UISplitViewController

impl UIFocusEnvironment for UIStackView

impl UIFocusEnvironment for UIStandardTextCursorView

impl UIFocusEnvironment for UIStepper

impl UIFocusEnvironment for UISwitch

impl UIFocusEnvironment for UITabBar

impl UIFocusEnvironment for UITabBarController

impl UIFocusEnvironment for UITableView

impl UIFocusEnvironment for UITableViewCell

Trait UIFocusEnvironment

unsafe fn preferredFocusEnvironments( &self, ) -> Retained<NSArray<ProtocolObject<dyn UIFocusEnvironment>>>
where Self: Sized + Message,

unsafe fn parentFocusEnvironment( &self, ) -> Option<Retained<ProtocolObject<dyn UIFocusEnvironment>>>
where Self: Sized + Message,

unsafe fn focusItemContainer( &self, ) -> Option<Retained<ProtocolObject<dyn UIFocusItemContainer>>>
where Self: Sized + Message,

unsafe fn setNeedsFocusUpdate(&self)
where Self: Sized + Message,

unsafe fn updateFocusIfNeeded(&self)
where Self: Sized + Message,

unsafe fn shouldUpdateFocusInContext( &self, context: &UIFocusUpdateContext, ) -> bool
where Self: Sized + Message,

unsafe fn didUpdateFocusInContext_withAnimationCoordinator( &self, context: &UIFocusUpdateContext, coordinator: &UIFocusAnimationCoordinator, )
where Self: Sized + Message,

unsafe fn soundIdentifierForFocusUpdateInContext( &self, context: &UIFocusUpdateContext, ) -> Option<Retained<UIFocusSoundIdentifier>>
where Self: Sized + Message,

unsafe fn preferredFocusedView(&self) -> Option<Retained<UIView>>
where Self: Sized + Message,

unsafe fn focusGroupIdentifier(&self) -> Option<Retained<NSString>>
where Self: Sized + Message,

impl<T> ImplementedBy<T> for dyn UIFocusEnvironment
where T: ?Sized + Message + UIFocusEnvironment,

impl<T> UIFocusEnvironment for ProtocolObject<T>
where T: ?Sized + UIFocusEnvironment,