Struct UISplitViewController 

pub struct UISplitViewController { /* private fields */ }

Available on crate features UIResponder and UISplitViewController and UIViewController only.

Apple’s documentation

Implementations

impl UISplitViewController

pub unsafe fn initWithCoder( this: Allocated<Self>, coder: &NSCoder, ) -> Option<Retained<Self>>

Safety

coder possibly has further requirements.

pub fn initWithNibName_bundle( this: Allocated<Self>, nib_name_or_nil: Option<&NSString>, nib_bundle_or_nil: Option<&NSBundle>, ) -> Retained<Self>

pub fn initWithStyle( this: Allocated<Self>, style: UISplitViewControllerStyle, ) -> Retained<Self>

pub fn style(&self) -> UISplitViewControllerStyle

pub fn delegate( &self, ) -> Option<Retained<ProtocolObject<dyn UISplitViewControllerDelegate>>>

pub fn setDelegate( &self, delegate: Option<&ProtocolObject<dyn UISplitViewControllerDelegate>>, )

Setter for delegate.

This is a weak property.

pub fn showsSecondaryOnlyButton(&self) -> bool

pub fn setShowsSecondaryOnlyButton(&self, shows_secondary_only_button: bool)

Setter for showsSecondaryOnlyButton.

pub fn preferredSplitBehavior(&self) -> UISplitViewControllerSplitBehavior

pub fn setPreferredSplitBehavior( &self, preferred_split_behavior: UISplitViewControllerSplitBehavior, )

Setter for preferredSplitBehavior.

pub fn splitBehavior(&self) -> UISplitViewControllerSplitBehavior

pub fn setViewController_forColumn( &self, vc: Option<&UIViewController>, column: UISplitViewControllerColumn, )

pub fn viewControllerForColumn( &self, column: UISplitViewControllerColumn, ) -> Option<Retained<UIViewController>>

pub fn hideColumn(&self, column: UISplitViewControllerColumn)

pub fn showColumn(&self, column: UISplitViewControllerColumn)

pub fn isShowingColumn(&self, column: UISplitViewControllerColumn) -> bool

pub fn viewControllers(&self) -> Retained<NSArray<UIViewController>>

pub fn setViewControllers(&self, view_controllers: &NSArray<UIViewController>)

Setter for viewControllers.

This is copied when set.

pub fn presentsWithGesture(&self) -> bool

pub fn setPresentsWithGesture(&self, presents_with_gesture: bool)

Setter for presentsWithGesture.

pub fn isCollapsed(&self) -> bool

pub fn preferredDisplayMode(&self) -> UISplitViewControllerDisplayMode

pub fn setPreferredDisplayMode( &self, preferred_display_mode: UISplitViewControllerDisplayMode, )

Setter for preferredDisplayMode.

pub fn displayMode(&self) -> UISplitViewControllerDisplayMode

pub fn displayModeButtonItem(&self) -> Retained<UIBarButtonItem>

Available on crate features UIBarButtonItem and UIBarItem only.

pub fn displayModeButtonVisibility( &self, ) -> UISplitViewControllerDisplayModeButtonVisibility

pub fn setDisplayModeButtonVisibility( &self, display_mode_button_visibility: UISplitViewControllerDisplayModeButtonVisibility, )

Setter for displayModeButtonVisibility.

pub fn preferredPrimaryColumnWidthFraction(&self) -> CGFloat

Available on crate feature objc2-core-foundation only.

pub fn setPreferredPrimaryColumnWidthFraction( &self, preferred_primary_column_width_fraction: CGFloat, )

Available on crate feature objc2-core-foundation only.

Setter for preferredPrimaryColumnWidthFraction.

pub fn preferredPrimaryColumnWidth(&self) -> CGFloat

Available on crate feature objc2-core-foundation only.

pub fn setPreferredPrimaryColumnWidth( &self, preferred_primary_column_width: CGFloat, )

Available on crate feature objc2-core-foundation only.

Setter for preferredPrimaryColumnWidth.

pub fn minimumPrimaryColumnWidth(&self) -> CGFloat

Available on crate feature objc2-core-foundation only.

pub fn setMinimumPrimaryColumnWidth( &self, minimum_primary_column_width: CGFloat, )

Available on crate feature objc2-core-foundation only.

Setter for minimumPrimaryColumnWidth.

pub fn maximumPrimaryColumnWidth(&self) -> CGFloat

Available on crate feature objc2-core-foundation only.

pub fn setMaximumPrimaryColumnWidth( &self, maximum_primary_column_width: CGFloat, )

Available on crate feature objc2-core-foundation only.

Setter for maximumPrimaryColumnWidth.

pub fn primaryColumnWidth(&self) -> CGFloat

Available on crate feature objc2-core-foundation only.

pub fn preferredSupplementaryColumnWidthFraction(&self) -> CGFloat

Available on crate feature objc2-core-foundation only.

pub fn setPreferredSupplementaryColumnWidthFraction( &self, preferred_supplementary_column_width_fraction: CGFloat, )

Available on crate feature objc2-core-foundation only.

Setter for preferredSupplementaryColumnWidthFraction.

pub fn preferredSupplementaryColumnWidth(&self) -> CGFloat

Available on crate feature objc2-core-foundation only.

pub fn setPreferredSupplementaryColumnWidth( &self, preferred_supplementary_column_width: CGFloat, )

Available on crate feature objc2-core-foundation only.

Setter for preferredSupplementaryColumnWidth.

pub fn minimumSupplementaryColumnWidth(&self) -> CGFloat

Available on crate feature objc2-core-foundation only.

pub fn setMinimumSupplementaryColumnWidth( &self, minimum_supplementary_column_width: CGFloat, )

Available on crate feature objc2-core-foundation only.

Setter for minimumSupplementaryColumnWidth.

pub fn maximumSupplementaryColumnWidth(&self) -> CGFloat

Available on crate feature objc2-core-foundation only.

pub fn setMaximumSupplementaryColumnWidth( &self, maximum_supplementary_column_width: CGFloat, )

Available on crate feature objc2-core-foundation only.

Setter for maximumSupplementaryColumnWidth.

pub fn supplementaryColumnWidth(&self) -> CGFloat

Available on crate feature objc2-core-foundation only.

pub fn preferredSecondaryColumnWidthFraction(&self) -> CGFloat

Available on crate feature objc2-core-foundation only.

pub fn setPreferredSecondaryColumnWidthFraction( &self, preferred_secondary_column_width_fraction: CGFloat, )

Available on crate feature objc2-core-foundation only.

Setter for preferredSecondaryColumnWidthFraction.

pub fn preferredSecondaryColumnWidth(&self) -> CGFloat

Available on crate feature objc2-core-foundation only.

pub fn setPreferredSecondaryColumnWidth( &self, preferred_secondary_column_width: CGFloat, )

Available on crate feature objc2-core-foundation only.

Setter for preferredSecondaryColumnWidth.

pub fn minimumSecondaryColumnWidth(&self) -> CGFloat

Available on crate feature objc2-core-foundation only.

pub fn setMinimumSecondaryColumnWidth( &self, minimum_secondary_column_width: CGFloat, )

Available on crate feature objc2-core-foundation only.

Setter for minimumSecondaryColumnWidth.

pub fn preferredInspectorColumnWidthFraction(&self) -> CGFloat

Available on crate feature objc2-core-foundation only.

pub fn setPreferredInspectorColumnWidthFraction( &self, preferred_inspector_column_width_fraction: CGFloat, )

Available on crate feature objc2-core-foundation only.

Setter for preferredInspectorColumnWidthFraction.

pub fn preferredInspectorColumnWidth(&self) -> CGFloat

Available on crate feature objc2-core-foundation only.

pub fn setPreferredInspectorColumnWidth( &self, preferred_inspector_column_width: CGFloat, )

Available on crate feature objc2-core-foundation only.

Setter for preferredInspectorColumnWidth.

pub fn minimumInspectorColumnWidth(&self) -> CGFloat

Available on crate feature objc2-core-foundation only.

