Struct NSWorkspace 

pub struct NSWorkspace { /* private fields */ }

Available on crate feature NSWorkspace only.

Apple’s documentation

Implementations

impl NSWorkspace

NSWorkspaceAccessibilityDisplay.

pub fn accessibilityDisplayShouldIncreaseContrast(&self) -> bool

Available on crate feature NSAccessibility only.

pub fn accessibilityDisplayShouldDifferentiateWithoutColor(&self) -> bool

Available on crate feature NSAccessibility only.

pub fn accessibilityDisplayShouldReduceTransparency(&self) -> bool

Available on crate feature NSAccessibility only.

pub fn accessibilityDisplayShouldReduceMotion(&self) -> bool

Available on crate feature NSAccessibility only.

pub fn accessibilityDisplayShouldInvertColors(&self) -> bool

Available on crate feature NSAccessibility only.

impl NSWorkspace

NSWorkspaceAccessibility.

pub fn isVoiceOverEnabled(&self) -> bool

Available on crate feature NSAccessibility only.

pub fn isSwitchControlEnabled(&self) -> bool

Available on crate feature NSAccessibility only.

impl NSWorkspace

NSWorkspaceRunningApplications.

pub fn runningApplications(&self) -> Retained<NSArray<NSRunningApplication>>

Available on crate feature NSRunningApplication only.

Returns: An array of NSRunningApplications representing currently running applications. The order of the array is unspecified, but it is stable, meaning that the relative order of particular applications will not change across multiple calls to runningApplications. Similar to NSRunningApplication’s properties, this property will only change when the main run loop is run in a common mode. Instead of polling, use key-value observing to be notified of changes to this array property. This property is thread safe, in that it may be called from background threads and the result is returned atomically. This property is observable through KVO.

impl NSWorkspace

pub fn sharedWorkspace() -> Retained<NSWorkspace>

pub fn notificationCenter(&self) -> Retained<NSNotificationCenter>

pub fn openURL(&self, url: &NSURL) -> bool

pub fn openURL_configuration_completionHandler( &self, url: &NSURL, configuration: &NSWorkspaceOpenConfiguration, completion_handler: Option<&DynBlock<dyn Fn(*mut NSRunningApplication, *mut NSError)>>, )

Available on crate features NSRunningApplication and block2 only.

pub fn openURLs_withApplicationAtURL_configuration_completionHandler( &self, urls: &NSArray<NSURL>, application_url: &NSURL, configuration: &NSWorkspaceOpenConfiguration, completion_handler: Option<&DynBlock<dyn Fn(*mut NSRunningApplication, *mut NSError)>>, )

Available on crate features NSRunningApplication and block2 only.

pub fn openApplicationAtURL_configuration_completionHandler( &self, application_url: &NSURL, configuration: &NSWorkspaceOpenConfiguration, completion_handler: Option<&DynBlock<dyn Fn(*mut NSRunningApplication, *mut NSError)>>, )

Available on crate features NSRunningApplication and block2 only.

pub fn selectFile_inFileViewerRootedAtPath( &self, full_path: Option<&NSString>, root_full_path: &NSString, ) -> bool

pub fn activateFileViewerSelectingURLs(&self, file_ur_ls: &NSArray<NSURL>)

pub fn showSearchResultsForQueryString(&self, query_string: &NSString) -> bool

pub fn noteFileSystemChanged_(&self, path: &NSString)

pub fn isFilePackageAtPath(&self, full_path: &NSString) -> bool

pub fn iconForFile(&self, full_path: &NSString) -> Retained<NSImage>

Available on crate feature NSImage only.

pub fn iconForFiles( &self, full_paths: &NSArray<NSString>, ) -> Option<Retained<NSImage>>

Available on crate feature NSImage only.

pub fn iconForContentType(&self, content_type: &UTType) -> Retained<NSImage>

Available on crate feature NSImage and crate feature objc2-uniform-type-identifiers and Apple only.

pub fn setIcon_forFile_options( &self, image: Option<&NSImage>, full_path: &NSString, options: NSWorkspaceIconCreationOptions, ) -> bool

Available on crate feature NSImage only.

pub fn fileLabels(&self) -> Retained<NSArray<NSString>>

pub fn fileLabelColors(&self) -> Retained<NSArray<NSColor>>

Available on crate feature NSColor only.

pub fn recycleURLs_completionHandler( &self, ur_ls: &NSArray<NSURL>, handler: Option<&DynBlock<dyn Fn(NonNull<NSDictionary<NSURL, NSURL>>, *mut NSError)>>, )

Available on crate feature block2 only.

