Struct MFMessageComposeViewController

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

Available on crate features MFMessageComposeViewController and objc2-ui-kit only.

The MFMessageComposeViewController class provides an interface for editing and sending a message.

The MFMessageComposeViewController class manages all user interaction. The client needs to set the recipient or recipients. The client may also set the body of the message. After setup, the client needs to only display the view.

The provided delegate will be informed of the user's composition completion and how they chose to complete the operation.

Prior to use, clients should verify the user has set up the device for sending messages via +[MFMessageComposeViewController canSendText] .

See also Apple’s documentation

Implementations

impl MFMessageComposeViewController

pub unsafe fn canSendText(mtm: MainThreadMarker) -> bool

Returns YES if the user has set up the device for sending text only messages.

If the return value is YES, the client can set the recipients and body of the message. If the return value is NO, the client may notify the user of the failure, or the client may open an SMS URL via -[UIApplication openURL:] .

pub unsafe fn canSendSubject(mtm: MainThreadMarker) -> bool

Returns YES if the user has set up the device for including subjects in messages. .

pub unsafe fn canSendAttachments(mtm: MainThreadMarker) -> bool

Returns YES if the user has set up the device for including attachments in messages. .

pub unsafe fn isSupportedAttachmentUTI( uti: &NSString, mtm: MainThreadMarker, ) -> bool

Returns YES if the attachment at the specified URL could be accepted by the current composition.

If the return value is YES, the UTI is acceptable for attachment to a message, a return value of NO indicates that the given UTI is unsupported.

pub unsafe fn messageComposeDelegate( &self, ) -> Option<Retained<ProtocolObject<dyn MFMessageComposeViewControllerDelegate>>>

This property is the delegate for the MFMessageComposeViewController method callbacks.

pub unsafe fn setMessageComposeDelegate( &self, message_compose_delegate: Option<&ProtocolObject<dyn MFMessageComposeViewControllerDelegate>>, )

This is a weak property. Setter for messageComposeDelegate.

pub unsafe fn disableUserAttachments(&self)

Calling this method will disable the camera/attachment button in the view controller. After the controller has been presented, this call will have no effect. The camera / attachment button is visible by default.

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

This property sets the initial value of the To field for the message to the specified addresses.

This property will set the initial value of the To field for the message from an NSArray of NSString instances specifying the message addresses of recipients. This should be called prior to display.

After the view has been presented to the user, this property will no longer change the value.

pub unsafe fn setRecipients(&self, recipients: Option<&NSArray<NSString>>)

Setter for recipients.

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

This property sets the initial value of the body of the message to the specified content.

This property will set the initial value of the body of the message. This should be called prior to display.

After the view has been presented to the user, this property will no longer change the value.

pub unsafe fn setBody(&self, body: Option<&NSString>)

Setter for body.

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

This property sets the initial value of the subject of the message to the specified content.

This property will set the initial value of the subject of the message. This should be called prior to display.

After the view has been presented to the user, this property will no longer change the value.

pub unsafe fn setSubject(&self, subject: Option<&NSString>)

Setter for subject.

pub unsafe fn attachments(&self) -> Option<Retained<NSArray<NSDictionary>>>

This property returns an NSArray of NSDictionaries describing the properties of the current attachments.

This property returns an NSArray of NSDictionaries describing the properties of the current attachments. See MFMessageComposeViewControllerAttachmentURL, MFMessageComposeViewControllerAttachmentAlternateFilename.

pub unsafe fn message(&self) -> Option<Retained<MSMessage>>

Available on crate feature objc2-messages and non-visionOS only.

This property sets the initial interactive message.

pub unsafe fn setMessage(&self, message: Option<&MSMessage>)

Available on crate feature objc2-messages and non-visionOS only.

Setter for message.

pub unsafe fn addAttachmentURL_withAlternateFilename( &self, attachment_url: &NSURL, alternate_filename: Option<&NSString>, ) -> bool

