Struct NSDocumentController

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

Available on crate feature NSDocumentController only.

Apple’s documentation

Implementations

impl NSDocumentController

pub unsafe fn sharedDocumentController( mtm: MainThreadMarker, ) -> Retained<NSDocumentController>

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

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

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

Available on crate feature NSDocument only.

pub unsafe fn currentDocument(&self) -> Option<Retained<NSDocument>>

Available on crate feature NSDocument only.

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

pub unsafe fn documentForURL(&self, url: &NSURL) -> Option<Retained<NSDocument>>

Available on crate feature NSDocument only.

pub unsafe fn documentForWindow( &self, window: &NSWindow, ) -> Option<Retained<NSDocument>>

Available on crate features NSDocument and NSResponder and NSWindow only.

pub unsafe fn addDocument(&self, document: &NSDocument)

Available on crate feature NSDocument only.

pub unsafe fn removeDocument(&self, document: &NSDocument)

Available on crate feature NSDocument only.

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

pub unsafe fn openUntitledDocumentAndDisplay_error( &self, display_document: bool, ) -> Result<Retained<NSDocument>, Retained<NSError>>

Available on crate feature NSDocument only.

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

Available on crate feature NSDocument only.

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

pub unsafe fn URLsFromRunningOpenPanel( &self, ) -> Option<Retained<NSArray<NSURL>>>

pub unsafe fn runModalOpenPanel_forTypes( &self, open_panel: &NSOpenPanel, types: Option<&NSArray<NSString>>, ) -> NSInteger

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

pub unsafe fn beginOpenPanelWithCompletionHandler( &self, completion_handler: &DynBlock<dyn Fn(*mut NSArray<NSURL>)>, )

Available on crate feature block2 only.

pub unsafe fn beginOpenPanel_forTypes_completionHandler( &self, open_panel: &NSOpenPanel, in_types: Option<&NSArray<NSString>>, completion_handler: &DynBlock<dyn Fn(NSInteger)>, )

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

pub unsafe fn openDocumentWithContentsOfURL_display_completionHandler( &self, url: &NSURL, display_document: bool, completion_handler: &DynBlock<dyn Fn(*mut NSDocument, Bool, *mut NSError)>, )

Available on crate features NSDocument and block2 only.

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

Available on crate feature NSDocument only.

pub unsafe fn reopenDocumentForURL_withContentsOfURL_display_completionHandler( &self, url_or_nil: Option<&NSURL>, contents_url: &NSURL, display_document: bool, completion_handler: &DynBlock<dyn Fn(*mut NSDocument, Bool, *mut NSError)>, )

Available on crate features NSDocument and block2 only.

pub unsafe fn makeDocumentForURL_withContentsOfURL_ofType_error( &self, url_or_nil: Option<&NSURL>, contents_url: &NSURL, type_name: &NSString, ) -> Result<Retained<NSDocument>, Retained<NSError>>

Available on crate feature NSDocument only.

pub unsafe fn autosavingDelay(&self) -> NSTimeInterval

pub unsafe fn setAutosavingDelay(&self, autosaving_delay: NSTimeInterval)

Setter for autosavingDelay.

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

pub unsafe fn hasEditedDocuments(&self) -> bool

pub unsafe fn reviewUnsavedDocumentsWithAlertTitle_cancellable_delegate_didReviewAllSelector_contextInfo( &self, title: Option<&NSString>, cancellable: bool, delegate: Option<&AnyObject>, did_review_all_selector: Option<Sel>, context_info: *mut c_void, )

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

pub unsafe fn duplicateDocumentWithContentsOfURL_copying_displayName_error( &self, url: &NSURL, duplicate_by_copying: bool, display_name_or_nil: Option<&NSString>, ) -> Result<Retained<NSDocument>, Retained<NSError>>

Available on crate feature NSDocument only.

pub unsafe fn allowsAutomaticShareMenu(&self) -> bool

pub unsafe fn standardShareMenuItem(&self) -> Retained<NSMenuItem>

Available on crate feature NSMenuItem only.

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 maximumRecentDocumentCount(&self) -> NSUInteger

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

pub unsafe fn noteNewRecentDocument(&self, document: &NSDocument)

Available on crate feature NSDocument only.

pub unsafe fn noteNewRecentDocumentURL(&self, url: &NSURL)

pub unsafe fn recentDocumentURLs(&self) -> Retained<NSArray<NSURL>>

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

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

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