pub fn setMinimumInspectorColumnWidth( &self, minimum_inspector_column_width: CGFloat, )

Available on crate feature objc2-core-foundation only.

Setter for minimumInspectorColumnWidth.

pub fn maximumInspectorColumnWidth(&self) -> CGFloat

Available on crate feature objc2-core-foundation only.

pub fn setMaximumInspectorColumnWidth( &self, maximum_inspector_column_width: CGFloat, )

Available on crate feature objc2-core-foundation only.

Setter for maximumInspectorColumnWidth.

pub fn primaryEdge(&self) -> UISplitViewControllerPrimaryEdge

pub fn setPrimaryEdge(&self, primary_edge: UISplitViewControllerPrimaryEdge)

Setter for primaryEdge.

pub unsafe fn showViewController_sender( &self, vc: &UIViewController, sender: Option<&AnyObject>, )

Safety

sender should be of the correct type.

pub unsafe fn showDetailViewController_sender( &self, vc: &UIViewController, sender: Option<&AnyObject>, )

Safety

sender should be of the correct type.

pub fn primaryBackgroundStyle(&self) -> UISplitViewControllerBackgroundStyle

pub fn setPrimaryBackgroundStyle( &self, primary_background_style: UISplitViewControllerBackgroundStyle, )

Setter for primaryBackgroundStyle.

impl UISplitViewController

Methods declared on superclass NSObject.

pub fn init(this: Allocated<Self>) -> Retained<Self>

pub fn new(mtm: MainThreadMarker) -> Retained<Self>

Methods from Deref<Target = UIViewController>

pub fn navigationItem(&self) -> Retained<UINavigationItem>

Available on crate features UINavigationController and UINavigationItem only.

pub fn hidesBottomBarWhenPushed(&self) -> bool

Available on crate feature UINavigationController only.

pub fn setHidesBottomBarWhenPushed(&self, hides_bottom_bar_when_pushed: bool)

Available on crate feature UINavigationController only.

Setter for hidesBottomBarWhenPushed.

pub fn navigationController(&self) -> Option<Retained<UINavigationController>>

Available on crate feature UINavigationController only.

pub fn toolbarItems(&self) -> Option<Retained<NSArray<UIBarButtonItem>>>

Available on crate features UINavigationController and UIBarButtonItem and UIBarItem only.

pub fn setToolbarItems(&self, toolbar_items: Option<&NSArray<UIBarButtonItem>>)

Available on crate features UINavigationController and UIBarButtonItem and UIBarItem only.

Setter for toolbarItems.

pub fn setToolbarItems_animated( &self, toolbar_items: Option<&NSArray<UIBarButtonItem>>, animated: bool, )

Available on crate features UINavigationController and UIBarButtonItem and UIBarItem only.

pub fn isModalInPopover(&self) -> bool

👎Deprecated

Available on crate feature UIPopoverSupport only.

pub fn setModalInPopover(&self, modal_in_popover: bool)

👎Deprecated

Available on crate feature UIPopoverSupport only.

Setter for isModalInPopover.

pub fn contentSizeForViewInPopover(&self) -> CGSize

👎Deprecated

Available on crate features UIPopoverSupport and objc2-core-foundation only.

pub fn setContentSizeForViewInPopover( &self, content_size_for_view_in_popover: CGSize, )

👎Deprecated

Available on crate features UIPopoverSupport and objc2-core-foundation only.

Setter for contentSizeForViewInPopover.

pub fn splitViewController(&self) -> Option<Retained<UISplitViewController>>

pub fn collapseSecondaryViewController_forSplitViewController( &self, secondary_view_controller: &UIViewController, split_view_controller: &UISplitViewController, )

pub fn separateSecondaryViewControllerForSplitViewController( &self, split_view_controller: &UISplitViewController, ) -> Option<Retained<UIViewController>>

pub fn tab(&self) -> Option<Retained<UITab>>

Available on crate feature UITab only.

The UITab instance that was used to create the receiver, and represents the view controller. Default is nil.

pub fn tabBarItem(&self) -> Option<Retained<UITabBarItem>>

Available on crate features UITabBarController and UIBarItem and UITabBarItem only.

pub unsafe fn setTabBarItem(&self, tab_bar_item: Option<&UITabBarItem>)

Available on crate features UITabBarController and UIBarItem and UITabBarItem only.

Setter for tabBarItem.

Safety

tab_bar_item might not allow None.

pub fn tabBarController(&self) -> Option<Retained<UITabBarController>>

Available on crate feature UITabBarController only.

pub fn tabBarObservedScrollView(&self) -> Option<Retained<UIScrollView>>

👎Deprecated: Use -setContentScrollView:forEdge: instead.

Available on crate features UITabBarController and UIScrollView and UIView only.

pub fn setTabBarObservedScrollView( &self, tab_bar_observed_scroll_view: Option<&UIScrollView>, )

👎Deprecated: Use -setContentScrollView:forEdge: instead.

Available on crate features UITabBarController and UIScrollView and UIView only.

Setter for tabBarObservedScrollView.

pub fn view(&self) -> Option<Retained<UIView>>

Available on crate feature UIView only.

pub fn setView(&self, view: Option<&UIView>)

Available on crate feature UIView only.

Setter for view.

pub fn loadView(&self)

pub fn loadViewIfNeeded(&self)

pub fn viewIfLoaded(&self) -> Option<Retained<UIView>>

Available on crate feature UIView only.

pub fn viewWillUnload(&self)

👎Deprecated

pub fn viewDidUnload(&self)

👎Deprecated

pub fn viewDidLoad(&self)

pub fn isViewLoaded(&self) -> bool

pub fn nibName(&self) -> Option<Retained<NSString>>

👎Deprecated: Loading Interface Builder products will not be supported in a future version of visionOS.

pub fn nibBundle(&self) -> Option<Retained<NSBundle>>

👎Deprecated: Loading Interface Builder products will not be supported in a future version of visionOS.

pub fn storyboard(&self) -> Option<Retained<UIStoryboard>>

👎Deprecated: Loading Interface Builder products will not be supported in a future version of visionOS.

Available on crate feature UIStoryboard only.

pub unsafe fn performSegueWithIdentifier_sender( &self, identifier: &NSString, sender: Option<&AnyObject>, )

👎Deprecated: Loading Interface Builder products will not be supported in a future version of visionOS.

Safety

sender should be of the correct type.

pub unsafe fn shouldPerformSegueWithIdentifier_sender( &self, identifier: &NSString, sender: Option<&AnyObject>, ) -> bool

👎Deprecated: Loading Interface Builder products will not be supported in a future version of visionOS.

Safety

sender should be of the correct type.

pub unsafe fn prepareForSegue_sender( &self, segue: &UIStoryboardSegue, sender: Option<&AnyObject>, )

👎Deprecated: Loading Interface Builder products will not be supported in a future version of visionOS.

Available on crate feature UIStoryboardSegue only.

Safety

sender should be of the correct type.

pub unsafe fn canPerformUnwindSegueAction_fromViewController_sender( &self, action: Sel, from_view_controller: &UIViewController, sender: Option<&AnyObject>, ) -> bool

👎Deprecated: Loading Interface Builder products will not be supported in a future version of visionOS.

Safety

• action must be a valid selector.
• sender should be of the correct type.

pub unsafe fn canPerformUnwindSegueAction_fromViewController_withSender( &self, action: Sel, from_view_controller: &UIViewController, sender: &AnyObject, ) -> bool

👎Deprecated

Safety

• action must be a valid selector.
• sender should be of the correct type.

pub fn allowedChildViewControllersForUnwindingFromSource( &self, source: &UIStoryboardUnwindSegueSource, ) -> Retained<NSArray<UIViewController>>

👎Deprecated: Loading Interface Builder products will not be supported in a future version of visionOS.

Available on crate feature UIStoryboardSegue only.

pub fn childViewControllerContainingSegueSource( &self, source: &UIStoryboardUnwindSegueSource, ) -> Option<Retained<UIViewController>>

