Struct UIImagePickerController

#[repr(C)]
pub struct UIImagePickerController { /* private fields */ }

Available on crate features UIImagePickerController and UINavigationController and UIResponder and UIViewController only.

Apple’s documentation

Implementations

impl UIImagePickerController

pub unsafe fn isSourceTypeAvailable( source_type: UIImagePickerControllerSourceType, mtm: MainThreadMarker, ) -> bool

pub unsafe fn availableMediaTypesForSourceType( source_type: UIImagePickerControllerSourceType, mtm: MainThreadMarker, ) -> Option<Retained<NSArray<NSString>>>

pub unsafe fn isCameraDeviceAvailable( camera_device: UIImagePickerControllerCameraDevice, mtm: MainThreadMarker, ) -> bool

pub unsafe fn isFlashAvailableForCameraDevice( camera_device: UIImagePickerControllerCameraDevice, mtm: MainThreadMarker, ) -> bool

pub unsafe fn availableCaptureModesForCameraDevice( camera_device: UIImagePickerControllerCameraDevice, mtm: MainThreadMarker, ) -> Option<Retained<NSArray<NSNumber>>>

pub unsafe fn delegate(&self) -> Option<Retained<AnyObject>>

pub unsafe fn setDelegate(&self, delegate: Option<&AnyObject>)

This is a weak property. Setter for delegate.

pub unsafe fn sourceType(&self) -> UIImagePickerControllerSourceType

pub unsafe fn setSourceType( &self, source_type: UIImagePickerControllerSourceType, )

Setter for sourceType.

pub unsafe fn mediaTypes(&self) -> Retained<NSArray<NSString>>

pub unsafe fn setMediaTypes(&self, media_types: &NSArray<NSString>)

Setter for mediaTypes.

pub unsafe fn allowsEditing(&self) -> bool

pub unsafe fn setAllowsEditing(&self, allows_editing: bool)

Setter for allowsEditing.

pub unsafe fn allowsImageEditing(&self) -> bool

👎Deprecated

pub unsafe fn setAllowsImageEditing(&self, allows_image_editing: bool)

👎Deprecated

Setter for allowsImageEditing.

pub unsafe fn imageExportPreset( &self, ) -> UIImagePickerControllerImageURLExportPreset

👎Deprecated: Will be removed in a future release, use PHPicker.

pub unsafe fn setImageExportPreset( &self, image_export_preset: UIImagePickerControllerImageURLExportPreset, )

👎Deprecated: Will be removed in a future release, use PHPicker.

Setter for imageExportPreset.

pub unsafe fn videoMaximumDuration(&self) -> NSTimeInterval

pub unsafe fn setVideoMaximumDuration( &self, video_maximum_duration: NSTimeInterval, )

Setter for videoMaximumDuration.

pub unsafe fn videoQuality(&self) -> UIImagePickerControllerQualityType

pub unsafe fn setVideoQuality( &self, video_quality: UIImagePickerControllerQualityType, )

Setter for videoQuality.

pub unsafe fn videoExportPreset(&self) -> Retained<NSString>

👎Deprecated: Will be removed in a future release, use PHPicker.

pub unsafe fn setVideoExportPreset(&self, video_export_preset: &NSString)

👎Deprecated: Will be removed in a future release, use PHPicker.

Setter for videoExportPreset.

pub unsafe fn showsCameraControls(&self) -> bool

pub unsafe fn setShowsCameraControls(&self, shows_camera_controls: bool)

Setter for showsCameraControls.

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

Available on crate feature UIView only.

pub unsafe fn setCameraOverlayView(&self, camera_overlay_view: Option<&UIView>)

Available on crate feature UIView only.

Setter for cameraOverlayView.

pub unsafe fn cameraViewTransform(&self) -> CGAffineTransform

Available on crate feature objc2-core-foundation only.

pub unsafe fn setCameraViewTransform( &self, camera_view_transform: CGAffineTransform, )

Available on crate feature objc2-core-foundation only.

Setter for cameraViewTransform.

pub unsafe fn takePicture(&self)

pub unsafe fn startVideoCapture(&self) -> bool

