Struct NSApplication

Source

pub struct NSApplication { /* private fields */ }

Available on crate features NSApplication and NSResponder only.

Expand description

Available on crate feature NSWindow only.

Source

pub fn mainWindow(&self) -> Option<Retained<NSWindow>>

Available on crate feature NSWindow only.

Source

pub fn keyWindow(&self) -> Option<Retained<NSWindow>>

Available on crate feature NSWindow only.

Source

pub fn isActive(&self) -> bool

Source

pub fn isHidden(&self) -> bool

You shouldn’t assume the app will be active immediately after sending this message. The framework also does not guarantee that the app will be activated at all.

For cooperative activation, the other application should call -yieldActivationToApplication: or equivalent prior to the target application invoking -activate.

Invoking -activate on an already-active application cancels any pending activation yields by the receiver.

Source

pub fn yieldActivationToApplication(&self, application: &NSRunningApplication)

Available on crate feature NSRunningApplication only.

Explicitly allows another application to make itself active.

Calling this method will not deactivate the current app, nor will it activate the other app. For cooperative or coordinated activation, the other app should request to be activated at some point in the future by calling activate or equivalent.

Source

pub fn yieldActivationToApplicationWithBundleIdentifier( &self, bundle_identifier: &NSString, )

Same as -yieldActivationToApplication:, but the provided bundle identifier does not have to correspond to a currently running application.

This method should be used to yield activation to apps that may not be running at the time of invoking it. If it is known that the target application is currently running, use -yieldActivationToApplication: instead.

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

Source

pub fn stopModal(&self)

Source

pub fn stopModalWithCode(&self, return_code: NSModalResponse)

Source

pub fn abortModal(&self)

Source

pub fn modalWindow(&self) -> Option<Retained<NSWindow>>

Available on crate feature NSWindow only.

Source

Source

pub fn requestUserAttention( &self, request_type: NSRequestUserAttentionType, ) -> NSInteger

Inform the user that this application needs attention - call this method only if your application is not already active.

pub fn setWindowsNeedUpdate(&self, need_update: bool)

Source

pub fn updateWindows(&self)

Source

Available on crate feature NSImage only.

Source

pub unsafe fn setApplicationIconImage( &self, application_icon_image: Option<&NSImage>, )

Available on crate feature NSImage only.

Setter for applicationIconImage.

Available on crate feature NSDockTile only.

Source

pub fn reportException(&self, exception: &NSException)

Source

pub unsafe fn detachDrawingThread_toTarget_withObject( selector: Sel, target: &AnyObject, argument: Option<&AnyObject>, mtm: MainThreadMarker, )

§Safety

selector must be a valid selector.
target should be of the correct type.
argument should be of the correct type.

Source

pub fn occlusionState(&self) -> NSApplicationOcclusionState

Source

pub fn isProtectedDataAvailable(&self) -> bool

Source §

impl NSApplication

Methods declared on superclass NSResponder.

Source

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

Source

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

§Safety

coder possibly has further requirements.

Source §

impl NSApplication

Methods declared on superclass NSObject.

Source

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

Source §

impl NSApplication

NSAppearanceCustomization.

Source

pub fn appearance(&self) -> Option<Retained<NSAppearance>>

Available on crate feature NSAppearance only.

Source

pub fn setAppearance(&self, appearance: Option<&NSAppearance>)

Available on crate feature NSAppearance only.

Available on crate feature NSWindow only.

Source

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

Source §

impl NSApplication

NSFullKeyboardAccess.

Source

pub fn isFullKeyboardAccessEnabled(&self) -> bool

A Boolean value indicating whether keyboard navigation is enabled in System Settings > Keyboard.