👎Deprecated: Loading Interface Builder products will not be supported in a future version of visionOS.

Available on crate feature UIStoryboardSegue only.

pub unsafe fn viewControllerForUnwindSegueAction_fromViewController_withSender( &self, action: Sel, from_view_controller: &UIViewController, sender: Option<&AnyObject>, ) -> Option<Retained<UIViewController>>

👎Deprecated

Safety

• action must be a valid selector.
• sender should be of the correct type.

pub fn unwindForSegue_towardsViewController( &self, unwind_segue: &UIStoryboardSegue, subsequent_vc: &UIViewController, )

👎Deprecated: Loading Interface Builder products will not be supported in a future version of visionOS.

Available on crate feature UIStoryboardSegue only.

pub fn segueForUnwindingToViewController_fromViewController_identifier( &self, to_view_controller: &UIViewController, from_view_controller: &UIViewController, identifier: Option<&NSString>, ) -> Option<Retained<UIStoryboardSegue>>

👎Deprecated

Available on crate feature UIStoryboardSegue only.

pub fn viewWillAppear(&self, animated: bool)

Called when the view is about to made visible, before it is added to the hierarchy. Because the view is not yet in the hierarchy at the time this method is called, it is too early in the appearance transition for many usages. Prefer -viewIsAppearing: instead of this method when possible. Only use this method when its exact timing before the appearance transition starts running is desired, such as to set up an alongside animation with a transition coordinator, or as a counterpart for paired code in a viewWillDisappear/viewDidDisappear callback that does not rely on the view or view controller’s trait collection or the view hierarchy.

pub fn viewIsAppearing(&self, animated: bool)

Called when the view is becoming visible at the beginning of the appearance transition, after it has been added to the hierarchy and been laid out by its superview. This method is very similar to -viewWillAppear: and is always called shortly afterwards (so changes made in either callback will be visible to the user at the same time), but unlike -viewWillAppear:, at the time when -viewIsAppearing: is called all of the following are valid for the view controller and its own view:

• View controller and view’s trait collection
• View’s superview chain and window
• View’s geometry (e.g. frame/bounds, safe area insets, layout margins) Choose this method instead of -viewWillAppear: by default, as it is a direct replacement that provides equivalent or superior behavior in nearly all cases.

pub fn viewDidAppear(&self, animated: bool)

Called after the view has fully transitioned to visible, when any transition animations have completed.

pub fn viewWillDisappear(&self, animated: bool)

Called when the view is about to be dismissed, covered, or otherwise hidden.

pub fn viewDidDisappear(&self, animated: bool)

Called after the view has fully been dismissed, covered, or otherwise hidden, when any transition animations have completed.

pub fn setNeedsUpdateProperties(&self)

Call to manually request a properties update for the view controller. Multiple requests may be coalesced into a single update alongside the next layout pass.

pub fn updateProperties(&self)

Override point for subclasses to update properties of this view controller or its view. Never call this method directly; use setNeedsUpdateProperties to schedule an update.

pub fn updatePropertiesIfNeeded(&self)

Forces an immediate properties update for this view controller and its view, including any view controllers and views in this subtree.

pub fn viewWillLayoutSubviews(&self)

pub fn viewDidLayoutSubviews(&self)

pub fn title(&self) -> Option<Retained<NSString>>

pub fn setTitle(&self, title: Option<&NSString>)

Setter for title.

This is copied when set.

pub fn didReceiveMemoryWarning(&self)

pub fn parentViewController(&self) -> Option<Retained<UIViewController>>

pub fn modalViewController(&self) -> Option<Retained<UIViewController>>

👎Deprecated

pub fn presentedViewController(&self) -> Option<Retained<UIViewController>>

pub fn presentingViewController(&self) -> Option<Retained<UIViewController>>

pub fn definesPresentationContext(&self) -> bool

pub fn setDefinesPresentationContext(&self, defines_presentation_context: bool)

Setter for definesPresentationContext.

pub fn providesPresentationContextTransitionStyle(&self) -> bool

pub fn setProvidesPresentationContextTransitionStyle( &self, provides_presentation_context_transition_style: bool, )

Setter for providesPresentationContextTransitionStyle.

pub fn restoresFocusAfterTransition(&self) -> bool

pub fn setRestoresFocusAfterTransition( &self, restores_focus_after_transition: bool, )

Setter for restoresFocusAfterTransition.

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

The identifier of the focus group that this view controller belongs to. If this is nil, the view controller inherits the focus group of its parent focus environment.

pub fn setFocusGroupIdentifier(&self, focus_group_identifier: Option<&NSString>)

Setter for focusGroupIdentifier.

This is copied when set.

pub fn interactionActivityTrackingBaseName(&self) -> Option<Retained<NSString>>

The base name for tracking user interactions as activities hosted by this view controller.

pub fn setInteractionActivityTrackingBaseName( &self, interaction_activity_tracking_base_name: Option<&NSString>, )

Setter for interactionActivityTrackingBaseName.

This is copied when set.

pub fn isBeingPresented(&self) -> bool

pub fn isBeingDismissed(&self) -> bool

pub fn isMovingToParentViewController(&self) -> bool

pub fn isMovingFromParentViewController(&self) -> bool

pub fn presentViewController_animated_completion( &self, view_controller_to_present: &UIViewController, flag: bool, completion: Option<&DynBlock<dyn Fn()>>, )

Available on crate feature block2 only.

pub fn dismissViewControllerAnimated_completion( &self, flag: bool, completion: Option<&DynBlock<dyn Fn()>>, )

Available on crate feature block2 only.

pub fn presentModalViewController_animated( &self, modal_view_controller: &UIViewController, animated: bool, )

👎Deprecated

pub fn dismissModalViewControllerAnimated(&self, animated: bool)

👎Deprecated

pub fn modalTransitionStyle(&self) -> UIModalTransitionStyle

pub fn setModalTransitionStyle( &self, modal_transition_style: UIModalTransitionStyle, )

Setter for modalTransitionStyle.

pub fn preferredTransition( &self, ) -> Option<Retained<UIViewControllerTransition>>

Available on crate feature UIViewControllerTransition only.

Preferred system provided transition to use when displaying this view controller. Note that this only indicates a preference. The provided transition may be ignored if not supported by the current context. For example, UINavigationController supports the .zoom transition, but not the .coverVertical transition.

pub fn setPreferredTransition( &self, preferred_transition: Option<&UIViewControllerTransition>, )

Available on crate feature UIViewControllerTransition only.

Setter for preferredTransition.

pub fn modalPresentationStyle(&self) -> UIModalPresentationStyle

pub fn setModalPresentationStyle( &self, modal_presentation_style: UIModalPresentationStyle, )

Setter for modalPresentationStyle.

pub fn modalPresentationCapturesStatusBarAppearance(&self) -> bool

pub fn setModalPresentationCapturesStatusBarAppearance( &self, modal_presentation_captures_status_bar_appearance: bool, )

Setter for modalPresentationCapturesStatusBarAppearance.

pub fn disablesAutomaticKeyboardDismissal(&self) -> bool

pub fn wantsFullScreenLayout(&self) -> bool

👎Deprecated

pub fn setWantsFullScreenLayout(&self, wants_full_screen_layout: bool)

👎Deprecated

Setter for wantsFullScreenLayout.

pub fn edgesForExtendedLayout(&self) -> UIRectEdge

Available on crate feature UIGeometry only.

pub fn setEdgesForExtendedLayout(&self, edges_for_extended_layout: UIRectEdge)

Available on crate feature UIGeometry only.

Setter for edgesForExtendedLayout.

pub fn extendedLayoutIncludesOpaqueBars(&self) -> bool

pub fn setExtendedLayoutIncludesOpaqueBars( &self, extended_layout_includes_opaque_bars: bool, )

Setter for extendedLayoutIncludesOpaqueBars.

pub fn automaticallyAdjustsScrollViewInsets(&self) -> bool

👎Deprecated: Use UIScrollView’s contentInsetAdjustmentBehavior instead