pub unsafe fn stopVideoCapture(&self)

pub unsafe fn cameraCaptureMode( &self, ) -> UIImagePickerControllerCameraCaptureMode

pub unsafe fn setCameraCaptureMode( &self, camera_capture_mode: UIImagePickerControllerCameraCaptureMode, )

Setter for cameraCaptureMode.

pub unsafe fn cameraDevice(&self) -> UIImagePickerControllerCameraDevice

pub unsafe fn setCameraDevice( &self, camera_device: UIImagePickerControllerCameraDevice, )

Setter for cameraDevice.

pub unsafe fn cameraFlashMode(&self) -> UIImagePickerControllerCameraFlashMode

pub unsafe fn setCameraFlashMode( &self, camera_flash_mode: UIImagePickerControllerCameraFlashMode, )

Setter for cameraFlashMode.

impl UIImagePickerController

Methods declared on superclass UINavigationController.

pub unsafe fn initWithNavigationBarClass_toolbarClass( this: Allocated<Self>, navigation_bar_class: Option<&AnyClass>, toolbar_class: Option<&AnyClass>, ) -> Retained<Self>

pub unsafe fn initWithRootViewController( this: Allocated<Self>, root_view_controller: &UIViewController, ) -> Retained<Self>

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

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

impl UIImagePickerController

Methods declared on superclass NSObject.

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

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

Methods from Deref<Target = UINavigationController>

pub unsafe fn pushViewController_animated( &self, view_controller: &UIViewController, animated: bool, )

pub unsafe fn popViewControllerAnimated( &self, animated: bool, ) -> Option<Retained<UIViewController>>

pub unsafe fn popToViewController_animated( &self, view_controller: &UIViewController, animated: bool, ) -> Option<Retained<NSArray<UIViewController>>>

pub unsafe fn popToRootViewControllerAnimated( &self, animated: bool, ) -> Option<Retained<NSArray<UIViewController>>>

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

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

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

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

Setter for viewControllers.

pub unsafe fn setViewControllers_animated( &self, view_controllers: &NSArray<UIViewController>, animated: bool, )

pub unsafe fn isNavigationBarHidden(&self) -> bool

pub unsafe fn setNavigationBarHidden(&self, navigation_bar_hidden: bool)

Setter for isNavigationBarHidden.

pub unsafe fn setNavigationBarHidden_animated( &self, hidden: bool, animated: bool, )

pub unsafe fn navigationBar(&self) -> Retained<UINavigationBar>

Available on crate features UINavigationBar and UIView only.

pub unsafe fn isToolbarHidden(&self) -> bool

pub unsafe fn setToolbarHidden(&self, toolbar_hidden: bool)

Setter for isToolbarHidden.

pub unsafe fn setToolbarHidden_animated(&self, hidden: bool, animated: bool)

pub unsafe fn toolbar(&self) -> Option<Retained<UIToolbar>>

Available on crate features UIToolbar and UIView only.

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

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

This is a weak property. Setter for delegate.

pub unsafe fn interactivePopGestureRecognizer( &self, ) -> Option<Retained<UIGestureRecognizer>>

Available on crate feature UIGestureRecognizer only.

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

pub unsafe fn hidesBarsWhenKeyboardAppears(&self) -> bool

When the keyboard appears, the navigation controller’s navigationBar toolbar will be hidden. The bars will remain hidden when the keyboard dismisses, but a tap in the content area will show them.

pub unsafe fn setHidesBarsWhenKeyboardAppears( &self, hides_bars_when_keyboard_appears: bool, )

Setter for hidesBarsWhenKeyboardAppears.

pub unsafe fn hidesBarsOnSwipe(&self) -> bool

When the user swipes, the navigation controller’s navigationBar & toolbar will be hidden (on a swipe up) or shown (on a swipe down). The toolbar only participates if it has items.

pub unsafe fn setHidesBarsOnSwipe(&self, hides_bars_on_swipe: bool)

Setter for hidesBarsOnSwipe.

pub unsafe fn barHideOnSwipeGestureRecognizer( &self, ) -> Retained<UIPanGestureRecognizer>