Note: The value of this property is YES if keyboard navigation is enabled or NO if it’s not. You might use this value to implement your own key loop or to implement in-control tabbing behavior similar to NSTableView. Because of the nature of the preference storage, you won’t be notified of changes to this property if you attempt to observe it through key-value observing; however, accessing this property is fairly inexpensive, so you can access it directly rather than caching it.
Note: This property’s value isn’t necessarily reflective of the separate accessibility setting named “Full Keyboard Access” in System Settings > Accessibility > Keyboard.

Source §

impl NSApplication

NSServicesMenu.

Source

pub fn servicesMenu(&self) -> Option<Retained<NSMenu>>

Available on crate feature NSMenu only.

Source

pub fn setServicesMenu(&self, services_menu: Option<&NSMenu>)

Available on crate feature NSMenu only.

Setter for servicesMenu.

Source

pub fn registerServicesMenuSendTypes_returnTypes( &self, send_types: &NSArray<NSPasteboardType>, return_types: &NSArray<NSPasteboardType>, )

Available on crate feature NSPasteboard only.

Source §

impl NSApplication

NSServicesHandling.

Source

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

Source

pub unsafe fn setServicesProvider(&self, services_provider: Option<&AnyObject>)

impl NSApplication

NSRemoteNotifications.

Source

pub fn registerForRemoteNotifications(&self)

Source

pub fn unregisterForRemoteNotifications(&self)

Source

pub fn isRegisteredForRemoteNotifications(&self) -> bool

Returns: YESif the application is currently registered for remote notifications, taking into account any systemwide settings; doesn’t relate to connectivity.

Source

pub fn registerForRemoteNotificationTypes( &self, types: NSRemoteNotificationType, )

The following are soft deprecated. Please use the -registerForRemoteNotifications above and -requestAuthorizationWithOptions: from UserNotifications.framework.

Source

pub fn enabledRemoteNotificationTypes(&self) -> NSRemoteNotificationType

Source §

impl NSApplication

Source

pub fn load() -> bool

-application:printFiles: was deprecated in Mac OS X 10.4. Implement -application:printFiles:withSettings:showPrintPanels: in your application delegate instead.

§Safety

sender might not allow None.
filenames might not allow None.

Source

pub unsafe fn beginSheet_modalForWindow_modalDelegate_didEndSelector_contextInfo( &self, sheet: &NSWindow, doc_window: &NSWindow, modal_delegate: Option<&AnyObject>, did_end_selector: Option<Sel>, context_info: *mut c_void, )

👎Deprecated: Use -[NSWindow beginSheet:completionHandler:] instead

Available on crate feature NSWindow only.

NSWindow’s -beginSheet:completionHandler: and -endSheet:returnCode: should be used instead. NSApplication’s -beginSheet:modalForWindow:modalDelegate:didEndSelector:contextInfo: will continue to work as it previously did, leaking contextInfo and failing when there is already an existing sheet.

§Safety

modal_delegate should be of the correct type.
did_end_selector must be a valid selector.
context_info must be a valid pointer.

Source

pub fn endSheet(&self, sheet: &NSWindow)

👎Deprecated: Use -[NSWindow endSheet:] instead

Available on crate feature NSWindow only.

Source

pub fn endSheet_returnCode(&self, sheet: &NSWindow, return_code: NSInteger)

👎Deprecated: Use -[NSWindow endSheet:returnCode:] instead

Available on crate feature NSWindow only.

Source

pub unsafe fn makeWindowsPerform_inOrder( &self, selector: Sel, in_order: bool, ) -> Option<Retained<NSWindow>>

👎Deprecated: Use -enumerateWindowsWithOptions:usingBlock: instead

Available on crate feature NSWindow only.

§Safety

selector must be a valid selector.

Source

pub fn context(&self) -> Option<Retained<NSGraphicsContext>>

👎Deprecated: This method always returns nil. If you need access to the current drawing context, use [NSGraphicsContext currentContext] inside of a draw operation.

Available on crate feature NSGraphicsContext only.

This method is deprecated as of macOS 10.12. Beginning in OS X 10.11 it would always return nil. Prior to this it would return an undefined graphics context that was not generally suitable for drawing.

