Struct FPUIActionExtensionViewController 

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

Available on crate feature FPUIActionExtensionViewController and crate feature objc2-app-kit and macOS only.

The custom user interface used to perform a selected action.

Subclass this view controller to provide the user interface for your actions.

No matter how many actions you define, your File Provider UI extension has only one FPUIActionExtensionViewController subclass. When the user selects one of your actions, the system instantiates a copy of your subclass, calls its FPUIActionExtensionViewController/prepareForActionWithIdentifier:itemIdentifiers: method, and presents it to the user.

Your subclass must do the following:

• Override the FPUIActionExtensionViewController/prepareForActionWithIdentifier:itemIdentifiers: method to check the action identifiers and present an appropriate user interface for the selected actions.
• Provide some sort of feedback, even if the action doesn’t require interaction with the user. For example, present a view that quickly fades out and automatically completes the action.
• Call the FPUIActionExtensionViewController/extensionContext object’s FPUIActionExtensionContext/cancelRequestWithError: or FPUIActionExtensionContext/completeRequest method when the action is finished to complete the action.

See also Apple’s documentation

Implementations

impl FPUIActionExtensionViewController

pub unsafe fn extensionContext(&self) -> Retained<FPUIActionExtensionContext>

Available on crate feature FPUIActionExtensionContext only.

The extension context provided by the host app.

pub unsafe fn prepareForError(&self, error: &NSError)

Performs any necessary setup or configuration when an authentication error occurs.

While your file provider is enumerating its content, the system calls this method whenever your file provider returns an <doc ://com.apple.documentation/documentation/fileprovider/nsfileprovidererrordomain> error with a <doc ://com.apple.documentation/documentation/fileprovider/nsfileprovidererrorcode/nsfileprovidererrornotauthenticated> code. Use this method to present an interface to authenticate the user.

• Parameters:
• error: An object representing the authentication error. Your File Provider extension can pass additional information in the error’s <doc ://com.apple.documentation/documentation/foundation/nserror/1411580-userinfo> property.

pub unsafe fn prepareForActionWithIdentifier_itemIdentifiers( &self, action_identifier: &NSString, item_identifiers: &NSArray<NSFileProviderItemIdentifier>, )

Performs any necessary setup or configuration for the specified action.

Use this method to prepare a user interface for handling the action. At a minimum, you should display feedback about the action.

For more information, see .

• Parameters:

• actionIdentifier: The identifier for the action performed by the user.

• itemIdentifiers: The identifiers of the items affected by the action.

impl FPUIActionExtensionViewController

Methods declared on superclass NSViewController.

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

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

impl FPUIActionExtensionViewController

Methods declared on superclass NSResponder.

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

impl FPUIActionExtensionViewController

Methods declared on superclass NSObject.

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

Methods from Deref<Target = NSViewController>

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

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

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

pub unsafe fn setRepresentedObject( &self, represented_object: Option<&AnyObject>, )

Setter for representedObject.

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

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

Setter for title.

pub unsafe fn loadView(&self)

pub unsafe fn loadViewIfNeeded(&self)

pub unsafe fn commitEditingWithDelegate_didCommitSelector_contextInfo( &self, delegate: Option<&AnyObject>, did_commit_selector: Option<Sel>, context_info: *mut c_void, )

pub unsafe fn commitEditing(&self) -> bool

pub unsafe fn discardEditing(&self)

pub unsafe fn viewDidLoad(&self)

pub unsafe fn isViewLoaded(&self) -> bool

pub unsafe fn viewWillAppear(&self)

pub unsafe fn viewDidAppear(&self)

pub unsafe fn viewWillDisappear(&self)

pub unsafe fn viewDidDisappear(&self)

pub unsafe fn preferredContentSize(&self) -> CGSize

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

Setter for preferredContentSize.

pub unsafe fn updateViewConstraints(&self)

pub unsafe fn viewWillLayout(&self)

pub unsafe fn viewDidLayout(&self)

pub unsafe fn presentViewController_animator( &self, view_controller: &NSViewController, animator: &ProtocolObject<dyn NSViewControllerPresentationAnimator>, )

pub unsafe fn dismissViewController(&self, view_controller: &NSViewController)

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

pub unsafe fn presentedViewControllers( &self, ) -> Option<Retained<NSArray<NSViewController>>>

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

pub unsafe fn presentViewControllerAsSheet( &self, view_controller: &NSViewController, )

pub unsafe fn presentViewControllerAsModalWindow( &self, view_controller: &NSViewController, )

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

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

pub unsafe fn setChildViewControllers( &self, child_view_controllers: &NSArray<NSViewController>, )

Setter for childViewControllers.

