Struct NSDocument 

pub struct NSDocument { /* private fields */ }

Available on crate feature NSDocument only.

Apple’s documentation

Implementations

impl NSDocument

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

pub fn initWithType_error( this: Allocated<Self>, type_name: &NSString, ) -> Result<Retained<Self>, Retained<NSError>>

pub fn canConcurrentlyReadDocumentsOfType( type_name: &NSString, mtm: MainThreadMarker, ) -> bool

pub fn initWithContentsOfURL_ofType_error( this: Allocated<Self>, url: &NSURL, type_name: &NSString, ) -> Result<Retained<Self>, Retained<NSError>>

pub fn initForURL_withContentsOfURL_ofType_error( this: Allocated<Self>, url_or_nil: Option<&NSURL>, contents_url: &NSURL, type_name: &NSString, ) -> Result<Retained<Self>, Retained<NSError>>

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

pub fn setFileType(&self, file_type: Option<&NSString>)

Setter for fileType.

This is copied when set.

pub fn fileURL(&self) -> Option<Retained<NSURL>>

pub fn setFileURL(&self, file_url: Option<&NSURL>)

Setter for fileURL.

This is copied when set.

pub fn fileModificationDate(&self) -> Option<Retained<NSDate>>

pub fn setFileModificationDate(&self, file_modification_date: Option<&NSDate>)

Setter for fileModificationDate.

This is copied when set.

pub fn isDraft(&self) -> bool

pub fn setDraft(&self, draft: bool)

Setter for isDraft.

pub fn performActivityWithSynchronousWaiting_usingBlock( &self, wait_synchronously: bool, block: &DynBlock<dyn Fn(NonNull<DynBlock<dyn Fn()>>)>, )

Available on crate feature block2 only.