Source §

impl NSApplication

NSScripting.

Source

pub fn orderedDocuments(&self) -> Retained<NSArray<NSDocument>>

Available on crate features NSApplicationScripting and NSDocument only.

Source

pub fn orderedWindows(&self) -> Retained<NSArray<NSWindow>>

Available on crate features NSApplicationScripting and NSWindow only.

Source §

impl NSApplication

NSColorPanel.

Source

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

Available on crate feature NSColorPanel only.

§Safety

sender should be of the correct type.

Source §

impl NSApplication

NSApplicationHelpExtension.

Source

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

Available on crate feature NSTouchBar only.

Show or dismiss the customization palette for the currently displayed NSTouchBars. NSApplication validates this selector against whether the current NSTouchBars are customizable and, if configured on a menu item, will standardize and localize the title. If the current system does not have Touch Bar support, the menu item will be automatically hidden.

§Safety

sender should be of the correct type.

Source §

impl NSApplication

pub fn extendStateRestoration(&self)

Available on crate feature NSWindowRestoration only.

Source

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

§Safety

This is not retained internally, you must ensure the object is still alive.

Source

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

Setter for nextResponder.

§Safety

This is unretained, you must ensure the object is kept alive while in use.

Source

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

§Safety

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

Handle a key event that should present a context menu at the user focus.

Most applications should not override this method. Instead, you should customize the context menu displayed from a keyboard event by implementing menuForEvent: and selectionAnchorRect, or showContextMenuForSelection:, rather than this method.

You should only override this method when you do not want the system-provided default behavior for the context menu hotkey, either for a specific key combination, or for the hotkey in general. For example, if your application already provides a different behavior for control-Return (the default context menu hotkey definition), and you want to preserve that behavior, you should override this method to handle that specific key combination, and then return without calling super. Note that the user may customize the hotkey to a different key combination, so in this example, if any other key combination is passed to your method, you would call super.

An implementation of this method should call [super contextMenuKeyDown:event] to pass the request up the responder chain. If the message reaches the application object, NSApplication’s implementation of this method will send showContextMenuForSelection: to the responder chain. If you do not call super, then no further handling of the key event will be performed.

Note: In some cases, showContextMenuForSelection: will be called without a prior call to contextMenuKeyDown:. This occurs when a view receives an Accessibility ShowMenu action, or when the user has created a Cocoa Text key binding to map a different key combination to the showContextMenuForSelection: action.

Parameter event: The key down event that matches the system-wide context menu hotkey combination.

See also: showContextMenuForSelection:

Source

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

§Safety

event_selector must be a valid selector.

Source

pub fn acceptsFirstResponder(&self) -> bool

Source

pub fn becomeFirstResponder(&self) -> bool

Source

pub fn resignFirstResponder(&self) -> bool

Source

pub fn interpretKeyEvents(&self, event_array: &NSArray<NSEvent>)

Available on crate feature NSEvent only.

Source

Available on crate feature NSEvent only.

Source

pub fn shouldBeTreatedAsInkEvent(&self, event: &NSEvent) -> bool

Available on crate feature NSEvent only.

Source

pub fn wantsScrollEventsForSwipeTrackingOnAxis( &self, axis: NSEventGestureAxis, ) -> bool

Available on crate feature NSEvent only.

Source

pub fn wantsForwardedScrollEventsForAxis( &self, axis: NSEventGestureAxis, ) -> bool

Available on crate feature NSEvent only.

Source