Available on crate features UIGestureRecognizer and UIPanGestureRecognizer only.

The gesture recognizer that triggers if the bars will hide or show due to a swipe. Do not change the delegate or attempt to replace this gesture by overriding this method.

pub unsafe fn hidesBarsWhenVerticallyCompact(&self) -> bool

When the UINavigationController’s vertical size class is compact, hide the UINavigationBar and UIToolbar. Unhandled taps in the regions that would normally be occupied by these bars will reveal the bars.

pub unsafe fn setHidesBarsWhenVerticallyCompact( &self, hides_bars_when_vertically_compact: bool, )

Setter for hidesBarsWhenVerticallyCompact.

pub unsafe fn hidesBarsOnTap(&self) -> bool

When the user taps, the navigation controller’s navigationBar & toolbar will be hidden or shown, depending on the hidden state of the navigationBar. The toolbar will only be shown if it has items to display.

pub unsafe fn setHidesBarsOnTap(&self, hides_bars_on_tap: bool)

Setter for hidesBarsOnTap.

pub unsafe fn barHideOnTapGestureRecognizer( &self, ) -> Retained<UITapGestureRecognizer>

Available on crate features UIGestureRecognizer and UITapGestureRecognizer only.

The gesture recognizer used to recognize if the bars will hide or show due to a tap in content. Do not change the delegate or attempt to replace this gesture by overriding this method.

Methods from Deref<Target = UIViewController>

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

Available on crate feature UINavigationItem only.

pub unsafe fn hidesBottomBarWhenPushed(&self) -> bool

pub unsafe fn setHidesBottomBarWhenPushed( &self, hides_bottom_bar_when_pushed: bool, )

Setter for hidesBottomBarWhenPushed.

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

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

Available on crate features UIBarButtonItem and UIBarItem only.

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

Available on crate features UIBarButtonItem and UIBarItem only.

Setter for toolbarItems.

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

Available on crate features UIBarButtonItem and UIBarItem only.

pub unsafe fn isModalInPopover(&self) -> bool

👎Deprecated

Available on crate feature UIPopoverSupport only.

pub unsafe fn setModalInPopover(&self, modal_in_popover: bool)

👎Deprecated

Available on crate feature UIPopoverSupport only.

Setter for isModalInPopover.

pub unsafe fn contentSizeForViewInPopover(&self) -> CGSize

👎Deprecated

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

pub unsafe 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 unsafe fn splitViewController( &self, ) -> Option<Retained<UISplitViewController>>

Available on crate feature UISplitViewController only.

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

Available on crate feature UISplitViewController only.

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

Available on crate feature UISplitViewController only.

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

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

Available on crate feature UITabBarController only.

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

👎Deprecated: Use -setContentScrollView:forEdge: instead.

Available on crate features UITabBarController and UIScrollView and UIView only.

pub unsafe 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 unsafe fn loadView(&self)

pub unsafe fn loadViewIfNeeded(&self)

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

Available on crate feature UIView only.

pub unsafe fn viewWillUnload(&self)

👎Deprecated

pub unsafe fn viewDidUnload(&self)

👎Deprecated

pub unsafe fn viewDidLoad(&self)

pub unsafe fn isViewLoaded(&self) -> bool

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

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

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

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

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

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.

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.

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.

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

👎Deprecated

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

pub unsafe 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 unsafe 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 unsafe 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 unsafe 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 unsafe fn viewDidAppear(&self, animated: bool)

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

pub unsafe fn viewWillDisappear(&self, animated: bool)

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

pub unsafe fn viewDidDisappear(&self, animated: bool)

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

pub unsafe fn viewWillLayoutSubviews(&self)

pub unsafe fn viewDidLayoutSubviews(&self)

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

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

Setter for title.

pub unsafe fn didReceiveMemoryWarning(&self)

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

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

👎Deprecated

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

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

pub unsafe fn definesPresentationContext(&self) -> bool

pub unsafe fn setDefinesPresentationContext( &self, defines_presentation_context: bool, )

Setter for definesPresentationContext.

pub unsafe fn providesPresentationContextTransitionStyle(&self) -> bool

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

