Struct objc2_app_kit::NSDocumentController

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

Available on crate feature NSDocumentController only.

Implementations

impl NSDocumentController

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

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

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

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

Available on crate feature NSDocument only.

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

Available on crate feature NSDocument only.

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

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

Available on crate feature NSDocument only.

pub unsafe fn documentForWindow( &self, window: &NSWindow ) -> Option<Id<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<Id<NSDocument>, Id<NSError>>

Available on crate feature NSDocument only.

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

Available on crate feature NSDocument only.

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

pub unsafe fn URLsFromRunningOpenPanel(&self) -> Option<Id<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: &Block<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: &Block<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: &Block<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<Id<NSDocument>, Id<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: &Block<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<Id<NSDocument>, Id<NSError>>

Available on crate feature NSDocument only.

pub unsafe fn autosavingDelay(&self) -> NSTimeInterval

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

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<Id<NSDocument>, Id<NSError>>

Available on crate feature NSDocument only.

pub unsafe fn allowsAutomaticShareMenu(&self) -> bool

pub unsafe fn standardShareMenuItem(&self) -> Id<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) -> Id<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) -> Id<NSArray<NSURL>>

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

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

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

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

pub unsafe fn displayNameForType( &self, type_name: &NSString ) -> Option<Id<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) -> Id<Self>

impl NSDocumentController

NSDeprecated

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

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

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

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

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

👎Deprecated

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

👎Deprecated

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

👎Deprecated

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

👎Deprecated

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

👎Deprecated

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

👎Deprecated

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

👎Deprecated

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

👎Deprecated

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

👎Deprecated

pub unsafe fn openUntitledDocumentOfType_display( &self, type: &NSString, display: bool ) -> Option<Id<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.

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 unsafe fn get_mut_ivar<T>(&mut self, name: &str) -> &mut T

where T: Encode,

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

Available on crate feature NSAccessibilityConstants only.

Use Ivar::load_mut 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.

Trait Implementations

impl AsMut<AnyObject> for NSDocumentController

fn as_mut(&mut self) -> &mut AnyObject

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

impl AsMut<NSDocumentController> for NSDocumentController

fn as_mut(&mut self) -> &mut Self

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

impl AsMut<NSObject> for NSDocumentController

fn as_mut(&mut self) -> &mut NSObject

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

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 BorrowMut<AnyObject> for NSDocumentController

fn borrow_mut(&mut self) -> &mut AnyObject

Mutably borrows from an owned value.

impl BorrowMut<NSObject> for NSDocumentController

fn borrow_mut(&mut self) -> &mut NSObject

Mutably borrows from an owned value.

impl ClassType for NSDocumentController

type Super = NSObject

The superclass of this class.

type Mutability = MainThreadOnly

Whether the type is mutable or immutable.

const NAME: &'static str = "NSDocumentController"

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

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.

fn as_super_mut(&mut self) -> &mut Self::Super

Get a mutable reference to the superclass.

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

where Self: IsRetainable + Sized,

Increment the reference count of the receiver.

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

fn deref_mut(&mut self) -> &mut Self::Target

Mutably 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 NSCoding for NSDocumentController

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

where Self: Sized + Message,

Available on crate feature NSCoder only.

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

where Self: Sized + Message,

Available on crate feature NSCoder only.

impl NSMenuItemValidation for NSDocumentController

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 NSDocumentController

fn isEqual(&self, other: &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,

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) -> Id<NSObject>

where Self: Sized + Message,

A textual representation of the object.

fn debugDescription(&self) -> Id<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

Available on crate feature NSUserInterfaceValidation only.

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

where Self: Sized + Message,

impl NSWindowRestoration for NSDocumentController

Available on crate feature NSWindowRestoration only.

unsafe fn restoreWindowWithIdentifier_state_completionHandler( identifier: &NSUserInterfaceItemIdentifier, state: &NSCoder, completion_handler: &Block<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: &NSDocumentController) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method 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 Eq for NSDocumentController

impl Message for NSDocumentController

impl StructuralPartialEq for NSDocumentController