pub fn duplicateURLs_completionHandler( &self, ur_ls: &NSArray<NSURL>, handler: Option<&DynBlock<dyn Fn(NonNull<NSDictionary<NSURL, NSURL>>, *mut NSError)>>, )

Available on crate feature block2 only.

pub unsafe fn getFileSystemInfoForPath_isRemovable_isWritable_isUnmountable_description_type( &self, full_path: &NSString, removable_flag: *mut Bool, writable_flag: *mut Bool, unmountable_flag: *mut Bool, description: Option<&mut Option<Retained<NSString>>>, file_system_type: Option<&mut Option<Retained<NSString>>>, ) -> bool

Safety

• removable_flag must be a valid pointer or null.
• writable_flag must be a valid pointer or null.
• unmountable_flag must be a valid pointer or null.

pub fn unmountAndEjectDeviceAtPath(&self, path: &NSString) -> bool

pub fn unmountAndEjectDeviceAtURL_error( &self, url: &NSURL, ) -> Result<(), Retained<NSError>>

pub fn extendPowerOffBy(&self, requested: NSInteger) -> NSInteger

pub fn hideOtherApplications(&self)

pub fn URLForApplicationWithBundleIdentifier( &self, bundle_identifier: &NSString, ) -> Option<Retained<NSURL>>

pub fn URLsForApplicationsWithBundleIdentifier( &self, bundle_identifier: &NSString, ) -> Retained<NSArray<NSURL>>

pub fn URLForApplicationToOpenURL(&self, url: &NSURL) -> Option<Retained<NSURL>>

pub fn URLsForApplicationsToOpenURL( &self, url: &NSURL, ) -> Retained<NSArray<NSURL>>

pub fn setDefaultApplicationAtURL_toOpenContentTypeOfFileAtURL_completionHandler( &self, application_url: &NSURL, url: &NSURL, completion_handler: Option<&DynBlock<dyn Fn(*mut NSError)>>, )

Available on crate feature block2 only.

pub fn setDefaultApplicationAtURL_toOpenURLsWithScheme_completionHandler( &self, application_url: &NSURL, url_scheme: &NSString, completion_handler: Option<&DynBlock<dyn Fn(*mut NSError)>>, )

Available on crate feature block2 only.

pub fn setDefaultApplicationAtURL_toOpenFileAtURL_completionHandler( &self, application_url: &NSURL, url: &NSURL, completion_handler: Option<&DynBlock<dyn Fn(*mut NSError)>>, )

Available on crate feature block2 only.

pub fn URLForApplicationToOpenContentType( &self, content_type: &UTType, ) -> Option<Retained<NSURL>>

Available on crate feature objc2-uniform-type-identifiers and Apple only.

pub fn URLsForApplicationsToOpenContentType( &self, content_type: &UTType, ) -> Retained<NSArray<NSURL>>

Available on crate feature objc2-uniform-type-identifiers and Apple only.

pub fn setDefaultApplicationAtURL_toOpenContentType_completionHandler( &self, application_url: &NSURL, content_type: &UTType, completion_handler: Option<&DynBlock<dyn Fn(*mut NSError)>>, )

Available on crate feature block2 and crate feature objc2-uniform-type-identifiers and Apple only.

pub fn frontmostApplication(&self) -> Option<Retained<NSRunningApplication>>

Available on crate feature NSRunningApplication only.

pub fn menuBarOwningApplication(&self) -> Option<Retained<NSRunningApplication>>

Available on crate feature NSRunningApplication only.

impl NSWorkspace

Methods declared on superclass NSObject.

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

pub fn new() -> Retained<Self>

impl NSWorkspace

NSDesktopImages.

pub unsafe fn setDesktopImageURL_forScreen_options_error( &self, url: &NSURL, screen: &NSScreen, options: &NSDictionary<NSWorkspaceDesktopImageOptionKey, AnyObject>, ) -> Result<(), Retained<NSError>>

Available on crate feature NSScreen only.

Safety

options generic should be of the correct type.

pub fn desktopImageURLForScreen( &self, screen: &NSScreen, ) -> Option<Retained<NSURL>>

Available on crate feature NSScreen only.

pub fn desktopImageOptionsForScreen( &self, screen: &NSScreen, ) -> Option<Retained<NSDictionary<NSWorkspaceDesktopImageOptionKey, AnyObject>>>

Available on crate feature NSScreen only.

impl NSWorkspace

NSWorkspaceAuthorization.

pub fn requestAuthorizationOfType_completionHandler( &self, type: NSWorkspaceAuthorizationType, completion_handler: &DynBlock<dyn Fn(*mut NSWorkspaceAuthorization, *mut NSError)>, )

Available on crate feature block2 only.

impl NSWorkspace