pub fn continueActivityUsingBlock(&self, block: &DynBlock<dyn Fn() + '_>)

Available on crate feature block2 only.

pub fn continueAsynchronousWorkOnMainThreadUsingBlock( &self, block: &DynBlock<dyn Fn()>, )

Available on crate feature block2 only.

pub fn performSynchronousFileAccessUsingBlock( &self, block: &DynBlock<dyn Fn() + '_>, )

Available on crate feature block2 only.

pub fn performAsynchronousFileAccessUsingBlock( &self, block: &DynBlock<dyn Fn(NonNull<DynBlock<dyn Fn()>>)>, )

Available on crate feature block2 only.

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

Safety

sender should be of the correct type.

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

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

pub fn readFromFileWrapper_ofType_error( &self, file_wrapper: &NSFileWrapper, type_name: &NSString, ) -> Result<(), Retained<NSError>>

pub fn readFromData_ofType_error( &self, data: &NSData, type_name: &NSString, ) -> Result<(), Retained<NSError>>

pub fn isEntireFileLoaded(&self) -> bool

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

pub fn fileWrapperOfType_error( &self, type_name: &NSString, ) -> Result<Retained<NSFileWrapper>, Retained<NSError>>

pub fn dataOfType_error( &self, type_name: &NSString, ) -> Result<Retained<NSData>, Retained<NSError>>

pub fn unblockUserInteraction(&self)

pub fn autosavingIsImplicitlyCancellable(&self) -> bool

pub fn writeSafelyToURL_ofType_forSaveOperation_error( &self, url: &NSURL, type_name: &NSString, save_operation: NSSaveOperationType, ) -> Result<(), Retained<NSError>>

pub fn writeToURL_ofType_forSaveOperation_originalContentsURL_error( &self, url: &NSURL, type_name: &NSString, save_operation: NSSaveOperationType, absolute_original_contents_url: Option<&NSURL>, ) -> Result<(), Retained<NSError>>

pub fn fileAttributesToWriteToURL_ofType_forSaveOperation_originalContentsURL_error( &self, url: &NSURL, type_name: &NSString, save_operation: NSSaveOperationType, absolute_original_contents_url: Option<&NSURL>, ) -> Result<Retained<NSDictionary<NSString, AnyObject>>, Retained<NSError>>

pub fn keepBackupFile(&self) -> bool

pub fn backupFileURL(&self) -> Option<Retained<NSURL>>

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

Safety

sender should be of the correct type.

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

Safety

sender should be of the correct type.

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

Safety

sender should be of the correct type.

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

Safety

• delegate should be of the correct type.
• did_save_selector must be a valid selector.
• context_info must be a valid pointer or null.

pub unsafe fn runModalSavePanelForSaveOperation_delegate_didSaveSelector_contextInfo( &self, save_operation: NSSaveOperationType, delegate: Option<&AnyObject>, did_save_selector: Option<Sel>, context_info: *mut c_void, )

Safety

• delegate should be of the correct type.
• did_save_selector must be a valid selector.
• context_info must be a valid pointer or null.

pub fn savePanelShowsFileFormatsControl(&self) -> bool

pub fn prepareSavePanel(&self, save_panel: &NSSavePanel) -> bool

Available on crate features NSPanel and NSResponder and NSSavePanel and NSWindow only.

pub fn fileNameExtensionWasHiddenInLastRunSavePanel(&self) -> bool

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

pub unsafe fn saveToURL_ofType_forSaveOperation_delegate_didSaveSelector_contextInfo( &self, url: &NSURL, type_name: &NSString, save_operation: NSSaveOperationType, delegate: Option<&AnyObject>, did_save_selector: Option<Sel>, context_info: *mut c_void, )

Safety

• delegate should be of the correct type.
• did_save_selector must be a valid selector.
• context_info must be a valid pointer or null.

pub fn saveToURL_ofType_forSaveOperation_completionHandler( &self, url: &NSURL, type_name: &NSString, save_operation: NSSaveOperationType, completion_handler: &DynBlock<dyn Fn(*mut NSError)>, )

Available on crate feature block2 only.

pub fn canAsynchronouslyWriteToURL_ofType_forSaveOperation( &self, url: &NSURL, type_name: &NSString, save_operation: NSSaveOperationType, ) -> bool

pub fn checkAutosavingSafetyAndReturnError( &self, ) -> Result<(), Retained<NSError>>

pub fn scheduleAutosaving(&self)

pub fn hasUnautosavedChanges(&self) -> bool

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

Safety

• delegate should be of the correct type.
• did_autosave_selector must be a valid selector.
• context_info must be a valid pointer or null.

pub fn autosaveWithImplicitCancellability_completionHandler( &self, autosaving_is_implicitly_cancellable: bool, completion_handler: &DynBlock<dyn Fn(*mut NSError)>, )

Available on crate feature block2 only.

pub fn autosavesInPlace(mtm: MainThreadMarker) -> bool

pub fn preservesVersions(mtm: MainThreadMarker) -> bool

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

Safety

sender should be of the correct type.

pub fn isBrowsingVersions(&self) -> bool

pub fn stopBrowsingVersionsWithCompletionHandler( &self, completion_handler: Option<&DynBlock<dyn Fn()>>, )

Available on crate feature block2 only.

pub fn autosavesDrafts(mtm: MainThreadMarker) -> bool

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

pub fn autosavedContentsFileURL(&self) -> Option<Retained<NSURL>>

pub fn setAutosavedContentsFileURL( &self, autosaved_contents_file_url: Option<&NSURL>, )

Setter for autosavedContentsFileURL.

This is copied when set.

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

Safety

• delegate should be of the correct type.
• should_close_selector must be a valid selector.
• context_info must be a valid pointer or null.

pub fn close(&self)

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

Safety

sender should be of the correct type.

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

Safety

• delegate should be of the correct type.
• did_duplicate_selector must be a valid selector.
• context_info must be a valid pointer or null.

pub fn duplicateAndReturnError( &self, ) -> Result<Retained<NSDocument>, Retained<NSError>>

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

Safety

sender should be of the correct type.

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

Safety

sender should be of the correct type.

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

Safety

sender should be of the correct type.

pub fn moveDocumentWithCompletionHandler( &self, completion_handler: Option<&DynBlock<dyn Fn(Bool)>>, )

Available on crate feature block2 only.

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

Available on crate feature block2 only.

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

Safety

sender should be of the correct type.

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

Safety

sender should be of the correct type.

pub fn lockDocumentWithCompletionHandler( &self, completion_handler: Option<&DynBlock<dyn Fn(Bool)>>, )

Available on crate feature block2 only.

pub fn lockWithCompletionHandler( &self, completion_handler: Option<&DynBlock<dyn Fn(*mut NSError)>>, )

Available on crate feature block2 only.

pub fn unlockDocumentWithCompletionHandler( &self, completion_handler: Option<&DynBlock<dyn Fn(Bool)>>, )

Available on crate feature block2 only.

pub fn unlockWithCompletionHandler( &self, completion_handler: Option<&DynBlock<dyn Fn(*mut NSError)>>, )

Available on crate feature block2 only.

pub fn isLocked(&self) -> bool

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

Safety

sender should be of the correct type.

pub unsafe fn runModalPageLayoutWithPrintInfo_delegate_didRunSelector_contextInfo( &self, print_info: &NSPrintInfo, delegate: Option<&AnyObject>, did_run_selector: Option<Sel>, context_info: *mut c_void, )

Available on crate feature NSPrintInfo only.

Safety

• delegate should be of the correct type.
• did_run_selector must be a valid selector.
• context_info must be a valid pointer or null.

pub fn preparePageLayout(&self, page_layout: &NSPageLayout) -> bool

Available on crate feature NSPageLayout only.

pub fn shouldChangePrintInfo(&self, new_print_info: &NSPrintInfo) -> bool

Available on crate feature NSPrintInfo only.

pub fn printInfo(&self) -> Retained<NSPrintInfo>

Available on crate feature NSPrintInfo only.

pub fn setPrintInfo(&self, print_info: &NSPrintInfo)

Available on crate feature NSPrintInfo only.

Setter for printInfo.

This is copied when set.

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

Safety

sender should be of the correct type.

pub unsafe fn printDocumentWithSettings_showPrintPanel_delegate_didPrintSelector_contextInfo( &self, print_settings: &NSDictionary<NSPrintInfoAttributeKey, AnyObject>, show_print_panel: bool, delegate: Option<&AnyObject>, did_print_selector: Option<Sel>, context_info: *mut c_void, )

Available on crate feature NSPrintInfo only.

Safety

• print_settings generic should be of the correct type.
• delegate should be of the correct type.
• did_print_selector must be a valid selector.
• context_info must be a valid pointer or null.

pub unsafe fn printOperationWithSettings_error( &self, print_settings: &NSDictionary<NSPrintInfoAttributeKey, AnyObject>, ) -> Result<Retained<NSPrintOperation>, Retained<NSError>>

Available on crate features NSPrintInfo and NSPrintOperation only.

Safety

print_settings generic should be of the correct type.

pub unsafe fn runModalPrintOperation_delegate_didRunSelector_contextInfo( &self, print_operation: &NSPrintOperation, delegate: Option<&AnyObject>, did_run_selector: Option<Sel>, context_info: *mut c_void, )

Available on crate feature NSPrintOperation only.

Safety

• delegate should be of the correct type.
• did_run_selector must be a valid selector.
• context_info must be a valid pointer or null.

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

Safety

sender should be of the correct type.

pub fn PDFPrintOperation(&self) -> Retained<NSPrintOperation>

Available on crate feature NSPrintOperation only.

pub fn allowsDocumentSharing(&self) -> bool

pub fn shareDocumentWithSharingService_completionHandler( &self, sharing_service: &NSSharingService, completion_handler: Option<&DynBlock<dyn Fn(Bool)>>, )

Available on crate features NSSharingService and block2 only.

pub fn prepareSharingServicePicker( &self, sharing_service_picker: &NSSharingServicePicker, )

Available on crate feature NSSharingService only.

pub fn previewRepresentableActivityItems( &self, ) -> Option<Retained<NSArray<ProtocolObject<dyn NSPreviewRepresentableActivityItem>>>>

Available on crate feature NSPreviewRepresentingActivityItem only.

pub fn setPreviewRepresentableActivityItems( &self, preview_representable_activity_items: Option<&NSArray<ProtocolObject<dyn NSPreviewRepresentableActivityItem>>>, )

Available on crate feature NSPreviewRepresentingActivityItem only.

Setter for previewRepresentableActivityItems.

This is copied when set.

pub fn isDocumentEdited(&self) -> bool

pub fn isInViewingMode(&self) -> bool

pub fn updateChangeCount(&self, change: NSDocumentChangeType)

pub fn changeCountTokenForSaveOperation( &self, save_operation: NSSaveOperationType, ) -> Retained<AnyObject>

pub unsafe fn updateChangeCountWithToken_forSaveOperation( &self, change_count_token: &AnyObject, save_operation: NSSaveOperationType, )

Safety

change_count_token should be of the correct type.

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

pub fn setUndoManager(&self, undo_manager: Option<&NSUndoManager>)

Setter for undoManager.

pub fn hasUndoManager(&self) -> bool

pub fn setHasUndoManager(&self, has_undo_manager: bool)

Setter for hasUndoManager.

pub unsafe fn presentError_modalForWindow_delegate_didPresentSelector_contextInfo( &self, error: &NSError, window: &NSWindow, delegate: Option<&AnyObject>, did_present_selector: Option<Sel>, context_info: *mut c_void, )

Available on crate features NSResponder and NSWindow only.

Safety

• delegate should be of the correct type.
• did_present_selector must be a valid selector.
• context_info must be a valid pointer or null.

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

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

pub fn willNotPresentError(&self, error: &NSError)

pub fn makeWindowControllers(&self)

pub fn windowNibName(&self) -> Option<Retained<NSNibName>>

Available on crate feature NSNib only.

pub fn windowControllerWillLoadNib( &self, window_controller: &NSWindowController, )

Available on crate features NSResponder and NSWindowController only.

pub fn windowControllerDidLoadNib(&self, window_controller: &NSWindowController)

Available on crate features NSResponder and NSWindowController only.

pub fn setWindow(&self, window: Option<&NSWindow>)

Available on crate features NSResponder and NSWindow only.

pub fn addWindowController(&self, window_controller: &NSWindowController)

Available on crate features NSResponder and NSWindowController only.

pub fn removeWindowController(&self, window_controller: &NSWindowController)

Available on crate features NSResponder and NSWindowController only.

pub fn showWindows(&self)

pub fn windowControllers(&self) -> Retained<NSArray<NSWindowController>>

Available on crate features NSResponder and NSWindowController only.

pub unsafe fn shouldCloseWindowController_delegate_shouldCloseSelector_contextInfo( &self, window_controller: &NSWindowController, delegate: Option<&AnyObject>, should_close_selector: Option<Sel>, context_info: *mut c_void, )

Available on crate features NSResponder and NSWindowController only.

Safety

• delegate should be of the correct type.
• should_close_selector must be a valid selector.
• context_info must be a valid pointer or null.

pub fn displayName(&self) -> Retained<NSString>

pub fn defaultDraftName(&self) -> Retained<NSString>

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

Available on crate features NSResponder and NSWindow only.

pub fn readableTypes(mtm: MainThreadMarker) -> Retained<NSArray<NSString>>

pub fn writableTypes(mtm: MainThreadMarker) -> Retained<NSArray<NSString>>

pub fn isNativeType(type: &NSString, mtm: MainThreadMarker) -> bool

pub fn writableTypesForSaveOperation( &self, save_operation: NSSaveOperationType, ) -> Retained<NSArray<NSString>>

pub fn fileNameExtensionForType_saveOperation( &self, type_name: &NSString, save_operation: NSSaveOperationType, ) -> Option<Retained<NSString>>

pub fn validateUserInterfaceItem( &self, item: &ProtocolObject<dyn NSValidatedUserInterfaceItem>, ) -> bool

Available on crate feature NSUserInterfaceValidation only.

pub fn usesUbiquitousStorage(mtm: MainThreadMarker) -> bool

pub fn presentedItemURL(&self) -> Option<Retained<NSURL>>

pub fn observedPresentedItemUbiquityAttributes( &self, ) -> Retained<NSSet<NSURLResourceKey>>

pub unsafe fn relinquishPresentedItemToReader( &self, reader: &DynBlock<dyn Fn(*mut DynBlock<dyn Fn()>)>, )

Available on crate feature block2 only.

Safety

reader block must be sendable.

pub unsafe fn relinquishPresentedItemToWriter( &self, writer: &DynBlock<dyn Fn(*mut DynBlock<dyn Fn()>)>, )

Available on crate feature block2 only.

Safety

writer block must be sendable.

pub unsafe fn savePresentedItemChangesWithCompletionHandler( &self, completion_handler: &DynBlock<dyn Fn(*mut NSError)>, )

Available on crate feature block2 only.

Safety

completion_handler block must be sendable.

pub unsafe fn accommodatePresentedItemDeletionWithCompletionHandler( &self, completion_handler: &DynBlock<dyn Fn(*mut NSError)>, )

Available on crate feature block2 only.

Safety

completion_handler block must be sendable.

pub fn presentedItemDidMoveToURL(&self, new_url: &NSURL)

pub fn presentedItemDidChange(&self)

pub fn presentedItemDidChangeUbiquityAttributes( &self, attributes: &NSSet<NSURLResourceKey>, )

pub fn presentedItemDidGainVersion(&self, version: &NSFileVersion)

pub fn presentedItemDidLoseVersion(&self, version: &NSFileVersion)

pub fn presentedItemDidResolveConflictVersion(&self, version: &NSFileVersion)

impl NSDocument

Methods declared on superclass NSObject.

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

impl NSDocument

NSDeprecated.

pub fn shouldRunSavePanelWithAccessoryView(&self) -> bool

👎Deprecated

pub fn saveToURL_ofType_forSaveOperation_error( &self, url: &NSURL, type_name: &NSString, save_operation: NSSaveOperationType, ) -> Result<(), Retained<NSError>>

👎Deprecated: Use -saveToURL:ofType:forSaveOperation:completionHandler: instead

pub fn dataRepresentationOfType( &self, type: &NSString, ) -> Option<Retained<NSData>>

👎Deprecated

pub fn fileAttributesToWriteToFile_ofType_saveOperation( &self, full_document_path: &NSString, document_type_name: &NSString, save_operation_type: NSSaveOperationType, ) -> Option<Retained<NSDictionary>>

👎Deprecated

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

👎Deprecated

pub fn fileWrapperRepresentationOfType( &self, type: &NSString, ) -> Option<Retained<NSFileWrapper>>

👎Deprecated

pub fn initWithContentsOfFile_ofType( this: Allocated<Self>, absolute_path: &NSString, type_name: &NSString, ) -> Option<Retained<Self>>

👎Deprecated

pub fn initWithContentsOfURL_ofType( this: Allocated<Self>, url: &NSURL, type_name: &NSString, ) -> Option<Retained<Self>>

👎Deprecated

pub fn loadDataRepresentation_ofType( &self, data: &NSData, type: &NSString, ) -> bool

👎Deprecated

pub fn loadFileWrapperRepresentation_ofType( &self, wrapper: &NSFileWrapper, type: &NSString, ) -> bool

👎Deprecated

pub fn printShowingPrintPanel(&self, flag: bool)

👎Deprecated

pub fn readFromFile_ofType(&self, file_name: &NSString, type: &NSString) -> bool

👎Deprecated

pub fn readFromURL_ofType(&self, url: &NSURL, type: &NSString) -> bool

👎Deprecated

pub fn revertToSavedFromFile_ofType( &self, file_name: &NSString, type: &NSString, ) -> bool

👎Deprecated

pub fn revertToSavedFromURL_ofType(&self, url: &NSURL, type: &NSString) -> bool

👎Deprecated

pub fn runModalPageLayoutWithPrintInfo( &self, print_info: &NSPrintInfo, ) -> NSInteger

👎Deprecated

Available on crate feature NSPrintInfo only.

pub unsafe fn saveToFile_saveOperation_delegate_didSaveSelector_contextInfo( &self, file_name: &NSString, save_operation: NSSaveOperationType, delegate: Option<&AnyObject>, did_save_selector: Option<Sel>, context_info: *mut c_void, )

👎Deprecated

Safety

• delegate should be of the correct type.
• did_save_selector must be a valid selector.
• context_info must be a valid pointer or null.

pub fn setFileName(&self, file_name: Option<&NSString>)

👎Deprecated

pub fn writeToFile_ofType(&self, file_name: &NSString, type: &NSString) -> bool

👎Deprecated

pub fn writeToFile_ofType_originalFile_saveOperation( &self, full_document_path: &NSString, document_type_name: &NSString, full_original_document_path: Option<&NSString>, save_operation_type: NSSaveOperationType, ) -> bool

👎Deprecated

pub fn writeToURL_ofType(&self, url: &NSURL, type: &NSString) -> bool

👎Deprecated

pub fn writeWithBackupToFile_ofType_saveOperation( &self, full_document_path: &NSString, document_type_name: &NSString, save_operation_type: NSSaveOperationType, ) -> bool

👎Deprecated

impl NSDocument

NSScripting.

pub fn lastComponentOfFileName(&self) -> Retained<NSString>

Available on crate feature NSDocumentScripting only.

pub fn setLastComponentOfFileName(&self, last_component_of_file_name: &NSString)

Available on crate feature NSDocumentScripting only.

Setter for lastComponentOfFileName.

This is copied when set.

pub fn handleSaveScriptCommand( &self, command: &NSScriptCommand, ) -> Option<Retained<AnyObject>>

Available on crate feature NSDocumentScripting only.

pub fn handleCloseScriptCommand( &self, command: &NSCloseCommand, ) -> Option<Retained<AnyObject>>

Available on crate feature NSDocumentScripting only.

pub fn handlePrintScriptCommand( &self, command: &NSScriptCommand, ) -> Option<Retained<AnyObject>>

Available on crate feature NSDocumentScripting only.

pub fn objectSpecifier(&self) -> Retained<NSScriptObjectSpecifier>

Available on crate feature NSDocumentScripting only.

impl NSDocument

NSUserActivity.

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

Available on crate feature NSUserActivity only.

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

Available on crate feature NSUserActivity only.

Setter for userActivity.

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

Available on crate feature NSUserActivity only.

impl NSDocument

NSRestorableState.

pub unsafe fn restoreDocumentWindowWithIdentifier_state_completionHandler( &self, identifier: &NSUserInterfaceItemIdentifier, state: &NSCoder, completion_handler: &DynBlock<dyn Fn(*mut NSWindow, *mut NSError)>, )

Available on crate features NSWindowRestoration and NSResponder and NSUserInterfaceItemIdentification and NSWindow and block2 only.

Safety

state possibly has further requirements.

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

Available on crate feature NSWindowRestoration only.

Safety

coder possibly has further requirements.

pub unsafe fn encodeRestorableStateWithCoder_backgroundQueue( &self, coder: &NSCoder, queue: &NSOperationQueue, )

Available on crate feature NSWindowRestoration only.

Safety

• coder possibly has further requirements.
• queue possibly has additional threading requirements.

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

Available on crate feature NSWindowRestoration only.

Safety

coder possibly has further requirements.

pub fn invalidateRestorableState(&self)

Available on crate feature NSWindowRestoration only.

pub fn restorableStateKeyPaths( mtm: MainThreadMarker, ) -> Retained<NSArray<NSString>>

Available on crate feature NSWindowRestoration only.

pub fn allowedClassesForRestorableStateKeyPath( key_path: &NSString, mtm: MainThreadMarker, ) -> Retained<NSArray<AnyClass>>

Available on crate feature NSWindowRestoration only.

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 NSDocument

fn as_ref(&self) -> &AnyObject

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

impl AsRef<NSDocument> for NSDocument

fn as_ref(&self) -> &Self

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

impl AsRef<NSDocument> for NSPersistentDocument

Available on crate feature NSPersistentDocument only.

fn as_ref(&self) -> &NSDocument

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

impl AsRef<NSObject> for NSDocument

fn as_ref(&self) -> &NSObject

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

impl Borrow<AnyObject> for NSDocument

fn borrow(&self) -> &AnyObject

Immutably borrows from an owned value.

impl Borrow<NSDocument> for NSPersistentDocument

Available on crate feature NSPersistentDocument only.

fn borrow(&self) -> &NSDocument

Immutably borrows from an owned value.

impl Borrow<NSObject> for NSDocument

fn borrow(&self) -> &NSObject

Immutably borrows from an owned value.

impl ClassType for NSDocument

const NAME: &'static str = "NSDocument"

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 NSDocument

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

Formats the value using the given formatter.

impl Deref for NSDocument

type Target = NSObject

The resulting type after dereferencing.

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

Dereferences the value.

impl Hash for NSDocument

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 NSDocument

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

where Self: Sized,

Increment the reference count of the receiver.

impl NSEditorRegistration for NSDocument

fn objectDidBeginEditing(&self, editor: &ProtocolObject<dyn NSEditor>)

where Self: Sized + Message,

Available on crate feature NSKeyValueBinding only.

fn objectDidEndEditing(&self, editor: &ProtocolObject<dyn NSEditor>)

where Self: Sized + Message,

Available on crate feature NSKeyValueBinding only.

impl NSFilePresenter for NSDocument

fn presentedItemURL(&self) -> Option<Retained<NSURL>>

where Self: Sized + Message,

fn presentedItemOperationQueue(&self) -> Retained<NSOperationQueue>

where Self: Sized + Message,

fn primaryPresentedItemURL(&self) -> Option<Retained<NSURL>>

where Self: Sized + Message,

fn presentedItemDidMoveToURL(&self, new_url: &NSURL)

where Self: Sized + Message,

fn presentedItemDidChange(&self)

where Self: Sized + Message,

fn presentedItemDidChangeUbiquityAttributes(&self, attributes: &NSSet<NSString>)

where Self: Sized + Message,

fn observedPresentedItemUbiquityAttributes(&self) -> Retained<NSSet<NSString>>

where Self: Sized + Message,

fn presentedItemDidGainVersion(&self, version: &NSFileVersion)

where Self: Sized + Message,

fn presentedItemDidLoseVersion(&self, version: &NSFileVersion)

where Self: Sized + Message,

fn presentedItemDidResolveConflictVersion(&self, version: &NSFileVersion)

where Self: Sized + Message,

fn presentedSubitemDidAppearAtURL(&self, url: &NSURL)

where Self: Sized + Message,

fn presentedSubitemAtURL_didMoveToURL(&self, old_url: &NSURL, new_url: &NSURL)

where Self: Sized + Message,

fn presentedSubitemDidChangeAtURL(&self, url: &NSURL)

where Self: Sized + Message,

fn presentedSubitemAtURL_didGainVersion( &self, url: &NSURL, version: &NSFileVersion, )

where Self: Sized + Message,

fn presentedSubitemAtURL_didLoseVersion( &self, url: &NSURL, version: &NSFileVersion, )

where Self: Sized + Message,

fn presentedSubitemAtURL_didResolveConflictVersion( &self, url: &NSURL, version: &NSFileVersion, )

where Self: Sized + Message,

impl NSMenuItemValidation for NSDocument

fn validateMenuItem(&self, menu_item: &NSMenuItem) -> bool

where Self: Sized + Message,

Available on crate features NSMenu and NSMenuItem only.

impl NSObjectProtocol for NSDocument

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 NSUserActivityRestoring for NSDocument

Available on crate feature NSUserActivity only.

fn restoreUserActivityState(&self, user_activity: &NSUserActivity)

where Self: Sized + Message,

impl NSUserInterfaceValidations for NSDocument

fn validateUserInterfaceItem( &self, item: &ProtocolObject<dyn NSValidatedUserInterfaceItem>, ) -> bool

where Self: Sized + Message,

Available on crate feature NSUserInterfaceValidation only.

impl PartialEq for NSDocument

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 NSDocument

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

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

impl DowncastTarget for NSDocument

impl Eq for NSDocument