Setter for providesPresentationContextTransitionStyle.

pub unsafe fn restoresFocusAfterTransition(&self) -> bool

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

Setter for restoresFocusAfterTransition.

pub unsafe 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 unsafe fn setFocusGroupIdentifier( &self, focus_group_identifier: Option<&NSString>, )

Setter for focusGroupIdentifier.

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

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

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

Setter for interactionActivityTrackingBaseName.

pub unsafe fn isBeingPresented(&self) -> bool

pub unsafe fn isBeingDismissed(&self) -> bool

pub unsafe fn isMovingToParentViewController(&self) -> bool

pub unsafe fn isMovingFromParentViewController(&self) -> bool

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

Available on crate feature block2 only.

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

Available on crate feature block2 only.

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

👎Deprecated

pub unsafe fn dismissModalViewControllerAnimated(&self, animated: bool)

👎Deprecated

pub unsafe fn modalTransitionStyle(&self) -> UIModalTransitionStyle

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

Setter for modalTransitionStyle.

pub unsafe 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 unsafe fn setPreferredTransition( &self, preferred_transition: Option<&UIViewControllerTransition>, )

Available on crate feature UIViewControllerTransition only.

Setter for preferredTransition.

pub unsafe fn modalPresentationStyle(&self) -> UIModalPresentationStyle

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

Setter for modalPresentationStyle.

pub unsafe fn modalPresentationCapturesStatusBarAppearance(&self) -> bool

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

Setter for modalPresentationCapturesStatusBarAppearance.

pub unsafe fn disablesAutomaticKeyboardDismissal(&self) -> bool

pub unsafe fn wantsFullScreenLayout(&self) -> bool

👎Deprecated

pub unsafe fn setWantsFullScreenLayout(&self, wants_full_screen_layout: bool)

👎Deprecated

Setter for wantsFullScreenLayout.

pub unsafe fn edgesForExtendedLayout(&self) -> UIRectEdge

Available on crate feature UIGeometry only.

pub unsafe fn setEdgesForExtendedLayout( &self, edges_for_extended_layout: UIRectEdge, )

Available on crate feature UIGeometry only.

Setter for edgesForExtendedLayout.

pub unsafe fn extendedLayoutIncludesOpaqueBars(&self) -> bool

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

Setter for extendedLayoutIncludesOpaqueBars.

pub unsafe fn automaticallyAdjustsScrollViewInsets(&self) -> bool

👎Deprecated: Use UIScrollView’s contentInsetAdjustmentBehavior instead

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

👎Deprecated: Use UIScrollView’s contentInsetAdjustmentBehavior instead

Setter for automaticallyAdjustsScrollViewInsets.

pub unsafe 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 unsafe 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 unsafe fn preferredContentSize(&self) -> CGSize

Available on crate feature objc2-core-foundation only.

pub unsafe fn setPreferredContentSize(&self, preferred_content_size: CGSize)

Available on crate feature objc2-core-foundation only.

Setter for preferredContentSize.

pub unsafe fn preferredStatusBarStyle(&self) -> UIStatusBarStyle

👎Deprecated: Has no effect on visionOS

Available on crate feature UIApplication only.

pub unsafe fn prefersStatusBarHidden(&self) -> bool

👎Deprecated: Has no effect on visionOS

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

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

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

pub unsafe fn preferredUserInterfaceStyle(&self) -> UIUserInterfaceStyle

Available on crate feature UIInterface only.

pub unsafe fn setNeedsUserInterfaceAppearanceUpdate(&self)

pub unsafe fn overrideUserInterfaceStyle(&self) -> UIUserInterfaceStyle

Available on crate feature UIInterface only.

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

Available on crate feature UIInterface only.

Setter for overrideUserInterfaceStyle.

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

👎Deprecated

Available on crate feature UIOrientation only.

pub unsafe fn shouldAutorotate(&self) -> bool

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

pub unsafe fn supportedInterfaceOrientations( &self, ) -> UIInterfaceOrientationMask

Available on crate feature UIOrientation only.

pub unsafe fn preferredInterfaceOrientationForPresentation( &self, ) -> UIInterfaceOrientation