Returns YES if the attachment at the specified URL was added to the composition successfully.

If the return value is YES, the attachment was added to the composition. If the return value is NO, the attachment was not added to the composition. All attachment URLs must be file urls. The file URL must not be NIL. The alternate filename will be display to the user in leiu of the attachments URL. The alternate filename may be NIL.

pub unsafe fn addAttachmentData_typeIdentifier_filename( &self, attachment_data: &NSData, uti: &NSString, filename: &NSString, ) -> bool

Returns YES if the attachment was added to the composition successfully.

If the return value is YES, the attachment was added to the composition. If the return value is NO, the attachment was not added to the composition. The data and typeIdentifer must be non-nil. typeIdentifier should be a valid Uniform Type Identifier.

pub unsafe fn insertCollaborationItemProvider( &self, item_provider: &NSItemProvider, ) -> bool

Parameter itemProvider: created from ShareSheet

Returns YES if the item provider was added to the composition successfully.

If the return value is YES, the itemProvider was added to the composition. If the return value is NO, the itemProvider was not added to the composition. The itemProvider must be non-nil.

impl MFMessageComposeViewController

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 MFMessageComposeViewController

Methods declared on superclass NSObject.

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

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

impl MFMessageComposeViewController

UPI.

pub unsafe fn setUPIVerificationCodeSendCompletion( &self, completion: &DynBlock<dyn Fn(Bool)>, )

Available on crate features UPI and block2 only.

Configures the instance of MFMessageComposeViewController for UPI device validation

If the host app has the com.apple.developer.upi-device-validation managed entitlement, this will configure the instance of MFMessageComposeViewController with non-editable recipients and body fields. This API is only functional on devices with SMS capability and is only compatible with non-iMessagable recipients. The send completion handler will be invoked with YES only once the SMS was successfully transmitted to the sender’s cellular carrier. If the SMS failed to send, the completion handler will be invoked with NO.

The completion handler will be in invoked on the main thread. It will only be invoked after MFMessageComposeViewController delegate’s -messageComposeViewController:didFinishWithResult: method was called. That method is called in response to user action (the user hit cancel or send); the send completion handler is called with the transmission result of the message. It will not be called at all if -messageComposeViewController:didFinishWithResult: was not called with MessageComposeResultSent.

Because it can take some time to send a message, the completion handler could be invoked after the MFMessageComposeViewController instance is deallocated.

Parameter completion: A block invoked with a BOOL of whether the message was actually sent.

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

Methods from Deref<Target = UIViewController>

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

pub unsafe fn loadViewIfNeeded(&self)

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 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 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 viewControllerForUnwindSegueAction_fromViewController_withSender( &self, action: Sel, from_view_controller: &UIViewController, sender: Option<&AnyObject>, ) -> Option<Retained<UIViewController>>

👎Deprecated

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 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 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 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 prefersStatusBarHidden(&self) -> bool

👎Deprecated: Has no effect on visionOS

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 setNeedsUserInterfaceAppearanceUpdate(&self)

pub unsafe fn shouldAutorotate(&self) -> bool

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

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 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 childViewControllers(&self) -> Retained<NSArray<UIViewController>>

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

pub unsafe fn removeFromParentViewController(&self)

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

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

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

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 encodeRestorableStateWithCoder(&self, coder: &NSCoder)

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

pub unsafe fn applicationFinishedRestoringState(&self)

pub unsafe fn updateViewConstraints(&self)

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 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 isModalInPresentation(&self) -> bool

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

Setter for isModalInPresentation.

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

👎Deprecated: UIViewControllerPreviewing is deprecated. Please use UIContextMenuInteraction.

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

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)

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 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 undoManager(&self) -> Option<Retained<NSUndoManager>>

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

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>)

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

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.

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,

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 MFMessageComposeViewController

fn as_ref(&self) -> &AnyObject

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

impl AsRef<MFMessageComposeViewController> for MFMessageComposeViewController

