Struct NSDocument

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

Available on crate feature NSDocument only.

Apple’s documentation

Implementations

impl NSDocument

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

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

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

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

pub unsafe 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 unsafe fn fileType(&self) -> Option<Retained<NSString>>

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

Setter for fileType.

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

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

Setter for fileURL.

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

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

Setter for fileModificationDate.

pub unsafe fn isDraft(&self) -> bool

pub unsafe fn setDraft(&self, draft: bool)

Setter for isDraft.

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

Available on crate feature block2 only.

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

Available on crate feature block2 only.

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

Available on crate feature block2 only.

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

Available on crate feature block2 only.

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

Available on crate feature block2 only.

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

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

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

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

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

pub unsafe fn isEntireFileLoaded(&self) -> bool

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

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

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

pub unsafe fn unblockUserInteraction(&self)

pub unsafe fn autosavingIsImplicitlyCancellable(&self) -> bool

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

pub unsafe 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 unsafe 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 unsafe fn keepBackupFile(&self) -> bool

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

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

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

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

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

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

pub unsafe fn savePanelShowsFileFormatsControl(&self) -> bool

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

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

pub unsafe fn fileNameExtensionWasHiddenInLastRunSavePanel(&self) -> bool

pub unsafe 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, )

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

Available on crate feature block2 only.

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

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

pub unsafe fn scheduleAutosaving(&self)

pub unsafe fn hasUnautosavedChanges(&self) -> bool

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

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

Available on crate feature block2 only.

pub unsafe fn autosavesInPlace(mtm: MainThreadMarker) -> bool

pub unsafe fn preservesVersions(mtm: MainThreadMarker) -> bool

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

pub unsafe fn isBrowsingVersions(&self) -> bool

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

Available on crate feature block2 only.

pub unsafe fn autosavesDrafts(mtm: MainThreadMarker) -> bool

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

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

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

Setter for autosavedContentsFileURL.

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

pub unsafe fn close(&self)

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

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

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

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

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

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

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

Available on crate feature block2 only.

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

Available on crate feature block2 only.

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

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

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

Available on crate feature block2 only.

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

Available on crate feature block2 only.

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

Available on crate feature block2 only.

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

Available on crate feature block2 only.

pub unsafe fn isLocked(&self) -> bool

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

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.

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

Available on crate feature NSPageLayout only.

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

Available on crate feature NSPrintInfo only.

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

Available on crate feature NSPrintInfo only.

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

Available on crate feature NSPrintInfo only.

Setter for printInfo.

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

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.

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

Available on crate features NSPrintInfo and NSPrintOperation only.

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.

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

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

Available on crate feature NSPrintOperation only.

pub unsafe fn allowsDocumentSharing(&self) -> bool

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

Available on crate features NSSharingService and block2 only.

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

Available on crate feature NSSharingService only.

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

Available on crate feature NSPreviewRepresentingActivityItem only.

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

Available on crate feature NSPreviewRepresentingActivityItem only.

Setter for previewRepresentableActivityItems.

pub unsafe fn isDocumentEdited(&self) -> bool

pub unsafe fn isInViewingMode(&self) -> bool

pub unsafe fn updateChangeCount(&self, change: NSDocumentChangeType)

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

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

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

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

Setter for undoManager.

pub unsafe fn hasUndoManager(&self) -> bool

pub unsafe 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.

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

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

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

pub unsafe fn makeWindowControllers(&self)

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

Available on crate feature NSNib only.

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

Available on crate features NSResponder and NSWindowController only.

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

Available on crate features NSResponder and NSWindowController only.

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

Available on crate features NSResponder and NSWindow only.

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

Available on crate features NSResponder and NSWindowController only.

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

Available on crate features NSResponder and NSWindowController only.

pub unsafe fn showWindows(&self)

pub unsafe 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.

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

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

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

Available on crate features NSResponder and NSWindow only.

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

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

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

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

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

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

Available on crate feature NSUserInterfaceValidation only.

pub unsafe fn usesUbiquitousStorage(mtm: MainThreadMarker) -> bool

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

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

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

Available on crate feature block2 only.

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

Available on crate feature block2 only.

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