NSDeprecated.

pub fn openFile(&self, full_path: &NSString) -> bool

👎Deprecated: Use -[NSWorkspace openURL:] instead.

pub fn openFile_withApplication( &self, full_path: &NSString, app_name: Option<&NSString>, ) -> bool

👎Deprecated: Use -[NSWorkspace openURLs:withApplicationAtURL:configuration:completionHandler:] instead.

pub fn openFile_withApplication_andDeactivate( &self, full_path: &NSString, app_name: Option<&NSString>, flag: bool, ) -> bool

👎Deprecated: Use -[NSWorkspace openURLs:withApplicationAtURL:configuration:completionHandler:] instead.

pub fn launchApplication(&self, app_name: &NSString) -> bool

👎Deprecated: Use -[NSWorkspace openApplicationAtURL:configuration:completionHandler:] instead.

pub unsafe fn launchApplicationAtURL_options_configuration_error( &self, url: &NSURL, options: NSWorkspaceLaunchOptions, configuration: &NSDictionary<NSWorkspaceLaunchConfigurationKey, AnyObject>, ) -> Result<Retained<NSRunningApplication>, Retained<NSError>>

👎Deprecated: Use -[NSWorkspace openApplicationAtURL:configuration:completionHandler:] instead.

Available on crate feature NSRunningApplication only.

Safety

configuration generic should be of the correct type.

pub unsafe fn openURL_options_configuration_error( &self, url: &NSURL, options: NSWorkspaceLaunchOptions, configuration: &NSDictionary<NSWorkspaceLaunchConfigurationKey, AnyObject>, ) -> Result<Retained<NSRunningApplication>, Retained<NSError>>

👎Deprecated: Use -[NSWorkspace openURL:configuration:completionHandler:] instead.

Available on crate feature NSRunningApplication only.

Safety

configuration generic should be of the correct type.

pub unsafe fn openURLs_withApplicationAtURL_options_configuration_error( &self, urls: &NSArray<NSURL>, application_url: &NSURL, options: NSWorkspaceLaunchOptions, configuration: &NSDictionary<NSWorkspaceLaunchConfigurationKey, AnyObject>, ) -> Result<Retained<NSRunningApplication>, Retained<NSError>>

👎Deprecated: Use -[NSWorkspace openURLs:withApplicationAtURL:configuration:completionHandler:] instead.

Available on crate feature NSRunningApplication only.

Safety

configuration generic should be of the correct type.

pub fn launchApplication_showIcon_autolaunch( &self, app_name: &NSString, show_icon: bool, autolaunch: bool, ) -> bool

👎Deprecated: Use -[NSWorkspace openApplicationAtURL:configuration:completionHandler:] instead.

pub fn fullPathForApplication( &self, app_name: &NSString, ) -> Option<Retained<NSString>>

👎Deprecated: Use -[NSWorkspace URLForApplicationWithBundleIdentifier:] instead.

pub fn absolutePathForAppBundleWithIdentifier( &self, bundle_identifier: &NSString, ) -> Option<Retained<NSString>>

👎Deprecated: Use -[NSWorkspace URLForApplicationWithBundleIdentifier:] instead.

pub fn launchAppWithBundleIdentifier_options_additionalEventParamDescriptor_launchIdentifier( &self, bundle_identifier: &NSString, options: NSWorkspaceLaunchOptions, descriptor: Option<&NSAppleEventDescriptor>, identifier: Option<&mut Option<Retained<NSNumber>>>, ) -> bool

👎Deprecated: Use -[NSWorkspace openApplicationAtURL:configuration:completionHandler:] instead.

pub fn openURLs_withAppBundleIdentifier_options_additionalEventParamDescriptor_launchIdentifiers( &self, urls: &NSArray<NSURL>, bundle_identifier: Option<&NSString>, options: NSWorkspaceLaunchOptions, descriptor: Option<&NSAppleEventDescriptor>, identifiers: Option<&mut Option<Retained<NSArray<NSNumber>>>>, ) -> bool

👎Deprecated: Use -[NSWorkspace openURLs:withApplicationAtURL:configuration:completionHandler:] instead.

pub fn openTempFile(&self, full_path: &NSString) -> bool

👎Deprecated

pub fn findApplications(&self)

👎Deprecated

pub fn noteUserDefaultsChanged(&self)

👎Deprecated

pub fn slideImage_from_to( &self, image: &NSImage, from_point: NSPoint, to_point: NSPoint, )

👎Deprecated

Available on crate feature NSImage only.

pub fn checkForRemovableMedia(&self)

👎Deprecated

pub fn noteFileSystemChanged(&self)

👎Deprecated

