Struct AppDelegate 

#[repr(C)]
pub(crate) struct AppDelegate {
    __superclass: ManuallyDrop<<NSObject as ClassType>::__SubclassingType>,
    __phantom: PhantomData<(<Self as DefinedClass>::Ivars, ThreadKindAutoTraits<<Self as ClassType>::ThreadKind>)>,
}

Fields

__superclass: ManuallyDrop<<NSObject as ClassType>::__SubclassingType>

__phantom: PhantomData<(<Self as DefinedClass>::Ivars, ThreadKindAutoTraits<<Self as ClassType>::ThreadKind>)>

Implementations

impl AppDelegate

extern "C-unwind" fn did_finish_launching( &self, _: Sel, _notification: <&NSNotification as ConvertArgument>::__Inner, )

Apps launched from a terminal start in the background unless activated.

extern "C-unwind" fn should_terminate_after_last_window_closed( &self, _: Sel, _sender: <&NSApplication as ConvertArgument>::__Inner, ) -> <bool as ConvertReturn<()>>::Inner

impl AppDelegate

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

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 AppDelegate

fn as_ref(&self) -> &AnyObject

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

impl AsRef<AppDelegate> for AppDelegate

fn as_ref(&self) -> &Self

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

impl AsRef<NSObject> for AppDelegate

fn as_ref(&self) -> &NSObject

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

impl Borrow<AnyObject> for AppDelegate

fn borrow(&self) -> &AnyObject

Immutably borrows from an owned value.

impl Borrow<NSObject> for AppDelegate

fn borrow(&self) -> &NSObject

Immutably borrows from an owned value.

impl ClassType for AppDelegate

const NAME: &'static str = "NiftyAppDelegate"

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

type Super = NSObject

The superclass of this class.

type ThreadKind = dyn MainThreadOnly

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

fn class() -> &'static AnyClass

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

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

Get an immutable reference to the superclass.

impl Debug for AppDelegate

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

Formats the value using the given formatter.

impl DefinedClass for AppDelegate

type Ivars = ()

A type representing the instance variables that this class carries.

fn ivars(&self) -> &Self::Ivars

where Self: Sized,

Get a reference to the instance variable data that this object carries.

impl Deref for AppDelegate

type Target = NSObject

The resulting type after dereferencing.

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

Dereferences the value.

impl DowncastTarget for AppDelegate

impl Message for AppDelegate

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

where Self: Sized,

Increment the reference count of the receiver.

impl NSApplicationDelegate for AppDelegate

fn applicationShouldTerminate( &self, sender: &NSApplication, ) -> NSApplicationTerminateReply

where Self: Sized + Message,

Allowable return values are: NSTerminateNow- it is ok to proceed with termination NSTerminateCancel- the application should not be terminated NSTerminateLater- it may be ok to proceed with termination later. The application must call -replyToApplicationShouldTerminate: with YESor NOonce the answer is known

fn application_openURLs( &self, application: &NSApplication, urls: &NSArray<NSURL>, )

where Self: Sized + Message,

This will be called for any URLs your application is asked to open. This includes URL types (CFBundleURLTypes) defined in your Info.plist, and Document types ( CFBundleDocumentTypes)that have no associated NSDocumentclass. Document URLs that have an associated NSDocumentclass will be opened through NSDocumentController.If this is implemented, -application:openFiles: and -application:openFile: will not be called.

fn application_openFile( &self, sender: &NSApplication, filename: &NSString, ) -> bool

where Self: Sized + Message,

fn application_openFiles( &self, sender: &NSApplication, filenames: &NSArray<NSString>, )

where Self: Sized + Message,

fn application_openTempFile( &self, sender: &NSApplication, filename: &NSString, ) -> bool

where Self: Sized + Message,

fn applicationShouldOpenUntitledFile(&self, sender: &NSApplication) -> bool

where Self: Sized + Message,

fn applicationOpenUntitledFile(&self, sender: &NSApplication) -> bool

where Self: Sized + Message,

unsafe fn application_openFileWithoutUI( &self, sender: &AnyObject, filename: &NSString, ) -> bool

where Self: Sized + Message,

Safety

fn application_printFile( &self, sender: &NSApplication, filename: &NSString, ) -> bool

where Self: Sized + Message,

unsafe fn application_printFiles_withSettings_showPrintPanels( &self, application: &NSApplication, file_names: &NSArray<NSString>, print_settings: &NSDictionary<NSString>, show_print_panels: bool, ) -> NSApplicationPrintReply

where Self: Sized + Message,

Safety

fn applicationShouldTerminateAfterLastWindowClosed( &self, sender: &NSApplication, ) -> bool

where Self: Sized + Message,

fn applicationShouldHandleReopen_hasVisibleWindows( &self, sender: &NSApplication, has_visible_windows: bool, ) -> bool

where Self: Sized + Message,

fn applicationDockMenu( &self, sender: &NSApplication, ) -> Option<Retained<NSMenu>>

where Self: Sized + Message,

fn application_willPresentError( &self, application: &NSApplication, error: &NSError, ) -> Retained<NSError>

where Self: Sized + Message,

fn application_didRegisterForRemoteNotificationsWithDeviceToken( &self, application: &NSApplication, device_token: &NSData, )

where Self: Sized + Message,