Available on crate feature block2 only.

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

Available on crate feature block2 only.

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

pub unsafe fn presentedItemDidChange(&self)

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

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

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

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

impl NSDocument

Methods declared on superclass NSObject.

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

impl NSDocument

NSDeprecated.

pub unsafe fn shouldRunSavePanelWithAccessoryView(&self) -> bool

👎Deprecated

pub unsafe 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 unsafe fn dataRepresentationOfType( &self, type: &NSString, ) -> Option<Retained<NSData>>

👎Deprecated

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

👎Deprecated

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

👎Deprecated

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

👎Deprecated

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

👎Deprecated

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

👎Deprecated

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

👎Deprecated

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

👎Deprecated

pub unsafe fn printShowingPrintPanel(&self, flag: bool)

👎Deprecated

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

👎Deprecated

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

👎Deprecated

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

👎Deprecated

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

👎Deprecated

pub unsafe 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

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

👎Deprecated

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

👎Deprecated

pub unsafe 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 unsafe fn writeToURL_ofType(&self, url: &NSURL, type: &NSString) -> bool

👎Deprecated

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

👎Deprecated

impl NSDocument

NSScripting.

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

Available on crate feature NSDocumentScripting only.

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

Available on crate feature NSDocumentScripting only.

Setter for lastComponentOfFileName.

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

Available on crate feature NSDocumentScripting only.

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

Available on crate feature NSDocumentScripting only.

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

Available on crate feature NSDocumentScripting only.

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

Available on crate feature NSDocumentScripting only.

impl NSDocument

NSUserActivity.

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

Available on crate feature NSUserActivity only.

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

Available on crate feature NSUserActivity only.

Setter for userActivity.

pub unsafe 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: &Block<dyn Fn(*mut NSWindow, *mut NSError)>, )

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

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

Available on crate feature NSWindowRestoration only.

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

Available on crate feature NSWindowRestoration only.

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

Available on crate feature NSWindowRestoration only.

pub unsafe fn invalidateRestorableState(&self)

Available on crate feature NSWindowRestoration only.

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

Available on crate feature NSWindowRestoration only.

pub unsafe 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.

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

Available on crate feature NSKeyValueBinding only.

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

where Self: Sized + Message,

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

where Self: Sized + Message,

impl NSFilePresenter for NSDocument

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

where Self: Sized + Message,

Available on crate feature NSURL only.

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

where Self: Sized + Message,

Available on crate feature NSOperation only.

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

where Self: Sized + Message,

Available on crate feature NSURL only.

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

where Self: Sized + Message,

Available on crate feature NSURL only.

unsafe fn presentedItemDidChange(&self)

where Self: Sized + Message,

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

where Self: Sized + Message,

Available on crate features NSSet and NSString and NSURL only.

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

where Self: Sized + Message,

Available on crate features NSSet and NSString and NSURL only.

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

where Self: Sized + Message,

Available on crate feature NSFileVersion only.

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

where Self: Sized + Message,

Available on crate feature NSFileVersion only.

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

where Self: Sized + Message,

Available on crate feature NSFileVersion only.

unsafe fn presentedSubitemDidAppearAtURL(&self, url: &NSURL)

where Self: Sized + Message,

Available on crate feature NSURL only.

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

where Self: Sized + Message,

Available on crate feature NSURL only.

unsafe fn presentedSubitemDidChangeAtURL(&self, url: &NSURL)

where Self: Sized + Message,

Available on crate feature NSURL only.

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

where Self: Sized + Message,

Available on crate features NSFileVersion and NSURL only.

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

where Self: Sized + Message,

Available on crate features NSFileVersion and NSURL only.

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

where Self: Sized + Message,

Available on crate features NSFileVersion and NSURL only.

impl NSMenuItemValidation for NSDocument

Available on crate feature NSMenu only.

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

where Self: Sized + Message,

Available on crate feature 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.

unsafe fn restoreUserActivityState(&self, user_activity: &NSUserActivity)

where Self: Sized + Message,

impl NSUserInterfaceValidations for NSDocument

Available on crate feature NSUserInterfaceValidation only.

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

where Self: Sized + Message,

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