Available on crate feature UIOrientation only.

pub unsafe 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 unsafe 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 unsafe 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 unsafe fn interfaceOrientation(&self) -> UIInterfaceOrientation

👎Deprecated

Available on crate feature UIOrientation only.

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

👎Deprecated: Implement viewWillTransitionToSize:withTransitionCoordinator: instead

Available on crate feature UIOrientation only.

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

👎Deprecated

Available on crate feature UIOrientation only.

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

👎Deprecated: Implement viewWillTransitionToSize:withTransitionCoordinator: instead

Available on crate feature UIOrientation only.

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

👎Deprecated

Available on crate feature UIOrientation only.

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

👎Deprecated

Available on crate feature UIOrientation only.

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

👎Deprecated

Available on crate feature UIOrientation only.

pub unsafe fn isEditing(&self) -> bool

pub unsafe fn setEditing(&self, editing: bool)

Setter for isEditing.

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

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

Available on crate features UIBarButtonItem and UIBarItem only.

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

👎Deprecated

Available on crate feature UISearchDisplayController only.

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

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

pub unsafe fn removeFromParentViewController(&self)

pub unsafe 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 unsafe fn beginAppearanceTransition_animated( &self, is_appearing: bool, animated: bool, )

pub unsafe fn endAppearanceTransition(&self)

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

👎Deprecated: Has no effect on visionOS

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

👎Deprecated: Has no effect on visionOS

pub unsafe 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 unsafe 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 unsafe fn childViewControllerForUserInterfaceStyle( &self, ) -> Option<Retained<UIViewController>>

pub unsafe fn automaticallyForwardAppearanceAndRotationMethodsToChildViewControllers( &self, ) -> bool

👎Deprecated

pub unsafe fn shouldAutomaticallyForwardRotationMethods(&self) -> bool

👎Deprecated: Manually forward viewWillTransitionToSize:withTransitionCoordinator: if necessary

pub unsafe fn shouldAutomaticallyForwardAppearanceMethods(&self) -> bool

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

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

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

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

Setter for restorationIdentifier.

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

Available on crate feature UIStateRestoration only.

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

Available on crate feature UIStateRestoration only.

Setter for restorationClass.

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

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

pub unsafe fn applicationFinishedRestoringState(&self)

pub unsafe fn updateViewConstraints(&self)

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

Available on crate feature UIViewControllerTransitioning only.

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

Available on crate feature UIViewControllerTransitioning only.

This is a weak property. Setter for transitioningDelegate.

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

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

Available on crate feature NSLayoutConstraint only.

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

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

Available on crate feature NSLayoutConstraint only.

pub unsafe fn additionalSafeAreaInsets(&self) -> UIEdgeInsets

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

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

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

Setter for additionalSafeAreaInsets.

pub unsafe fn systemMinimumLayoutMargins(&self) -> NSDirectionalEdgeInsets

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

pub unsafe fn viewRespectsSystemMinimumLayoutMargins(&self) -> bool

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

Setter for viewRespectsSystemMinimumLayoutMargins.

pub unsafe fn viewLayoutMarginsDidChange(&self)

pub unsafe fn viewSafeAreaInsetsDidChange(&self)

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

Available on crate features UICommand and UIKeyCommand and UIMenuElement only.

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

Available on crate features UICommand and UIKeyCommand and UIMenuElement only.

pub unsafe 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 unsafe fn extensionContext(&self) -> Option<Retained<NSExtensionContext>>

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

Available on crate feature UIPresentationController only.

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

Available on crate features UIPresentationController and UISheetPresentationController only.

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

Available on crate features UIPopoverPresentationController and UIPresentationController only.

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

Available on crate feature UIPresentationController only.

pub unsafe fn isModalInPresentation(&self) -> bool

pub unsafe fn setModalInPresentation(&self, modal_in_presentation: bool)

Setter for isModalInPresentation.

pub unsafe 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 unsafe fn unregisterForPreviewingWithContext( &self, previewing: &ProtocolObject<dyn UIViewControllerPreviewing>, )

👎Deprecated: UIViewControllerPreviewing is deprecated. Please use UIContextMenuInteraction.

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