pub fn setAutomaticallyAdjustsScrollViewInsets( &self, automatically_adjusts_scroll_view_insets: bool, )

👎Deprecated: Use UIScrollView’s contentInsetAdjustmentBehavior instead

Setter for automaticallyAdjustsScrollViewInsets.

pub fn setContentScrollView_forEdge( &self, scroll_view: Option<&UIScrollView>, edge: NSDirectionalRectEdge, )

Available on crate features UIGeometry and UIScrollView and UIView only.

Aggregate values (e.g., NSDirectionalRectEdgeAll) are accepted in the edge parameter; NSDirectionalRectEdgeLeading and Trailing are ignored on iOS 15.0

pub fn contentScrollViewForEdge( &self, edge: NSDirectionalRectEdge, ) -> Option<Retained<UIScrollView>>

Available on crate features UIGeometry and UIScrollView and UIView only.

Pass only a single edge (e.g., NSDirectionalRectEdgeTop) in the edge parameter. Raises an exception when passed an aggregate edge (e.g., NSDirectionalRectEdgeAll)

pub fn preferredContentSize(&self) -> CGSize

Available on crate feature objc2-core-foundation only.

pub fn setPreferredContentSize(&self, preferred_content_size: CGSize)

Available on crate feature objc2-core-foundation only.

Setter for preferredContentSize.

pub fn preferredStatusBarStyle(&self) -> UIStatusBarStyle

👎Deprecated: Has no effect on visionOS

Available on crate feature UIApplication only.

pub fn prefersStatusBarHidden(&self) -> bool

👎Deprecated: Has no effect on visionOS

pub fn preferredStatusBarUpdateAnimation(&self) -> UIStatusBarAnimation

👎Deprecated: Has no effect on visionOS

Available on crate feature UIApplication only.

pub fn setNeedsStatusBarAppearanceUpdate(&self)

pub unsafe fn targetViewControllerForAction_sender( &self, action: Sel, sender: Option<&AnyObject>, ) -> Option<Retained<UIViewController>>

Safety

• action must be a valid selector.
• sender should be of the correct type.

pub unsafe fn showViewController_sender( &self, vc: &UIViewController, sender: Option<&AnyObject>, )

Safety

sender should be of the correct type.

pub unsafe fn showDetailViewController_sender( &self, vc: &UIViewController, sender: Option<&AnyObject>, )

Safety

sender should be of the correct type.

pub fn preferredUserInterfaceStyle(&self) -> UIUserInterfaceStyle

Available on crate feature UIInterface only.

pub fn setNeedsUserInterfaceAppearanceUpdate(&self)

pub fn overrideUserInterfaceStyle(&self) -> UIUserInterfaceStyle

Available on crate feature UIInterface only.

pub fn setOverrideUserInterfaceStyle( &self, override_user_interface_style: UIUserInterfaceStyle, )

Available on crate feature UIInterface only.

Setter for overrideUserInterfaceStyle.

pub fn shouldAutorotateToInterfaceOrientation( &self, to_interface_orientation: UIInterfaceOrientation, ) -> bool

👎Deprecated

Available on crate feature UIOrientation only.

pub fn shouldAutorotate(&self) -> bool

👎Deprecated: Update supported interface orientations and call setNeedsUpdateOfSupportedInterfaceOrientations to indicate a change.

pub fn supportedInterfaceOrientations(&self) -> UIInterfaceOrientationMask

Available on crate feature UIOrientation only.

pub fn preferredInterfaceOrientationForPresentation( &self, ) -> UIInterfaceOrientation

Available on crate feature UIOrientation only.

pub fn setNeedsUpdateOfSupportedInterfaceOrientations(&self)

Notifies the view controller that a change occurred that affects supported interface orientations or the preferred interface orientation for presentation. By default, this will animate any changes to orientation. To perform a non-animated update, call within [UIView performWithoutAnimation:].

pub fn rotatingHeaderView(&self) -> Option<Retained<UIView>>

👎Deprecated: Header views are animated along with the rest of the view hierarchy

Available on crate feature UIView only.

pub fn rotatingFooterView(&self) -> Option<Retained<UIView>>

👎Deprecated: Footer views are animated along with the rest of the view hierarchy

Available on crate feature UIView only.

pub fn interfaceOrientation(&self) -> UIInterfaceOrientation

👎Deprecated

Available on crate feature UIOrientation only.

pub fn willRotateToInterfaceOrientation_duration( &self, to_interface_orientation: UIInterfaceOrientation, duration: NSTimeInterval, )

👎Deprecated: Implement viewWillTransitionToSize:withTransitionCoordinator: instead

Available on crate feature UIOrientation only.

pub fn didRotateFromInterfaceOrientation( &self, from_interface_orientation: UIInterfaceOrientation, )

👎Deprecated

Available on crate feature UIOrientation only.

pub fn willAnimateRotationToInterfaceOrientation_duration( &self, to_interface_orientation: UIInterfaceOrientation, duration: NSTimeInterval, )

👎Deprecated: Implement viewWillTransitionToSize:withTransitionCoordinator: instead

Available on crate feature UIOrientation only.

pub fn willAnimateFirstHalfOfRotationToInterfaceOrientation_duration( &self, to_interface_orientation: UIInterfaceOrientation, duration: NSTimeInterval, )

👎Deprecated

Available on crate feature UIOrientation only.

pub fn didAnimateFirstHalfOfRotationToInterfaceOrientation( &self, to_interface_orientation: UIInterfaceOrientation, )

👎Deprecated

Available on crate feature UIOrientation only.

pub fn willAnimateSecondHalfOfRotationFromInterfaceOrientation_duration( &self, from_interface_orientation: UIInterfaceOrientation, duration: NSTimeInterval, )

👎Deprecated

Available on crate feature UIOrientation only.

pub fn isEditing(&self) -> bool

pub fn setEditing(&self, editing: bool)

Setter for isEditing.

pub fn setEditing_animated(&self, editing: bool, animated: bool)

pub fn editButtonItem(&self) -> Retained<UIBarButtonItem>

Available on crate features UIBarButtonItem and UIBarItem only.

pub fn searchDisplayController( &self, ) -> Option<Retained<UISearchDisplayController>>

👎Deprecated

Available on crate feature UISearchDisplayController only.

pub fn childViewControllers(&self) -> Retained<NSArray<UIViewController>>

pub fn addChildViewController(&self, child_controller: &UIViewController)

pub fn removeFromParentViewController(&self)

pub fn transitionFromViewController_toViewController_duration_options_animations_completion( &self, from_view_controller: &UIViewController, to_view_controller: &UIViewController, duration: NSTimeInterval, options: UIViewAnimationOptions, animations: Option<&DynBlock<dyn Fn()>>, completion: Option<&DynBlock<dyn Fn(Bool)>>, )

Available on crate features UIView and block2 only.

pub fn beginAppearanceTransition_animated( &self, is_appearing: bool, animated: bool, )

pub fn endAppearanceTransition(&self)

pub fn childViewControllerForStatusBarStyle( &self, ) -> Option<Retained<UIViewController>>

👎Deprecated: Has no effect on visionOS

pub fn childViewControllerForStatusBarHidden( &self, ) -> Option<Retained<UIViewController>>

👎Deprecated: Has no effect on visionOS

pub fn setOverrideTraitCollection_forChildViewController( &self, collection: Option<&UITraitCollection>, child_view_controller: &UIViewController, )

👎Deprecated: Use the traitOverrides property on the child view controller instead

Available on crate feature UITraitCollection only.

pub fn overrideTraitCollectionForChildViewController( &self, child_view_controller: &UIViewController, ) -> Option<Retained<UITraitCollection>>

👎Deprecated: Use the traitOverrides property on the child view controller instead

Available on crate feature UITraitCollection only.

pub fn childViewControllerForUserInterfaceStyle( &self, ) -> Option<Retained<UIViewController>>

pub fn automaticallyForwardAppearanceAndRotationMethodsToChildViewControllers( &self, ) -> bool

👎Deprecated

pub fn shouldAutomaticallyForwardRotationMethods(&self) -> bool

