Struct MFMailComposeViewController 

pub struct MFMailComposeViewController { /* private fields */ }

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

The MFMailComposeViewController class provides an interface for editing and sending email.

The MFMailComposeViewController class manages all user interaction. The client needs to set the recipient or recipients. The client may also set the subject and the body of the message. Attachments may be added, if so desired. 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 email via +[MFMailComposeViewController canSendMail] .

See also Apple’s documentation

Implementations

impl MFMailComposeViewController

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

Returns YES if the user has set up the device for sending email.

The client may continue to set the recipients and content if the return value was YES . If NO was the result, the client has a couple options. It may choose to simply notify the user of the inability to send mail, or it may issue a “mailto” URL via -[UIApplication openURL:] .

pub unsafe fn mailComposeDelegate( &self, ) -> Option<Retained<ProtocolObject<dyn MFMailComposeViewControllerDelegate>>>

This property is the delegate for the MFMailComposeViewControllerDelegate method callbacks.

pub unsafe fn setMailComposeDelegate( &self, mail_compose_delegate: Option<&ProtocolObject<dyn MFMailComposeViewControllerDelegate>>, )

Setter for mailComposeDelegate.

This is a weak property.

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

This method sets the Subject header for the email message.

This method will set the Subject header for the email message. This should be called prior to display. Newlines are removed from the parameter.

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

Parameter subject: A NSString specifying the message’s Subject header.

pub unsafe fn setToRecipients(&self, to_recipients: Option<&NSArray<NSString>>)

This method sets the To header for the email message to the specified email addresses.

This method will set the To header for the email message. This should be called prior to display.

Recipient addresses should be specified as per RFC5322.

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

Parameter toRecipients: A NSArray of NSString instances specifying the email addresses of recipients.

pub unsafe fn setCcRecipients(&self, cc_recipients: Option<&NSArray<NSString>>)

This method sets the CC header for the email message to the specified email addresses.

This method will set the CC header for the email message. This should be called prior to display.

Recipient addresses should be specified as per RFC5322.

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

Parameter ccRecipients: A NSArray of NSString instances specifying the email addresses of recipients.

pub unsafe fn setBccRecipients( &self, bcc_recipients: Option<&NSArray<NSString>>, )

This method sets the BCC header for the email message to the specified email addresses.

This method will set the BCC header for the email message. This should be called prior to display.

Recipient addresses should be specified as per RFC5322.

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

Parameter bccRecipients: A NSArray of NSString instances specifying the email addresses of recipients.

pub unsafe fn setMessageBody_isHTML(&self, body: &NSString, is_html: bool)

This method sets the body of the email message to the specified content.

This method will set the body of the email message. This should be called prior to display. The user’s signature, if specified, will be added after the body content.

Parameter body: A NSString containing the body contents of the email message.

Parameter isHTML: A boolean value indicating if the body argument is to be interpreted as HTML content.

pub unsafe fn addAttachmentData_mimeType_fileName( &self, attachment: &NSData, mime_type: &NSString, filename: &NSString, )

This method adds the specified attachment to the email message.

This method adds the specified attachment to the email message. This should be called prior to display. Attachments will be appended to the end of the message.

Parameter attachment: NSData containing the contents of the attachment. Must not be nil .