pub unsafe fn preferredScreenEdgesDeferringSystemGestures(&self) -> UIRectEdge

Available on crate feature UIGeometry only.

pub fn setNeedsUpdateOfScreenEdgesDeferringSystemGestures(&self)

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

pub unsafe fn prefersHomeIndicatorAutoHidden(&self) -> bool

pub fn setNeedsUpdateOfHomeIndicatorAutoHidden(&self)

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

pub unsafe fn prefersPointerLocked(&self) -> bool

pub unsafe fn setNeedsUpdateOfPrefersPointerLocked(&self)

pub unsafe 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 unsafe fn setContentUnavailableConfiguration( &self, content_unavailable_configuration: Option<&ProtocolObject<dyn UIContentConfiguration>>, )

Available on crate feature UIContentConfiguration only.

Setter for contentUnavailableConfiguration.

pub unsafe 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 unsafe 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 unsafe 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 unsafe fn previewActionItems( &self, ) -> Retained<NSArray<ProtocolObject<dyn UIPreviewActionItem>>>

👎Deprecated: UIViewControllerPreviewing is deprecated. Please use UIContextMenuInteraction.

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

Available on crate feature UITraitCollection only.

pub unsafe 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 unsafe fn preferredContainerBackgroundStyle( &self, ) -> UIContainerBackgroundStyle

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

pub unsafe fn setNeedsUpdateOfPreferredContainerBackgroundStyle(&self)

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

Available on crate feature UIViewControllerTransitionCoordinator only.

Methods from Deref<Target = UIResponder>

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

pub unsafe fn canBecomeFirstResponder(&self) -> bool

pub unsafe fn becomeFirstResponder(&self) -> bool

pub unsafe fn canResignFirstResponder(&self) -> bool

pub unsafe fn resignFirstResponder(&self) -> bool

pub unsafe fn isFirstResponder(&self) -> bool

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

Available on crate features UIEvent and UITouch only.

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

Available on crate features UIEvent and UITouch only.

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

Available on crate features UIEvent and UITouch only.

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

Available on crate features UIEvent and UITouch only.

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

Available on crate feature UITouch only.

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

Available on crate features UIEvent and UIPress and UIPressesEvent only.

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

Available on crate features UIEvent and UIPress and UIPressesEvent only.

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

Available on crate features UIEvent and UIPress and UIPressesEvent only.

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

Available on crate features UIEvent and UIPress and UIPressesEvent only.

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

Available on crate feature UIEvent only.

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

Available on crate feature UIEvent only.

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

Available on crate feature UIEvent only.

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

Available on crate feature UIEvent only.

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

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

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

Available on crate feature UIMenuBuilder only.

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

Available on crate features UICommand and UIMenuElement only.

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

pub unsafe fn editingInteractionConfiguration( &self, ) -> UIEditingInteractionConfiguration

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

Available on crate features UICommand and UIKeyCommand and UIMenuElement only.

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

Available on crate feature UIView only.

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

Available on crate feature UIView only.

pub unsafe 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 unsafe fn inputViewController( &self, ) -> Option<Retained<UIInputViewController>>

Available on crate feature UIInputViewController only.

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

Available on crate feature UIInputViewController only.

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

Available on crate feature UITextInput only.

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

pub unsafe fn reloadInputViews(&self)

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

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

Setter for userActivity.

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

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

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

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

Available on crate features UIResponder_UIActivityItemsConfiguration and UIActivityItemsConfigurationReading only.

pub unsafe 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 UIImagePickerController

fn as_ref(&self) -> &AnyObject

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

impl AsRef<NSObject> for UIImagePickerController

fn as_ref(&self) -> &NSObject

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

impl AsRef<UIImagePickerController> for UIImagePickerController

fn as_ref(&self) -> &Self

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

impl AsRef<UINavigationController> for UIImagePickerController

fn as_ref(&self) -> &UINavigationController

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

impl AsRef<UIResponder> for UIImagePickerController

fn as_ref(&self) -> &UIResponder

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

impl AsRef<UIViewController> for UIImagePickerController

fn as_ref(&self) -> &UIViewController

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