fn as_ref(&self) -> &Self

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

impl AsRef<NSObject> for MFMessageComposeViewController

fn as_ref(&self) -> &NSObject

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

impl AsRef<UINavigationController> for MFMessageComposeViewController

fn as_ref(&self) -> &UINavigationController

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

impl AsRef<UIResponder> for MFMessageComposeViewController

fn as_ref(&self) -> &UIResponder

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

impl AsRef<UIViewController> for MFMessageComposeViewController

fn as_ref(&self) -> &UIViewController

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

impl Borrow<AnyObject> for MFMessageComposeViewController

fn borrow(&self) -> &AnyObject

Immutably borrows from an owned value.

impl Borrow<NSObject> for MFMessageComposeViewController

fn borrow(&self) -> &NSObject

Immutably borrows from an owned value.

impl Borrow<UINavigationController> for MFMessageComposeViewController

fn borrow(&self) -> &UINavigationController

Immutably borrows from an owned value.

impl Borrow<UIResponder> for MFMessageComposeViewController

fn borrow(&self) -> &UIResponder

Immutably borrows from an owned value.

impl Borrow<UIViewController> for MFMessageComposeViewController

fn borrow(&self) -> &UIViewController

Immutably borrows from an owned value.

impl ClassType for MFMessageComposeViewController

const NAME: &'static str = "MFMessageComposeViewController"

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

type Super = UINavigationController

The superclass of this class.

type ThreadKind = <<MFMessageComposeViewController as ClassType>::Super as ClassType>::ThreadKind

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 MFMessageComposeViewController

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

Formats the value using the given formatter.

impl Deref for MFMessageComposeViewController

type Target = UINavigationController

The resulting type after dereferencing.

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

Dereferences the value.

impl Hash for MFMessageComposeViewController

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 MFMessageComposeViewController

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

where Self: Sized,

Increment the reference count of the receiver.

impl NSCoding for MFMessageComposeViewController

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 MFMessageComposeViewController

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 MFMessageComposeViewController

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 MFMessageComposeViewController

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

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

impl UIContentContainer for MFMessageComposeViewController

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

where Self: Sized + Message,

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

where Self: Sized + Message,

impl UIFocusEnvironment for MFMessageComposeViewController

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

where Self: Sized + Message,

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

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

where Self: Sized + Message,

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

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

where Self: Sized + Message,

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

unsafe fn setNeedsFocusUpdate(&self)

where Self: Sized + Message,

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

unsafe fn updateFocusIfNeeded(&self)

where Self: Sized + Message,

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

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

where Self: Sized + Message,

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

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

where Self: Sized + Message,

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

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

where Self: Sized + Message,

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

impl UIResponderStandardEditActions for MFMessageComposeViewController

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

where Self: Sized + Message,

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

where Self: Sized + Message,

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

where Self: Sized + Message,

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

where Self: Sized + Message,

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

where Self: Sized + Message,

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

where Self: Sized + Message,

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

where Self: Sized + Message,

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

where Self: Sized + Message,

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

where Self: Sized + Message,

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

where Self: Sized + Message,

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

where Self: Sized + Message,

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

where Self: Sized + Message,

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

where Self: Sized + Message,

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

where Self: Sized + Message,

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

where Self: Sized + Message,

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

where Self: Sized + Message,

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

where Self: Sized + Message,

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

where Self: Sized + Message,

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

where Self: Sized + Message,

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

where Self: Sized + Message,

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

where Self: Sized + Message,

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

where Self: Sized + Message,

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

where Self: Sized + Message,

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

where Self: Sized + Message,

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

where Self: Sized + Message,

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

where Self: Sized + Message,

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

where Self: Sized + Message,

impl UITraitEnvironment for MFMessageComposeViewController

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

where Self: Sized + Message,

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

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

impl DowncastTarget for MFMessageComposeViewController

impl Eq for MFMessageComposeViewController

impl UIAppearanceContainer for MFMessageComposeViewController