👎Deprecated: Manually forward viewWillTransitionToSize:withTransitionCoordinator: if necessary

pub fn shouldAutomaticallyForwardAppearanceMethods(&self) -> bool

pub fn willMoveToParentViewController(&self, parent: Option<&UIViewController>)

pub fn didMoveToParentViewController(&self, parent: Option<&UIViewController>)

pub fn restorationIdentifier(&self) -> Option<Retained<NSString>>

pub fn setRestorationIdentifier( &self, restoration_identifier: Option<&NSString>, )

Setter for restorationIdentifier.

This is copied when set.

pub unsafe fn restorationClass(&self) -> Option<&'static AnyClass>

Available on crate feature UIStateRestoration only.

Safety

This is not retained internally, you must ensure the object is still alive.

pub unsafe fn setRestorationClass(&self, restoration_class: Option<&AnyClass>)

Available on crate feature UIStateRestoration only.

Setter for restorationClass.

Safety

• restoration_class must implement UIViewControllerRestoration.
• This is unretained, you must ensure the object is kept alive while in use.

pub unsafe fn encodeRestorableStateWithCoder(&self, coder: &NSCoder)

Safety

coder possibly has further requirements.

pub unsafe fn decodeRestorableStateWithCoder(&self, coder: &NSCoder)

Safety

coder possibly has further requirements.

pub fn applicationFinishedRestoringState(&self)

pub fn updateViewConstraints(&self)

pub fn transitioningDelegate( &self, ) -> Option<Retained<ProtocolObject<dyn UIViewControllerTransitioningDelegate>>>

Available on crate feature UIViewControllerTransitioning only.

pub fn setTransitioningDelegate( &self, transitioning_delegate: Option<&ProtocolObject<dyn UIViewControllerTransitioningDelegate>>, )

Available on crate feature UIViewControllerTransitioning only.

Setter for transitioningDelegate.

This is a weak property.

pub fn topLayoutGuide(&self) -> Retained<ProtocolObject<dyn UILayoutSupport>>

👎Deprecated: Use view.safeAreaLayoutGuide.topAnchor instead of topLayoutGuide.bottomAnchor

Available on crate feature NSLayoutConstraint only.

pub fn bottomLayoutGuide(&self) -> Retained<ProtocolObject<dyn UILayoutSupport>>

👎Deprecated: Use view.safeAreaLayoutGuide.bottomAnchor instead of bottomLayoutGuide.topAnchor

Available on crate feature NSLayoutConstraint only.

pub fn additionalSafeAreaInsets(&self) -> UIEdgeInsets

Available on crate features UIGeometry and objc2-core-foundation only.

pub fn setAdditionalSafeAreaInsets( &self, additional_safe_area_insets: UIEdgeInsets, )

Available on crate features UIGeometry and objc2-core-foundation only.

Setter for additionalSafeAreaInsets.

pub fn systemMinimumLayoutMargins(&self) -> NSDirectionalEdgeInsets

Available on crate features UIGeometry and objc2-core-foundation only.

pub fn viewRespectsSystemMinimumLayoutMargins(&self) -> bool

pub fn setViewRespectsSystemMinimumLayoutMargins( &self, view_respects_system_minimum_layout_margins: bool, )

Setter for viewRespectsSystemMinimumLayoutMargins.

pub fn viewLayoutMarginsDidChange(&self)

pub fn viewSafeAreaInsetsDidChange(&self)

pub fn addKeyCommand(&self, key_command: &UIKeyCommand)

Available on crate features UICommand and UIKeyCommand and UIMenuElement only.

pub fn removeKeyCommand(&self, key_command: &UIKeyCommand)

Available on crate features UICommand and UIKeyCommand and UIMenuElement only.

pub fn performsActionsWhilePresentingModally(&self) -> bool

Determines whether the receiver continues to respond to actions while it is presenting a view controller modally.

Defaults to YES. You can change the default return value by providing a value for UIViewControllerPerformsActionsWhilePresentingModally in your Info.plist file.

pub fn extensionContext(&self) -> Option<Retained<NSExtensionContext>>

pub fn presentationController( &self, ) -> Option<Retained<UIPresentationController>>

Available on crate feature UIPresentationController only.

pub fn sheetPresentationController( &self, ) -> Option<Retained<UISheetPresentationController>>

Available on crate features UIPresentationController and UISheetPresentationController only.

pub fn popoverPresentationController( &self, ) -> Option<Retained<UIPopoverPresentationController>>

Available on crate features UIPopoverPresentationController and UIPresentationController only.

pub fn activePresentationController( &self, ) -> Option<Retained<UIPresentationController>>

Available on crate feature UIPresentationController only.

pub fn isModalInPresentation(&self) -> bool

pub fn setModalInPresentation(&self, modal_in_presentation: bool)

Setter for isModalInPresentation.

pub fn registerForPreviewingWithDelegate_sourceView( &self, delegate: &ProtocolObject<dyn UIViewControllerPreviewingDelegate>, source_view: &UIView, ) -> Retained<ProtocolObject<dyn UIViewControllerPreviewing>>

👎Deprecated: UIViewControllerPreviewing is deprecated. Please use UIContextMenuInteraction.

Available on crate feature UIView only.

pub fn unregisterForPreviewingWithContext( &self, previewing: &ProtocolObject<dyn UIViewControllerPreviewing>, )

👎Deprecated: UIViewControllerPreviewing is deprecated. Please use UIContextMenuInteraction.

pub fn childViewControllerForScreenEdgesDeferringSystemGestures( &self, ) -> Option<Retained<UIViewController>>

pub fn preferredScreenEdgesDeferringSystemGestures(&self) -> UIRectEdge

Available on crate feature UIGeometry only.

pub fn setNeedsUpdateOfScreenEdgesDeferringSystemGestures(&self)

pub fn childViewControllerForHomeIndicatorAutoHidden( &self, ) -> Option<Retained<UIViewController>>

pub fn prefersHomeIndicatorAutoHidden(&self) -> bool

pub fn setNeedsUpdateOfHomeIndicatorAutoHidden(&self)

pub fn childViewControllerForPointerLock( &self, ) -> Option<Retained<UIViewController>>

pub fn prefersPointerLocked(&self) -> bool

pub fn setNeedsUpdateOfPrefersPointerLocked(&self)

pub fn contentUnavailableConfiguration( &self, ) -> Option<Retained<ProtocolObject<dyn UIContentConfiguration>>>

Available on crate feature UIContentConfiguration only.

Setting a content unavailable configuration replaces the existing content unavailable view of the view controller with a new content unavailable view instance from the configuration, or directly applies the configuration to the existing content unavailable view if the configuration is compatible with the existing content unavailable view type. The default value is nil.

pub fn setContentUnavailableConfiguration( &self, content_unavailable_configuration: Option<&ProtocolObject<dyn UIContentConfiguration>>, )

Available on crate feature UIContentConfiguration only.

Setter for contentUnavailableConfiguration.

This is copied when set.

pub fn contentUnavailableConfigurationState( &self, ) -> Retained<UIContentUnavailableConfigurationState>

Available on crate feature UIContentUnavailableConfigurationState only.

Returns the current content unavailable configuration state for the view. To add your own custom state(s), override the getter and call super to obtain an instance with the system properties set, then set your own custom states as desired.

pub fn setNeedsUpdateContentUnavailableConfiguration(&self)

Requests the view update its content unavailable configuration for its current state. This method is called automatically when the view’s contentUnavailableConfigurationState may have changed, as well as in other circumstances where an update may be required. Multiple requests may be coalesced into a single update at the appropriate time.

pub fn updateContentUnavailableConfigurationUsingState( &self, state: &UIContentUnavailableConfigurationState, )

Available on crate feature UIContentUnavailableConfigurationState only.

Subclasses should override this method and update the content unavailable’s configuration using the state provided. This method should not be called directly, use setNeedsUpdateContentUnavailableConfiguration to request an update.

pub fn childViewControllerForInterfaceOrientationLock( &self, ) -> Option<Retained<UIViewController>>