fn application_didFailToRegisterForRemoteNotificationsWithError( &self, application: &NSApplication, error: &NSError, )

where Self: Sized + Message,

unsafe fn application_didReceiveRemoteNotification( &self, application: &NSApplication, user_info: &NSDictionary<NSString>, )

where Self: Sized + Message,

Safety

fn applicationSupportsSecureRestorableState(&self, app: &NSApplication) -> bool

where Self: Sized + Message,

Method to opt-in to secure restorable state.

unsafe fn application_willEncodeRestorableState( &self, app: &NSApplication, coder: &NSCoder, )

where Self: Sized + Message,

Method called by -[NSApplication encodeRestorableStateWithCoder:] to give the delegate a chance to encode any additional state into the NSCoder.If the restorable state managed by the delegate changes, you must call -[NSApplication invalidateRestorableState] so that it will be re-encoded. See the header NSWindowRestoration.h for more information.

unsafe fn application_didDecodeRestorableState( &self, app: &NSApplication, coder: &NSCoder, )

where Self: Sized + Message,

Method called by -[NSApplication restoreStateWithCoder:] to give the delegate a chance to restore its own state, which it may decode from the NSCoder.See the header NSWindowRestoration.h for more information.

fn application_willContinueUserActivityWithType( &self, application: &NSApplication, user_activity_type: &NSString, ) -> bool

where Self: Sized + Message,

This will be called on the main thread as soon as the user indicates they want to continue an activity in your application. The NSUserActivityobject may not be available instantly, so use this as an opportunity to show the user that an activity will be continued shortly. Return YESto indicate that you are doing so. Return NO(or leave it unimplemented) and AppKit/UIKit will put up a default UI.

fn application_continueUserActivity_restorationHandler( &self, application: &NSApplication, user_activity: &NSUserActivity, restoration_handler: &Block<dyn Fn(NonNull<NSArray<ProtocolObject<dyn NSUserActivityRestoring>>>)>, ) -> bool

where Self: Sized + Message,

This will be called on the main thread after the NSUserActivityobject is available. Use the data you stored in the NSUserActivity object to re-create what the user was doing.

fn application_didFailToContinueUserActivityWithType_error( &self, application: &NSApplication, user_activity_type: &NSString, error: &NSError, )

where Self: Sized + Message,

There are instances where continuing a NSUserActivitymay fail. This will get called on the main thread if it does so. If it is unimplemented, AppKit will present the error.

fn application_didUpdateUserActivity( &self, application: &NSApplication, user_activity: &NSUserActivity, )

where Self: Sized + Message,

This will be called on the main thread when a user activity managed by AppKit/UIKit has been updated. You should use this as a last chance to add additional data to the userActivity.

fn application_userDidAcceptCloudKitShareWithMetadata( &self, application: &NSApplication, metadata: &CKShareMetadata, )

where Self: Sized + Message,

This will be called on the main thread after the user indicates they want to accept a CloudKit sharing invitation in your application.

fn application_delegateHandlesKey( &self, sender: &NSApplication, key: &NSString, ) -> bool

where Self: Sized + Message,

Returns: YESif the receiving delegate object can respond to key value coding messages for a specific keyed attribute, to-one relationship, or to-many relationship. Return NOotherwise.

fn applicationShouldAutomaticallyLocalizeKeyEquivalents( &self, application: &NSApplication, ) -> bool

where Self: Sized + Message,

This method will be called once during application launch at -[NSApplication finishLaunching].

fn applicationWillFinishLaunching(&self, notification: &NSNotification)

where Self: Sized + Message,

fn applicationDidFinishLaunching(&self, notification: &NSNotification)

where Self: Sized + Message,

fn applicationWillHide(&self, notification: &NSNotification)

where Self: Sized + Message,

fn applicationDidHide(&self, notification: &NSNotification)

where Self: Sized + Message,

fn applicationWillUnhide(&self, notification: &NSNotification)

where Self: Sized + Message,

fn applicationDidUnhide(&self, notification: &NSNotification)

where Self: Sized + Message,

fn applicationWillBecomeActive(&self, notification: &NSNotification)

where Self: Sized + Message,

fn applicationDidBecomeActive(&self, notification: &NSNotification)

where Self: Sized + Message,

fn applicationWillResignActive(&self, notification: &NSNotification)

where Self: Sized + Message,

fn applicationDidResignActive(&self, notification: &NSNotification)

where Self: Sized + Message,

fn applicationWillUpdate(&self, notification: &NSNotification)

where Self: Sized + Message,

fn applicationDidUpdate(&self, notification: &NSNotification)

where Self: Sized + Message,

fn applicationWillTerminate(&self, notification: &NSNotification)

where Self: Sized + Message,

fn applicationDidChangeScreenParameters(&self, notification: &NSNotification)

where Self: Sized + Message,

fn applicationDidChangeOcclusionState(&self, notification: &NSNotification)

where Self: Sized + Message,

fn applicationProtectedDataWillBecomeUnavailable( &self, notification: &NSNotification, )

where Self: Sized + Message,

fn applicationProtectedDataDidBecomeAvailable( &self, notification: &NSNotification, )

where Self: Sized + Message,

impl NSObjectProtocol for AppDelegate

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 RefEncode for AppDelegate

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

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