pub unsafe fn addChildViewController( &self, child_view_controller: &NSViewController, )

pub unsafe fn removeFromParentViewController(&self)

pub unsafe fn insertChildViewController_atIndex( &self, child_view_controller: &NSViewController, index: isize, )

pub unsafe fn removeChildViewControllerAtIndex(&self, index: isize)

pub unsafe fn preferredContentSizeDidChangeForViewController( &self, view_controller: &NSViewController, )

pub unsafe fn viewWillTransitionToSize(&self, new_size: CGSize)

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

pub unsafe fn preferredScreenOrigin(&self) -> CGPoint

pub unsafe fn setPreferredScreenOrigin(&self, preferred_screen_origin: CGPoint)

Setter for preferredScreenOrigin.

pub unsafe fn preferredMinimumSize(&self) -> CGSize

pub unsafe fn preferredMaximumSize(&self) -> CGSize

Methods from Deref<Target = NSResponder>

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

pub unsafe fn setNextResponder(&self, next_responder: Option<&NSResponder>)

Setter for nextResponder.

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

pub unsafe fn noResponderFor(&self, event_selector: Sel)

pub unsafe fn acceptsFirstResponder(&self) -> bool

pub unsafe fn becomeFirstResponder(&self) -> bool

pub unsafe fn resignFirstResponder(&self) -> bool

pub unsafe fn flushBufferedKeyEvents(&self)

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

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

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

pub unsafe fn presentError(&self, error: &NSError) -> bool

pub unsafe fn willPresentError(&self, error: &NSError) -> Retained<NSError>

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

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

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

pub unsafe fn performMnemonic(&self, string: &NSString) -> bool

👎Deprecated: This has always returned NO and had no effect on macOS

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 FPUIActionExtensionViewController

fn as_ref(&self) -> &AnyObject

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

impl AsRef<FPUIActionExtensionViewController> for FPUIActionExtensionViewController

fn as_ref(&self) -> &Self

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

impl AsRef<NSObject> for FPUIActionExtensionViewController

fn as_ref(&self) -> &NSObject

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

impl AsRef<NSResponder> for FPUIActionExtensionViewController

fn as_ref(&self) -> &NSResponder

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

impl AsRef<NSViewController> for FPUIActionExtensionViewController

fn as_ref(&self) -> &NSViewController

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

impl Borrow<AnyObject> for FPUIActionExtensionViewController

fn borrow(&self) -> &AnyObject

Immutably borrows from an owned value.

impl Borrow<NSObject> for FPUIActionExtensionViewController

fn borrow(&self) -> &NSObject

Immutably borrows from an owned value.

impl Borrow<NSResponder> for FPUIActionExtensionViewController

fn borrow(&self) -> &NSResponder

Immutably borrows from an owned value.

impl Borrow<NSViewController> for FPUIActionExtensionViewController

fn borrow(&self) -> &NSViewController

Immutably borrows from an owned value.

impl ClassType for FPUIActionExtensionViewController

const NAME: &'static str = "FPUIActionExtensionViewController"

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

type Super = NSViewController

The superclass of this class.

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

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

Formats the value using the given formatter.

impl Deref for FPUIActionExtensionViewController

type Target = NSViewController

The resulting type after dereferencing.

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

Dereferences the value.

impl Hash for FPUIActionExtensionViewController

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 FPUIActionExtensionViewController

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

where Self: Sized,

Increment the reference count of the receiver.

impl NSCoding for FPUIActionExtensionViewController

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 NSEditor for FPUIActionExtensionViewController

unsafe fn discardEditing(&self)

where Self: Sized + Message,

unsafe fn commitEditing(&self) -> bool

where Self: Sized + Message,

unsafe fn commitEditingWithDelegate_didCommitSelector_contextInfo( &self, delegate: Option<&AnyObject>, did_commit_selector: Option<Sel>, context_info: *mut c_void, )

where Self: Sized + Message,

unsafe fn commitEditingAndReturnError(&self) -> Result<(), Retained<NSError>>

where Self: Sized + Message,

impl NSObjectProtocol for FPUIActionExtensionViewController

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 NSSeguePerforming for FPUIActionExtensionViewController

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

where Self: Sized + Message,

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

where Self: Sized + Message,

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

where Self: Sized + Message,

impl NSUserInterfaceItemIdentification for FPUIActionExtensionViewController

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

where Self: Sized + Message,

unsafe fn setIdentifier(&self, identifier: Option<&NSString>)

where Self: Sized + Message,

Setter for identifier.

impl PartialEq for FPUIActionExtensionViewController

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 FPUIActionExtensionViewController

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

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

impl DowncastTarget for FPUIActionExtensionViewController

impl Eq for FPUIActionExtensionViewController