Override to return a child view controller or nil. If non-nil, that view controller’s preference for interface orientation lock will be used. If nil, self is used. Whenever the return value changes, call setNeedsUpdateOfPrefersInterfaceOrientationLocked().

pub fn prefersInterfaceOrientationLocked(&self) -> bool

Whether this view controller prefers the scene’s interface orientation to be locked when shown. The default is NO. Note that this preference may or may not be honored. See UIWindowScene.Geometry for the current state of interface orientation lock.

pub fn setNeedsUpdateOfPrefersInterfaceOrientationLocked(&self)

Call whenever the view controller’s preference for interface orientation lock has changed

pub fn previewActionItems( &self, ) -> Retained<NSArray<ProtocolObject<dyn UIPreviewActionItem>>>

👎Deprecated: UIViewControllerPreviewing is deprecated. Please use UIContextMenuInteraction.

pub fn traitOverrides(&self) -> Retained<ProtocolObject<dyn UITraitOverrides>>

Available on crate feature UITraitCollection only.

pub fn updateTraitsIfNeeded(&self)

Forces an immediate trait update for this view controller and its view, including any view controllers and views in this subtree. Any trait change callbacks are sent synchronously.

pub fn preferredContainerBackgroundStyle(&self) -> UIContainerBackgroundStyle

pub fn childViewControllerForPreferredContainerBackgroundStyle( &self, ) -> Option<Retained<UIViewController>>

pub fn setNeedsUpdateOfPreferredContainerBackgroundStyle(&self)

pub fn transitionCoordinator( &self, ) -> Option<Retained<ProtocolObject<dyn UIViewControllerTransitionCoordinator>>>

Available on crate feature UIViewControllerTransitionCoordinator only.

Methods from Deref<Target = UIResponder>

pub fn nextResponder(&self) -> Option<Retained<UIResponder>>

pub fn canBecomeFirstResponder(&self) -> bool

pub fn becomeFirstResponder(&self) -> bool

pub fn canResignFirstResponder(&self) -> bool

pub fn resignFirstResponder(&self) -> bool

pub fn isFirstResponder(&self) -> bool

pub fn touchesBegan_withEvent( &self, touches: &NSSet<UITouch>, event: Option<&UIEvent>, )

Available on crate features UIEvent and UITouch only.

pub fn touchesMoved_withEvent( &self, touches: &NSSet<UITouch>, event: Option<&UIEvent>, )

Available on crate features UIEvent and UITouch only.

pub fn touchesEnded_withEvent( &self, touches: &NSSet<UITouch>, event: Option<&UIEvent>, )

Available on crate features UIEvent and UITouch only.

pub fn touchesCancelled_withEvent( &self, touches: &NSSet<UITouch>, event: Option<&UIEvent>, )

Available on crate features UIEvent and UITouch only.

pub fn touchesEstimatedPropertiesUpdated(&self, touches: &NSSet<UITouch>)

Available on crate feature UITouch only.

pub fn pressesBegan_withEvent( &self, presses: &NSSet<UIPress>, event: Option<&UIPressesEvent>, )

Available on crate features UIEvent and UIPress and UIPressesEvent only.

pub fn pressesChanged_withEvent( &self, presses: &NSSet<UIPress>, event: Option<&UIPressesEvent>, )

Available on crate features UIEvent and UIPress and UIPressesEvent only.

pub fn pressesEnded_withEvent( &self, presses: &NSSet<UIPress>, event: Option<&UIPressesEvent>, )

Available on crate features UIEvent and UIPress and UIPressesEvent only.

pub fn pressesCancelled_withEvent( &self, presses: &NSSet<UIPress>, event: Option<&UIPressesEvent>, )

Available on crate features UIEvent and UIPress and UIPressesEvent only.

pub fn motionBegan_withEvent( &self, motion: UIEventSubtype, event: Option<&UIEvent>, )

Available on crate feature UIEvent only.

pub fn motionEnded_withEvent( &self, motion: UIEventSubtype, event: Option<&UIEvent>, )

Available on crate feature UIEvent only.

pub fn motionCancelled_withEvent( &self, motion: UIEventSubtype, event: Option<&UIEvent>, )

Available on crate feature UIEvent only.

pub fn remoteControlReceivedWithEvent(&self, event: Option<&UIEvent>)

Available on crate feature UIEvent only.

pub unsafe fn canPerformAction_withSender( &self, action: Sel, sender: Option<&AnyObject>, ) -> bool

Safety

• action must be a valid selector.
• sender should be of the correct type.

pub unsafe fn targetForAction_withSender( &self, action: Sel, sender: Option<&AnyObject>, ) -> Option<Retained<AnyObject>>

Safety

• action must be a valid selector.
• sender should be of the correct type.

pub fn buildMenuWithBuilder(&self, builder: &ProtocolObject<dyn UIMenuBuilder>)

Available on crate feature UIMenuBuilder only.

pub fn validateCommand(&self, command: &UICommand)

Available on crate features UICommand and UIMenuElement only.

pub fn providerForDeferredMenuElement( &self, deferred_element: &UIDeferredMenuElement, ) -> Option<Retained<UIDeferredMenuElementProvider>>

Available on crate features UIDeferredMenuElement and UIMenuElement only.

Asks the responder for an element provider to fulfill the given focus-based deferred element. Check the identifier of the deferred element to identify which deferred element this is. By default, this returns nil. Return a non-nil provider to make this responder responsible for providing elements for this fulfillment of the deferred element.

pub fn undoManager(&self) -> Option<Retained<NSUndoManager>>

pub fn editingInteractionConfiguration( &self, ) -> UIEditingInteractionConfiguration

pub fn keyCommands(&self) -> Option<Retained<NSArray<UIKeyCommand>>>

Available on crate features UICommand and UIKeyCommand and UIMenuElement only.

pub fn inputView(&self) -> Option<Retained<UIView>>

Available on crate feature UIView only.

pub fn inputAccessoryView(&self) -> Option<Retained<UIView>>

Available on crate feature UIView only.

pub fn inputAssistantItem(&self) -> Retained<UITextInputAssistantItem>

Available on crate feature UITextInput only.

This method is for clients that wish to put buttons on the Shortcuts Bar, shown on top of the keyboard. You may modify the returned inputAssistantItem to add to or replace the existing items on the bar. Modifications made to the returned UITextInputAssistantItem are reflected automatically. This method should not be overridden. Goes up the responder chain.

pub fn inputViewController(&self) -> Option<Retained<UIInputViewController>>

Available on crate feature UIInputViewController only.

pub fn inputAccessoryViewController( &self, ) -> Option<Retained<UIInputViewController>>

Available on crate feature UIInputViewController only.

pub fn textInputMode(&self) -> Option<Retained<UITextInputMode>>

Available on crate feature UITextInput only.

pub fn textInputContextIdentifier(&self) -> Option<Retained<NSString>>

pub fn reloadInputViews(&self)

pub fn userActivity(&self) -> Option<Retained<NSUserActivity>>

pub fn setUserActivity(&self, user_activity: Option<&NSUserActivity>)

Setter for userActivity.

pub fn updateUserActivityState(&self, activity: &NSUserActivity)

pub fn restoreUserActivityState(&self, activity: &NSUserActivity)

pub unsafe fn captureTextFromCamera(&self, sender: Option<&AnyObject>)

Safety

sender should be of the correct type.

pub fn activityItemsConfiguration( &self, ) -> Option<Retained<ProtocolObject<dyn UIActivityItemsConfigurationReading>>>

Available on crate features UIResponder_UIActivityItemsConfiguration and UIActivityItemsConfigurationReading only.

pub fn setActivityItemsConfiguration( &self, activity_items_configuration: Option<&ProtocolObject<dyn UIActivityItemsConfigurationReading>>, )

Available on crate features UIResponder_UIActivityItemsConfiguration and UIActivityItemsConfigurationReading only.

Setter for activityItemsConfiguration.

Methods from Deref<Target = NSObject>