pub unsafe fn documentClassForType( &self, type_name: &NSString, ) -> Option<&'static AnyClass>

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

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

Available on crate feature NSUserInterfaceValidation only.

impl NSDocumentController

Methods declared on superclass NSObject.

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

impl NSDocumentController

NSDeprecated.

pub unsafe fn openDocumentWithContentsOfURL_display_error( &self, url: &NSURL, display_document: bool, ) -> Result<Retained<AnyObject>, Retained<NSError>>

👎Deprecated: Use -openDocumentWithContentsOfURL:display:completionHandler: instead

pub unsafe fn reopenDocumentForURL_withContentsOfURL_error( &self, url: Option<&NSURL>, contents_url: &NSURL, ) -> Result<(), Retained<NSError>>

👎Deprecated: Use -reopenDocumentForURL:withContentsOfURL:display:completionHandler: instead

pub unsafe fn fileExtensionsFromType( &self, type_name: &NSString, ) -> Option<Retained<NSArray>>

👎Deprecated

pub unsafe fn typeFromFileExtension( &self, file_name_extension_or_hfs_file_type: &NSString, ) -> Option<Retained<NSString>>

👎Deprecated

pub unsafe fn documentForFileName( &self, file_name: &NSString, ) -> Option<Retained<AnyObject>>

👎Deprecated

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

👎Deprecated

pub unsafe fn makeDocumentWithContentsOfFile_ofType( &self, file_name: &NSString, type: &NSString, ) -> Option<Retained<AnyObject>>

👎Deprecated

pub unsafe fn makeDocumentWithContentsOfURL_ofType( &self, url: &NSURL, type: Option<&NSString>, ) -> Option<Retained<AnyObject>>

👎Deprecated

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

👎Deprecated

pub unsafe fn openDocumentWithContentsOfFile_display( &self, file_name: &NSString, display: bool, ) -> Option<Retained<AnyObject>>

👎Deprecated

pub unsafe fn openDocumentWithContentsOfURL_display( &self, url: &NSURL, display: bool, ) -> Option<Retained<AnyObject>>

👎Deprecated

pub unsafe fn openUntitledDocumentOfType_display( &self, type: &NSString, display: bool, ) -> Option<Retained<AnyObject>>

👎Deprecated

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

👎Deprecated

pub unsafe fn shouldCreateUI(&self) -> bool

👎Deprecated

impl NSDocumentController

This impl block contains no items.

NSWindowRestoration.

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 NSDocumentController

fn as_ref(&self) -> &AnyObject

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

impl AsRef<NSDocumentController> for NSDocumentController

fn as_ref(&self) -> &Self

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

impl AsRef<NSObject> for NSDocumentController

fn as_ref(&self) -> &NSObject

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

impl Borrow<AnyObject> for NSDocumentController

fn borrow(&self) -> &AnyObject

Immutably borrows from an owned value.

impl Borrow<NSObject> for NSDocumentController

fn borrow(&self) -> &NSObject

Immutably borrows from an owned value.

impl ClassType for NSDocumentController

const NAME: &'static str = "NSDocumentController"

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 NSDocumentController

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

Formats the value using the given formatter.

impl Deref for NSDocumentController

type Target = NSObject

The resulting type after dereferencing.

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

Dereferences the value.

impl Hash for NSDocumentController

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 NSDocumentController

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

where Self: Sized,

Increment the reference count of the receiver.

impl NSCoding for NSDocumentController

unsafe fn encodeWithCoder(&self, coder: &NSCoder)

where Self: Sized + Message,

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

where Self: Sized + Message,

impl NSMenuItemValidation for NSDocumentController

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

where Self: Sized + Message,

Available on crate features NSMenu and NSMenuItem only.

impl NSObjectProtocol for NSDocumentController

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 NSUserInterfaceValidations for NSDocumentController

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

where Self: Sized + Message,

Available on crate feature NSUserInterfaceValidation only.

impl NSWindowRestoration for NSDocumentController

Available on crate feature NSWindowRestoration only.

unsafe fn restoreWindowWithIdentifier_state_completionHandler( identifier: &NSUserInterfaceItemIdentifier, state: &NSCoder, completion_handler: &DynBlock<dyn Fn(*mut NSWindow, *mut NSError)>, mtm: MainThreadMarker, )

where Self: Sized + ClassType,

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

impl PartialEq for NSDocumentController

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 NSDocumentController

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

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

impl DowncastTarget for NSDocumentController

impl Eq for NSDocumentController