Parameter mimeType: NSString specifying the MIME type for the attachment, as specified by the IANA (http://www.iana.org/assignments/media-types/). Must not be nil .

Parameter filename: NSString specifying the intended filename for the attachment. This is displayed below the attachment’s icon if the attachment is not decoded when displayed. Must not be nil .

pub unsafe fn setPreferredSendingEmailAddress(&self, email_address: &NSString)

This method sets the preferred sending account of the email message.

This method will set the sending account of the message to the specified email address if the user has an account with such an address set up. If there is no account with such an address, the default account will be used instead. The sending email address should be specified as per RFC5322. After the view has been presented to the user, this method will no longer change the value.

Parameter emailAddress: A NSString specifying the preferred email address used to send this message.

pub unsafe fn insertCollaborationItemProvider_completionHandler( &self, item_provider: &NSItemProvider, completion_handler: &DynBlock<dyn Fn(Bool)>, )

Available on crate feature block2 only.

Parameter itemProvider: specifying the intended content for collaboration

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. The itemProvider must be non-nil.

impl MFMailComposeViewController

Methods declared on superclass UINavigationController.

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

Safety

• navigation_bar_class probably has further requirements.
• toolbar_class probably has further requirements.

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

Safety

a_decoder possibly has further requirements.

impl MFMailComposeViewController

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 fn pushViewController_animated( &self, view_controller: &UIViewController, animated: bool, )

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

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

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

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

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

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

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

Setter for viewControllers.

This is copied when set.

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

pub fn isNavigationBarHidden(&self) -> bool

pub fn setNavigationBarHidden(&self, navigation_bar_hidden: bool)

Setter for isNavigationBarHidden.

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

pub fn isToolbarHidden(&self) -> bool

pub fn setToolbarHidden(&self, toolbar_hidden: bool)

Setter for isToolbarHidden.

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

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

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

Setter for delegate.

This is a weak property.

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

Safety

sender should be of the correct type.

pub 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 fn setHidesBarsWhenKeyboardAppears( &self, hides_bars_when_keyboard_appears: bool, )

Setter for hidesBarsWhenKeyboardAppears.

pub 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 fn setHidesBarsOnSwipe(&self, hides_bars_on_swipe: bool)

Setter for hidesBarsOnSwipe.

pub 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 fn setHidesBarsWhenVerticallyCompact( &self, hides_bars_when_vertically_compact: bool, )

Setter for hidesBarsWhenVerticallyCompact.

pub 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 fn setHidesBarsOnTap(&self, hides_bars_on_tap: bool)

Setter for hidesBarsOnTap.

Methods from Deref<Target = UIViewController>

pub fn hidesBottomBarWhenPushed(&self) -> bool

pub fn setHidesBottomBarWhenPushed(&self, hides_bottom_bar_when_pushed: bool)

Setter for hidesBottomBarWhenPushed.

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

pub fn loadView(&self)

pub fn loadViewIfNeeded(&self)

pub fn viewWillUnload(&self)

👎Deprecated

pub fn viewDidUnload(&self)

👎Deprecated

pub fn viewDidLoad(&self)

pub fn isViewLoaded(&self) -> bool

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

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

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

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

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

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

Safety

sender should be of the correct type.

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

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

Safety

sender should be of the correct type.

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

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

Safety

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

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

👎Deprecated

Safety

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

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

👎Deprecated

Safety

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

pub fn viewWillAppear(&self, animated: bool)

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

pub fn viewIsAppearing(&self, animated: bool)

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

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

pub fn viewDidAppear(&self, animated: bool)

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

pub fn viewWillDisappear(&self, animated: bool)

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

pub fn viewDidDisappear(&self, animated: bool)

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

pub fn setNeedsUpdateProperties(&self)

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

pub fn updateProperties(&self)

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

pub fn updatePropertiesIfNeeded(&self)

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

pub fn viewWillLayoutSubviews(&self)

pub fn viewDidLayoutSubviews(&self)

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

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

Setter for title.

This is copied when set.

pub fn didReceiveMemoryWarning(&self)

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

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

👎Deprecated

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

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

pub fn definesPresentationContext(&self) -> bool

pub fn setDefinesPresentationContext(&self, defines_presentation_context: bool)

Setter for definesPresentationContext.

pub fn providesPresentationContextTransitionStyle(&self) -> bool

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

Setter for providesPresentationContextTransitionStyle.

pub fn restoresFocusAfterTransition(&self) -> bool

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

Setter for restoresFocusAfterTransition.

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

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

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

Setter for focusGroupIdentifier.

This is copied when set.

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

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

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

Setter for interactionActivityTrackingBaseName.

This is copied when set.

pub fn isBeingPresented(&self) -> bool

pub fn isBeingDismissed(&self) -> bool

pub fn isMovingToParentViewController(&self) -> bool

pub fn isMovingFromParentViewController(&self) -> bool

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

👎Deprecated

pub fn dismissModalViewControllerAnimated(&self, animated: bool)

👎Deprecated

pub fn modalTransitionStyle(&self) -> UIModalTransitionStyle

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

Setter for modalTransitionStyle.

pub fn modalPresentationStyle(&self) -> UIModalPresentationStyle

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

Setter for modalPresentationStyle.

pub fn modalPresentationCapturesStatusBarAppearance(&self) -> bool

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

Setter for modalPresentationCapturesStatusBarAppearance.

pub fn disablesAutomaticKeyboardDismissal(&self) -> bool

pub fn wantsFullScreenLayout(&self) -> bool

👎Deprecated

pub fn setWantsFullScreenLayout(&self, wants_full_screen_layout: bool)

👎Deprecated

Setter for wantsFullScreenLayout.

pub fn extendedLayoutIncludesOpaqueBars(&self) -> bool

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

Setter for extendedLayoutIncludesOpaqueBars.

pub fn automaticallyAdjustsScrollViewInsets(&self) -> bool

👎Deprecated: Use UIScrollView’s contentInsetAdjustmentBehavior instead

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

👎Deprecated: Use UIScrollView’s contentInsetAdjustmentBehavior instead

Setter for automaticallyAdjustsScrollViewInsets.

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

Safety

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

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

Safety

sender should be of the correct type.

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

Safety

sender should be of the correct type.

pub fn setNeedsUserInterfaceAppearanceUpdate(&self)

pub fn shouldAutorotate(&self) -> bool

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

pub fn setNeedsUpdateOfSupportedInterfaceOrientations(&self)

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

pub fn isEditing(&self) -> bool

pub fn setEditing(&self, editing: bool)

Setter for isEditing.

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

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

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

pub fn removeFromParentViewController(&self)

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

pub fn endAppearanceTransition(&self)

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

👎Deprecated: Has no effect on visionOS

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

👎Deprecated: Has no effect on visionOS

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

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

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

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

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

pub fn automaticallyForwardAppearanceAndRotationMethodsToChildViewControllers( &self, ) -> bool

👎Deprecated

pub fn shouldAutomaticallyForwardRotationMethods(&self) -> bool

👎Deprecated: Manually forward viewWillTransitionToSize:withTransitionCoordinator: if necessary

pub fn shouldAutomaticallyForwardAppearanceMethods(&self) -> bool

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

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

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

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

Setter for restorationIdentifier.

This is copied when set.

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

Safety

coder possibly has further requirements.

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

Safety

coder possibly has further requirements.

pub fn applicationFinishedRestoringState(&self)

pub fn updateViewConstraints(&self)

pub fn viewRespectsSystemMinimumLayoutMargins(&self) -> bool

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

Setter for viewRespectsSystemMinimumLayoutMargins.

pub fn viewLayoutMarginsDidChange(&self)

pub fn viewSafeAreaInsetsDidChange(&self)

pub fn performsActionsWhilePresentingModally(&self) -> bool

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

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

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

pub fn isModalInPresentation(&self) -> bool

pub fn setModalInPresentation(&self, modal_in_presentation: bool)

Setter for isModalInPresentation.

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

👎Deprecated: UIViewControllerPreviewing is deprecated. Please use UIContextMenuInteraction.

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

pub fn setNeedsUpdateOfScreenEdgesDeferringSystemGestures(&self)

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

pub fn prefersHomeIndicatorAutoHidden(&self) -> bool

pub fn setNeedsUpdateOfHomeIndicatorAutoHidden(&self)

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

pub fn prefersPointerLocked(&self) -> bool

pub fn setNeedsUpdateOfPrefersPointerLocked(&self)

pub fn setNeedsUpdateContentUnavailableConfiguration(&self)

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

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

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

pub fn prefersInterfaceOrientationLocked(&self) -> bool

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

pub fn setNeedsUpdateOfPrefersInterfaceOrientationLocked(&self)

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

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

👎Deprecated: UIViewControllerPreviewing is deprecated. Please use UIContextMenuInteraction.

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

pub fn updateTraitsIfNeeded(&self)

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

pub fn preferredContainerBackgroundStyle(&self) -> UIContainerBackgroundStyle

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

pub fn setNeedsUpdateOfPreferredContainerBackgroundStyle(&self)

Methods from Deref<Target = UIResponder>

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

pub fn canBecomeFirstResponder(&self) -> bool

pub fn becomeFirstResponder(&self) -> bool

pub fn canResignFirstResponder(&self) -> bool

pub fn resignFirstResponder(&self) -> bool

pub fn isFirstResponder(&self) -> bool

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

Safety

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

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

Safety

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

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

pub fn editingInteractionConfiguration( &self, ) -> UIEditingInteractionConfiguration

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

pub fn reloadInputViews(&self)

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

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

Setter for userActivity.

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

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

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

Safety

sender should be of the correct type.

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 MFMailComposeViewController

fn as_ref(&self) -> &AnyObject

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

impl AsRef<MFMailComposeViewController> for MFMailComposeViewController

fn as_ref(&self) -> &Self

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

impl AsRef<NSObject> for MFMailComposeViewController

fn as_ref(&self) -> &NSObject

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

impl AsRef<UINavigationController> for MFMailComposeViewController

fn as_ref(&self) -> &UINavigationController

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

impl AsRef<UIResponder> for MFMailComposeViewController

fn as_ref(&self) -> &UIResponder

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

impl AsRef<UIViewController> for MFMailComposeViewController

fn as_ref(&self) -> &UIViewController

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

impl Borrow<AnyObject> for MFMailComposeViewController

fn borrow(&self) -> &AnyObject

Immutably borrows from an owned value.

impl Borrow<NSObject> for MFMailComposeViewController

fn borrow(&self) -> &NSObject

Immutably borrows from an owned value.

impl Borrow<UINavigationController> for MFMailComposeViewController

fn borrow(&self) -> &UINavigationController

Immutably borrows from an owned value.

impl Borrow<UIResponder> for MFMailComposeViewController

fn borrow(&self) -> &UIResponder

Immutably borrows from an owned value.

impl Borrow<UIViewController> for MFMailComposeViewController

fn borrow(&self) -> &UIViewController

Immutably borrows from an owned value.

impl ClassType for MFMailComposeViewController

const NAME: &'static str = "MFMailComposeViewController"

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

type Super = UINavigationController

The superclass of this class.

type ThreadKind = <<MFMailComposeViewController 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 MFMailComposeViewController

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

Formats the value using the given formatter.

impl Deref for MFMailComposeViewController

type Target = UINavigationController

The resulting type after dereferencing.

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

Dereferences the value.

impl Hash for MFMailComposeViewController

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 MFMailComposeViewController

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

where Self: Sized,

Increment the reference count of the receiver.

impl NSCoding for MFMailComposeViewController

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

where Self: Sized + Message,

Safety

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

where Self: Sized + Message,

Safety

impl NSObjectProtocol for MFMailComposeViewController

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 MFMailComposeViewController

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 MFMailComposeViewController

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

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

impl UIContentContainer for MFMailComposeViewController

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

where Self: Sized + Message,

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

where Self: Sized + Message,

impl UIFocusEnvironment for MFMailComposeViewController

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

where Self: Sized + Message,

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

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

where Self: Sized + Message,

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

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

where Self: Sized + Message,

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

fn setNeedsFocusUpdate(&self)

where Self: Sized + Message,

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

fn updateFocusIfNeeded(&self)

where Self: Sized + Message,

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

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

where Self: Sized + Message,

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

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

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 MFMailComposeViewController

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

where Self: Sized + Message,

Safety

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

where Self: Sized + Message,

Safety

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

where Self: Sized + Message,

Safety

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

where Self: Sized + Message,

Safety

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

where Self: Sized + Message,

Safety

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

where Self: Sized + Message,

Safety

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

where Self: Sized + Message,

Safety

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

where Self: Sized + Message,

Safety

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

where Self: Sized + Message,

Safety

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

where Self: Sized + Message,

Safety

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

where Self: Sized + Message,

Safety

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

where Self: Sized + Message,

Safety

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

where Self: Sized + Message,

Safety

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

where Self: Sized + Message,

Safety

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

where Self: Sized + Message,

Safety

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

where Self: Sized + Message,

Safety

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

where Self: Sized + Message,

Safety

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

where Self: Sized + Message,

Safety

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

where Self: Sized + Message,

Safety

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

where Self: Sized + Message,

Safety

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

where Self: Sized + Message,

Safety

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

where Self: Sized + Message,

Safety

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

where Self: Sized + Message,

Safety

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

where Self: Sized + Message,

Safety

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

where Self: Sized + Message,

Safety

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

where Self: Sized + Message,

Safety

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

where Self: Sized + Message,

Safety

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

where Self: Sized + Message,

Safety

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

where Self: Sized + Message,

Safety

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

where Self: Sized + Message,

Safety

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

where Self: Sized + Message,

Safety

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

where Self: Sized + Message,

Safety

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

where Self: Sized + Message,

Safety

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

where Self: Sized + Message,

Safety

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

where Self: Sized + Message,

Safety

impl UITraitEnvironment for MFMailComposeViewController

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

where Self: Sized + Message,

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 MFMailComposeViewController

impl Eq for MFMailComposeViewController

impl UIAppearanceContainer for MFMailComposeViewController