impl Borrow<AnyObject> for UIImagePickerController

fn borrow(&self) -> &AnyObject

Immutably borrows from an owned value.

impl Borrow<NSObject> for UIImagePickerController

fn borrow(&self) -> &NSObject

Immutably borrows from an owned value.

impl Borrow<UINavigationController> for UIImagePickerController

fn borrow(&self) -> &UINavigationController

Immutably borrows from an owned value.

impl Borrow<UIResponder> for UIImagePickerController

fn borrow(&self) -> &UIResponder

Immutably borrows from an owned value.

impl Borrow<UIViewController> for UIImagePickerController

fn borrow(&self) -> &UIViewController

Immutably borrows from an owned value.

impl ClassType for UIImagePickerController

const NAME: &'static str = "UIImagePickerController"

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

type Super = UINavigationController

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 UIImagePickerController

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

Formats the value using the given formatter.

impl Deref for UIImagePickerController

type Target = UINavigationController

The resulting type after dereferencing.

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

Dereferences the value.

impl Hash for UIImagePickerController

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 UIImagePickerController

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

where Self: Sized,

Increment the reference count of the receiver.

impl NSCoding for UIImagePickerController

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

where Self: Sized + Message,

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

where Self: Sized + Message,

impl NSObjectProtocol for UIImagePickerController

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 UIImagePickerController

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 UIImagePickerController

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

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

impl UIContentContainer for UIImagePickerController

unsafe fn preferredContentSize(&self) -> CGSize

where Self: Sized + Message,

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

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

where Self: Sized + Message,

Available on crate feature UIViewController only.

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

where Self: Sized + Message,

Available on crate feature UIViewController only.

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

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

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

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

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

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

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

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

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

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

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

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

where Self: Sized + Message,

👎Deprecated

Available on crate features UIResponder and UIView and UIFocus only.

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

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

where Self: Sized + Message,

Available on crate feature UIResponder only.

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

where Self: Sized + Message,

Available on crate feature UIResponder only.

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

where Self: Sized + Message,

Available on crate feature UIResponder only.

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

where Self: Sized + Message,

Available on crate feature UIResponder only.

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

where Self: Sized + Message,

Available on crate feature UIResponder only.

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

where Self: Sized + Message,

Available on crate feature UIResponder only.

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

where Self: Sized + Message,

Available on crate feature UIResponder only.

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

where Self: Sized + Message,

Available on crate feature UIResponder only.

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

where Self: Sized + Message,

Available on crate feature UIResponder only.

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

where Self: Sized + Message,

Available on crate feature UIResponder only.

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

where Self: Sized + Message,

Available on crate feature UIResponder only.

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

where Self: Sized + Message,

Available on crate feature UIResponder only.

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

where Self: Sized + Message,

Available on crate feature UIResponder only.

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

where Self: Sized + Message,

Available on crate feature UIResponder only.

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

where Self: Sized + Message,

Available on crate feature UIResponder only.

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

where Self: Sized + Message,

Available on crate feature UIResponder only.

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

where Self: Sized + Message,

Available on crate feature UIResponder only.

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

where Self: Sized + Message,

Available on crate feature UIResponder only.

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

where Self: Sized + Message,

Available on crate feature UIResponder only.

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

where Self: Sized + Message,

Available on crate feature UIResponder only.

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

where Self: Sized + Message,

Available on crate feature UIResponder only.

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

where Self: Sized + Message,

Available on crate features UIResponder and block2 only.

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

where Self: Sized + Message,

Available on crate feature UIResponder only.

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

where Self: Sized + Message,

Available on crate feature UIResponder only.

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

where Self: Sized + Message,

Available on crate feature UIResponder only.

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

where Self: Sized + Message,

Available on crate feature UIResponder only.

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

where Self: Sized + Message,

Available on crate feature UIResponder only.

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

where Self: Sized + Message,

Available on crate feature UIResponder only.

impl UITraitEnvironment for UIImagePickerController

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

where Self: Sized + Message,

Available on crate feature UITraitCollection only.

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

impl Eq for UIImagePickerController

impl UIAppearanceContainer for UIImagePickerController