pub fn fileSystemChanged(&self) -> bool

👎Deprecated

pub fn userDefaultsChanged(&self) -> bool

👎Deprecated

pub fn mountNewRemovableMedia(&self) -> Option<Retained<NSArray>>

👎Deprecated

pub fn activeApplication(&self) -> Option<Retained<NSDictionary>>

👎Deprecated: Use -[NSWorkspace frontmostApplication] instead.

pub fn mountedLocalVolumePaths(&self) -> Option<Retained<NSArray>>

👎Deprecated: Use -[NSFileManager mountedVolumeURLsIncludingResourceValuesForKeys:options:] instead.

pub fn mountedRemovableMedia(&self) -> Option<Retained<NSArray>>

👎Deprecated: Use -[NSFileManager mountedVolumeURLsIncludingResourceValuesForKeys:options:] instead.

pub fn launchedApplications(&self) -> Option<Retained<NSArray>>

👎Deprecated: Use -[NSWorkspace runningApplications] instead.

pub fn openFile_fromImage_at_inView( &self, full_path: &NSString, image: Option<&NSImage>, point: NSPoint, view: Option<&NSView>, ) -> bool

👎Deprecated: Use -[NSWorkspace openURL:] instead.

Available on crate features NSImage and NSResponder and NSView only.

pub unsafe fn performFileOperation_source_destination_files_tag( &self, operation: &NSWorkspaceFileOperationName, source: &NSString, destination: &NSString, files: &NSArray, tag: *mut NSInteger, ) -> bool

👎Deprecated

Safety

• files generic should be of the correct type.
• tag must be a valid pointer or null.

pub fn getInfoForFile_application_type( &self, full_path: &NSString, app_name: Option<&mut Option<Retained<NSString>>>, type: Option<&mut Option<Retained<NSString>>>, ) -> bool

👎Deprecated: Use -[NSWorkspace URLForApplicationToOpenURL:] to get the URL of an application that will open a given item, or -[NSURL getResourceValue:forKey:error:] with NSURLContentTypeKey to get the type of the given item.

pub fn iconForFileType(&self, file_type: &NSString) -> Retained<NSImage>

👎Deprecated: Use -[NSWorkspace iconForContentType:] instead.

Available on crate feature NSImage only.

pub fn typeOfFile_error( &self, absolute_file_path: &NSString, ) -> Result<Retained<NSString>, Retained<NSError>>

👎Deprecated: Use -[NSURL getResourceValue:forKey:error:] with NSURLContentTypeKey instead.

pub fn localizedDescriptionForType( &self, type_name: &NSString, ) -> Option<Retained<NSString>>

👎Deprecated: Use UTType.localizedDescription instead.

pub fn preferredFilenameExtensionForType( &self, type_name: &NSString, ) -> Option<Retained<NSString>>

👎Deprecated: Use UTType.preferredFilenameExtension instead.

pub fn filenameExtension_isValidForType( &self, filename_extension: &NSString, type_name: &NSString, ) -> bool

👎Deprecated: Use +[UTType typesWithTag:tagClass:conformingToType:] to get a list of candidate types, then check if the input type conforms to any of them.

pub fn type_conformsToType( &self, first_type_name: &NSString, second_type_name: &NSString, ) -> bool

👎Deprecated: Use -[UTType conformsToType:] instead.

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

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

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.

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

Trait Implementations

impl AsRef<AnyObject> for NSWorkspace

fn as_ref(&self) -> &AnyObject

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

impl AsRef<NSObject> for NSWorkspace

fn as_ref(&self) -> &NSObject

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

impl AsRef<NSWorkspace> for NSWorkspace

fn as_ref(&self) -> &Self

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

impl Borrow<AnyObject> for NSWorkspace

fn borrow(&self) -> &AnyObject

Immutably borrows from an owned value.

impl Borrow<NSObject> for NSWorkspace

fn borrow(&self) -> &NSObject

Immutably borrows from an owned value.

impl ClassType for NSWorkspace

const NAME: &'static str = "NSWorkspace"

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

type Super = NSObject

The superclass of this class.

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

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

Formats the value using the given formatter.

impl DefaultRetained for NSWorkspace

fn default_retained() -> Retained<Self>

The default Retained for a type.

impl Deref for NSWorkspace

type Target = NSObject

The resulting type after dereferencing.

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

Dereferences the value.

impl Hash for NSWorkspace

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 NSWorkspace

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

where Self: Sized,

Increment the reference count of the receiver.

impl NSObjectProtocol for NSWorkspace

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 NSWorkspace

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 NSWorkspace

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

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

impl DowncastTarget for NSWorkspace

impl Eq for NSWorkspace