pub fn doesNotRecognizeSelector(&self, sel: Sel) -> !

Handle messages the object doesn’t recognize.

See Apple’s documentation for details.

Methods from Deref<Target = AnyObject>

pub fn class(&self) -> &'static AnyClass

Available on crate feature UIIndirectScribbleInteraction only.

Dynamically find the class of this object.

Panics

May panic if the object is invalid (which may be the case for objects returned from unavailable init/new methods).

Example

Check that an instance of NSObject has the precise class NSObject.

use objc2::ClassType;
use objc2::runtime::NSObject;

let obj = NSObject::new();
assert_eq!(obj.class(), NSObject::class());

pub unsafe fn get_ivar<T>(&self, name: &str) -> &T

where T: Encode,

👎Deprecated: this is difficult to use correctly, use Ivar::load instead.

Available on crate feature UIIndirectScribbleInteraction only.

Use Ivar::load instead.

Safety

The object must have an instance variable with the given name, and it must be of type T.

See Ivar::load_ptr for details surrounding this.

pub fn downcast_ref<T>(&self) -> Option<&T>

where T: DowncastTarget,

Available on crate feature UIIndirectScribbleInteraction only.

Attempt to downcast the object to a class of type T.

This is the reference-variant. Use Retained::downcast if you want to convert a retained object to another type.

Mutable classes

Some classes have immutable and mutable variants, such as NSString and NSMutableString.

When some Objective-C API signature says it gives you an immutable class, it generally expects you to not mutate that, even though it may technically be mutable “under the hood”.

So using this method to convert a NSString to a NSMutableString, while not unsound, is generally frowned upon unless you created the string yourself, or the API explicitly documents the string to be mutable.

See Apple’s documentation on mutability and on isKindOfClass: for more details.

Generic classes

Objective-C generics are called “lightweight generics”, and that’s because they aren’t exposed in the runtime. This makes it impossible to safely downcast to generic collections, so this is disallowed by this method.

You can, however, safely downcast to generic collections where all the type-parameters are AnyObject.

Panics

This works internally by calling isKindOfClass:. That means that the object must have the instance method of that name, and an exception will be thrown (if CoreFoundation is linked) or the process will abort if that is not the case. In the vast majority of cases, you don’t need to worry about this, since both root objects NSObject and NSProxy implement this method.

Examples

Cast an NSString back and forth from NSObject.

use objc2::rc::Retained;
use objc2_foundation::{NSObject, NSString};

let obj: Retained<NSObject> = NSString::new().into_super();
let string = obj.downcast_ref::<NSString>().unwrap();
// Or with `downcast`, if we do not need the object afterwards
let string = obj.downcast::<NSString>().unwrap();

Try (and fail) to cast an NSObject to an NSString.

use objc2_foundation::{NSObject, NSString};

let obj = NSObject::new();
assert!(obj.downcast_ref::<NSString>().is_none());

Try to cast to an array of strings.

use objc2_foundation::{NSArray, NSObject, NSString};

let arr = NSArray::from_retained_slice(&[NSObject::new()]);
// This is invalid and doesn't type check.
let arr = arr.downcast_ref::<NSArray<NSString>>();

This fails to compile, since it would require enumerating over the array to ensure that each element is of the desired type, which is a performance pitfall.

Downcast when processing each element instead.

use objc2_foundation::{NSArray, NSObject, NSString};

let arr = NSArray::from_retained_slice(&[NSObject::new()]);

for elem in arr {
    if let Some(data) = elem.downcast_ref::<NSString>() {
        // handle `data`
    }
}

Trait Implementations

impl AsRef<AnyObject> for UISplitViewController

fn as_ref(&self) -> &AnyObject

Converts this type into a shared reference of the (usually inferred) input type.

impl AsRef<NSObject> for UISplitViewController

fn as_ref(&self) -> &NSObject

Converts this type into a shared reference of the (usually inferred) input type.

impl AsRef<UIResponder> for UISplitViewController

fn as_ref(&self) -> &UIResponder

Converts this type into a shared reference of the (usually inferred) input type.

impl AsRef<UISplitViewController> for UISplitViewController

fn as_ref(&self) -> &Self

Converts this type into a shared reference of the (usually inferred) input type.

impl AsRef<UIViewController> for UISplitViewController

fn as_ref(&self) -> &UIViewController

Converts this type into a shared reference of the (usually inferred) input type.

impl Borrow<AnyObject> for UISplitViewController

fn borrow(&self) -> &AnyObject

Immutably borrows from an owned value.

impl Borrow<NSObject> for UISplitViewController

fn borrow(&self) -> &NSObject

Immutably borrows from an owned value.

impl Borrow<UIResponder> for UISplitViewController

fn borrow(&self) -> &UIResponder

Immutably borrows from an owned value.

impl Borrow<UIViewController> for UISplitViewController

fn borrow(&self) -> &UIViewController

Immutably borrows from an owned value.

impl ClassType for UISplitViewController

const NAME: &'static str = "UISplitViewController"

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

type Super = UIViewController

The superclass of this class.

type ThreadKind = dyn MainThreadOnly

Whether the type can be used from any thread, or from only the main thread.

fn class() -> &'static AnyClass

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

fn as_super(&self) -> &Self::Super

Get an immutable reference to the superclass.

impl Debug for UISplitViewController

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Deref for UISplitViewController

type Target = UIViewController

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl Hash for UISplitViewController

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Message for UISplitViewController

fn retain(&self) -> Retained<Self>

where Self: Sized,

Increment the reference count of the receiver.

impl NSCoding for UISplitViewController

unsafe fn encodeWithCoder(&self, coder: &NSCoder)

where Self: Sized + Message,

Safety

unsafe fn initWithCoder( this: Allocated<Self>, coder: &NSCoder, ) -> Option<Retained<Self>>

where Self: Sized + Message,

Safety

impl NSObjectProtocol for UISplitViewController

fn isEqual(&self, other: Option<&AnyObject>) -> bool

where Self: Sized + Message,

Check whether the object is equal to an arbitrary other object.

fn hash(&self) -> usize

where Self: Sized + Message,

An integer that can be used as a table address in a hash table structure.

fn isKindOfClass(&self, cls: &AnyClass) -> bool

where Self: Sized + Message,

Check if the object is an instance of the class, or one of its subclasses.

fn is_kind_of<T>(&self) -> bool

where T: ClassType, Self: Sized + Message,

👎Deprecated: use isKindOfClass directly, or cast your objects with AnyObject::downcast_ref

Check if the object is an instance of the class type, or one of its subclasses.

fn isMemberOfClass(&self, cls: &AnyClass) -> bool

where Self: Sized + Message,

Check if the object is an instance of a specific class, without checking subclasses.

fn respondsToSelector(&self, aSelector: Sel) -> bool

where Self: Sized + Message,

Check whether the object implements or inherits a method with the given selector.

fn conformsToProtocol(&self, aProtocol: &AnyProtocol) -> bool

where Self: Sized + Message,

Check whether the object conforms to a given protocol.

fn description(&self) -> Retained<NSObject>

where Self: Sized + Message,

A textual representation of the object.

fn debugDescription(&self) -> Retained<NSObject>

where Self: Sized + Message,

A textual representation of the object to use when debugging.

fn isProxy(&self) -> bool

where Self: Sized + Message,

Check whether the receiver is a subclass of the NSProxy root class instead of the usual NSObject.

fn retainCount(&self) -> usize

where Self: Sized + Message,

The reference count of the object.

impl PartialEq for UISplitViewController

fn eq(&self, other: &Self) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl RefEncode for UISplitViewController

const ENCODING_REF: Encoding = <UIViewController as ::objc2::RefEncode>::ENCODING_REF

The Objective-C type-encoding for a reference of this type.

impl UIContentContainer for UISplitViewController

fn preferredContentSize(&self) -> CGSize

where Self: Sized + Message,

Available on crate features UIViewController and objc2-core-foundation only.

fn preferredContentSizeDidChangeForChildContentContainer( &self, container: &ProtocolObject<dyn UIContentContainer>, )