pub unsafe fn supplementalTargetForAction_sender( &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 touchBar(&self) -> Option<Retained<NSTouchBar>>

Available on crate feature NSTouchBar only.

Source

pub fn setTouchBar(&self, touch_bar: Option<&NSTouchBar>)

Available on crate feature NSTouchBar only.

Setter for touchBar.

Source

pub fn makeTouchBar(&self) -> Option<Retained<NSTouchBar>>

Available on crate feature NSTouchBar only.

Source

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

Available on crate feature NSUserActivity only.

Source

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

Available on crate feature NSUserActivity only.

Setter for userActivity.

Available on crate feature NSWindowRestoration only.

Methods from Deref<Target = NSObject>§

Source

pub fn doesNotRecognizeSelector(&self, sel: Sel) -> !

Handle messages the object doesn’t recognize.

See Apple’s documentation for details.

Methods from Deref<Target = AnyObject>§

Source

pub fn class(&self) -> &'static AnyClass

Available on crate feature NSAccessibilityConstants only.

Dynamically find the class of this object.

§Panics

May panic if the object is invalid (which may be the case for objects returned from unavailable init/new methods).

§Example

Check that an instance of NSObject has the precise class NSObject.

use objc2::ClassType;
use objc2::runtime::NSObject;

let obj = NSObject::new();
assert_eq!(obj.class(), NSObject::class());

Source

pub unsafe fn get_ivar<T>(&self, name: &str) -> &T
where T: Encode,

👎Deprecated: this is difficult to use correctly, use Ivar::load instead.

Available on crate feature NSAccessibilityConstants only.

Use Ivar::load instead.

§Safety

The object must have an instance variable with the given name, and it must be of type T.

See Ivar::load_ptr for details surrounding this.

Source

pub fn downcast_ref<T>(&self) -> Option<&T>
where T: DowncastTarget,

Available on crate feature NSAccessibilityConstants only.

Attempt to downcast the object to a class of type T.

This is the reference-variant. Use Retained::downcast if you want to convert a retained object to another type.

§Mutable classes

Some classes have immutable and mutable variants, such as NSString and NSMutableString.

When some Objective-C API signature says it gives you an immutable class, it generally expects you to not mutate that, even though it may technically be mutable “under the hood”.

So using this method to convert a NSString to a NSMutableString, while not unsound, is generally frowned upon unless you created the string yourself, or the API explicitly documents the string to be mutable.

See Apple’s documentation on mutability and on isKindOfClass: for more details.

§Generic classes

Objective-C generics are called “lightweight generics”, and that’s because they aren’t exposed in the runtime. This makes it impossible to safely downcast to generic collections, so this is disallowed by this method.

You can, however, safely downcast to generic collections where all the type-parameters are AnyObject.

§Panics

This works internally by calling isKindOfClass:. That means that the object must have the instance method of that name, and an exception will be thrown (if CoreFoundation is linked) or the process will abort if that is not the case. In the vast majority of cases, you don’t need to worry about this, since both root objects NSObject and NSProxy implement this method.

§Examples

Cast an NSString back and forth from NSObject.

use objc2::rc::Retained;
use objc2_foundation::{NSObject, NSString};

let obj: Retained<NSObject> = NSString::new().into_super();
let string = obj.downcast_ref::<NSString>().unwrap();
// Or with `downcast`, if we do not need the object afterwards
let string = obj.downcast::<NSString>().unwrap();

Try (and fail) to cast an NSObject to an NSString.

use objc2_foundation::{NSObject, NSString};

let obj = NSObject::new();
assert!(obj.downcast_ref::<NSString>().is_none());

Try to cast to an array of strings.

use objc2_foundation::{NSArray, NSObject, NSString};

let arr = NSArray::from_retained_slice(&[NSObject::new()]);
// This is invalid and doesn't type check.
let arr = arr.downcast_ref::<NSArray<NSString>>();

This fails to compile, since it would require enumerating over the array to ensure that each element is of the desired type, which is a performance pitfall.

Downcast when processing each element instead.

use objc2_foundation::{NSArray, NSObject, NSString};

let arr = NSArray::from_retained_slice(&[NSObject::new()]);

for elem in arr {
    if let Some(data) = elem.downcast_ref::<NSString>() {
        // handle `data`
    }
}