where Self: Sized + Message,

Available on crate feature UIViewController only.

fn systemLayoutFittingSizeDidChangeForChildContentContainer( &self, container: &ProtocolObject<dyn UIContentContainer>, )

where Self: Sized + Message,

Available on crate feature UIViewController only.

fn sizeForChildContentContainer_withParentContainerSize( &self, container: &ProtocolObject<dyn UIContentContainer>, parent_size: CGSize, ) -> CGSize

where Self: Sized + Message,

Available on crate features UIViewController and objc2-core-foundation only.

fn viewWillTransitionToSize_withTransitionCoordinator( &self, size: CGSize, coordinator: &ProtocolObject<dyn UIViewControllerTransitionCoordinator>, )

where Self: Sized + Message,

Available on crate features UIViewControllerTransitionCoordinator and objc2-core-foundation and UIViewController only.

fn willTransitionToTraitCollection_withTransitionCoordinator( &self, new_collection: &UITraitCollection, coordinator: &ProtocolObject<dyn UIViewControllerTransitionCoordinator>, )

where Self: Sized + Message,

Available on crate features UITraitCollection and UIViewControllerTransitionCoordinator and UIViewController only.

impl UIFocusEnvironment for UISplitViewController

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

where Self: Sized + Message,

Available on crate feature UIFocus only.

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,

Available on crate feature UIFocus only.

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,

Available on crate feature UIFocus only.

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

fn setNeedsFocusUpdate(&self)

where Self: Sized + Message,

Available on crate feature UIFocus only.

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,

Available on crate feature UIFocus only.

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,

Available on crate feature UIFocus only.

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 features UIFocus and 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,

Available on crate feature UIFocus only.

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 and UIFocus only.

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

where Self: Sized + Message,

Available on crate feature UIFocus only.

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

impl UIResponderStandardEditActions for UISplitViewController

unsafe fn cut(&self, sender: Option<&AnyObject>)

where Self: Sized + Message,

Available on crate feature UIResponder only.

Safety

unsafe fn copy(&self, sender: Option<&AnyObject>)

where Self: Sized + Message,

Available on crate feature UIResponder only.

Safety

unsafe fn paste(&self, sender: Option<&AnyObject>)

where Self: Sized + Message,

Available on crate feature UIResponder only.

Safety

unsafe fn pasteAndMatchStyle(&self, sender: Option<&AnyObject>)

where Self: Sized + Message,

Available on crate feature UIResponder only.

Safety

unsafe fn pasteAndGo(&self, sender: Option<&AnyObject>)

where Self: Sized + Message,

Available on crate feature UIResponder only.

Safety

unsafe fn pasteAndSearch(&self, sender: Option<&AnyObject>)

where Self: Sized + Message,

Available on crate feature UIResponder only.

Safety

unsafe fn newFromPasteboard(&self, sender: Option<&AnyObject>)

where Self: Sized + Message,

Available on crate feature UIResponder only.

Safety

unsafe fn select(&self, sender: Option<&AnyObject>)

where Self: Sized + Message,

Available on crate feature UIResponder only.

Safety

unsafe fn selectAll(&self, sender: Option<&AnyObject>)

where Self: Sized + Message,

Available on crate feature UIResponder only.

Safety

unsafe fn delete(&self, sender: Option<&AnyObject>)

where Self: Sized + Message,

Available on crate feature UIResponder only.

Safety

unsafe fn makeTextWritingDirectionLeftToRight(&self, sender: Option<&AnyObject>)

where Self: Sized + Message,

Available on crate feature UIResponder only.

Safety

unsafe fn makeTextWritingDirectionRightToLeft(&self, sender: Option<&AnyObject>)

where Self: Sized + Message,

Available on crate feature UIResponder only.

Safety

unsafe fn toggleBoldface(&self, sender: Option<&AnyObject>)

where Self: Sized + Message,

Available on crate feature UIResponder only.

Safety

unsafe fn toggleItalics(&self, sender: Option<&AnyObject>)

where Self: Sized + Message,

Available on crate feature UIResponder only.

Safety

unsafe fn toggleUnderline(&self, sender: Option<&AnyObject>)

where Self: Sized + Message,

Available on crate feature UIResponder only.

Safety

unsafe fn increaseSize(&self, sender: Option<&AnyObject>)

where Self: Sized + Message,

Available on crate feature UIResponder only.

Safety

unsafe fn decreaseSize(&self, sender: Option<&AnyObject>)

where Self: Sized + Message,

Available on crate feature UIResponder only.

Safety

unsafe fn alignLeft(&self, sender: Option<&AnyObject>)

where Self: Sized + Message,

Available on crate feature UIResponder only.

Safety

unsafe fn alignCenter(&self, sender: Option<&AnyObject>)

where Self: Sized + Message,

Available on crate feature UIResponder only.

Safety

unsafe fn alignJustified(&self, sender: Option<&AnyObject>)

where Self: Sized + Message,

Available on crate feature UIResponder only.

Safety

unsafe fn alignRight(&self, sender: Option<&AnyObject>)

where Self: Sized + Message,

Available on crate feature UIResponder only.

Safety

unsafe fn find(&self, sender: Option<&AnyObject>)

where Self: Sized + Message,

Available on crate feature UIResponder only.

Safety

unsafe fn findAndReplace(&self, sender: Option<&AnyObject>)

where Self: Sized + Message,

Available on crate feature UIResponder only.

Safety

unsafe fn findNext(&self, sender: Option<&AnyObject>)

where Self: Sized + Message,

Available on crate feature UIResponder only.

Safety

unsafe fn findPrevious(&self, sender: Option<&AnyObject>)

where Self: Sized + Message,

Available on crate feature UIResponder only.

Safety

unsafe fn useSelectionForFind(&self, sender: Option<&AnyObject>)

where Self: Sized + Message,

Available on crate feature UIResponder only.

Safety

unsafe fn updateTextAttributesWithConversionHandler( &self, conversion_handler: UITextAttributesConversionHandler, )

where Self: Sized + Message,

Available on crate features UIResponder and block2 only.

Safety

unsafe fn print(&self, sender: Option<&AnyObject>)

where Self: Sized + Message,

Available on crate feature UIResponder only.

Safety

unsafe fn rename(&self, sender: Option<&AnyObject>)

where Self: Sized + Message,

Available on crate feature UIResponder only.

Safety

unsafe fn duplicate(&self, sender: Option<&AnyObject>)

where Self: Sized + Message,

Available on crate feature UIResponder only.

Safety

unsafe fn move(&self, sender: Option<&AnyObject>)

where Self: Sized + Message,

Available on crate feature UIResponder only.

Safety

unsafe fn export(&self, sender: Option<&AnyObject>)

where Self: Sized + Message,

Available on crate feature UIResponder only.

Safety

unsafe fn toggleSidebar(&self, sender: Option<&AnyObject>)

where Self: Sized + Message,

Available on crate feature UIResponder only.

Safety

unsafe fn toggleInspector(&self, sender: Option<&AnyObject>)

where Self: Sized + Message,

Available on crate feature UIResponder only.

Safety

unsafe fn performClose(&self, sender: Option<&AnyObject>)

where Self: Sized + Message,

Available on crate feature UIResponder only.

Safety

unsafe fn showWritingTools(&self, sender: &AnyObject)

where Self: Sized + Message,

Available on crate feature UIResponder only.

Safety

impl UITraitEnvironment for UISplitViewController

fn traitCollection(&self) -> Retained<UITraitCollection>

where Self: Sized + Message,

Available on crate feature UITraitCollection only.

fn traitCollectionDidChange( &self, previous_trait_collection: Option<&UITraitCollection>, )

where Self: Sized + Message,

👎Deprecated: Use the trait change registration APIs declared in the UITraitChangeObservable protocol

Available on crate feature UITraitCollection only.

To be overridden as needed to provide custom behavior when the environment’s traits change.

impl DowncastTarget for UISplitViewController

impl Eq for UISplitViewController

impl UIAppearanceContainer for UISplitViewController