Struct objc2_ui_kit::UIDocument

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

Available on crate feature UIDocument only.

Implementations

impl UIDocument

pub unsafe fn initWithFileURL( this: Allocated<Self>, url: &NSURL ) -> Retained<Self>

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

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

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

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

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

pub unsafe fn documentState(&self) -> UIDocumentState

pub unsafe fn progress(&self) -> Option<Retained<NSProgress>>

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

Available on crate feature block2 only.

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

Available on crate feature block2 only.

pub unsafe fn loadFromContents_ofType_error( &self, contents: &AnyObject, type_name: Option<&NSString> ) -> Result<(), Retained<NSError>>

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

pub unsafe fn disableEditing(&self)

pub unsafe fn enableEditing(&self)

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

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

pub unsafe fn hasUnsavedChanges(&self) -> bool

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

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

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

pub unsafe fn saveToURL_forSaveOperation_completionHandler( &self, url: &NSURL, save_operation: UIDocumentSaveOperation, completion_handler: Option<&Block<dyn Fn(Bool)>> )

Available on crate feature block2 only.

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

Available on crate feature block2 only.

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

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

pub unsafe fn writeContents_andAttributes_safelyToURL_forSaveOperation_error( &self, contents: &AnyObject, additional_file_attributes: Option<&NSDictionary>, url: &NSURL, save_operation: UIDocumentSaveOperation ) -> Result<(), Retained<NSError>>

pub unsafe fn writeContents_toURL_forSaveOperation_originalContentsURL_error( &self, contents: &AnyObject, url: &NSURL, save_operation: UIDocumentSaveOperation, original_contents_url: Option<&NSURL> ) -> Result<(), Retained<NSError>>

pub unsafe fn fileAttributesToWriteToURL_forSaveOperation_error( &self, url: &NSURL, save_operation: UIDocumentSaveOperation ) -> Result<Retained<NSDictionary>, Retained<NSError>>

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

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

Available on crate feature block2 only.

pub unsafe fn handleError_userInteractionPermitted( &self, error: &NSError, user_interaction_permitted: bool )

pub unsafe fn finishedHandlingError_recovered( &self, error: &NSError, recovered: bool )

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

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

Available on crate feature block2 only.

impl UIDocument

Methods declared on superclass NSObject

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

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

impl UIDocument

ActivityContinuation

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

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

pub unsafe fn updateUserActivityState(&self, user_activity: &NSUserActivity)

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

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 UIIndirectScribbleInteraction 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 UIIndirectScribbleInteraction 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 UIIndirectScribbleInteraction 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 UIDocument

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

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

impl AsMut<NSObject> for UIDocument

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

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

impl AsMut<UIDocument> for UIDocument

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

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

impl AsMut<UIDocument> for UIManagedDocument

Available on crate feature UIManagedDocument only.

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

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

impl AsRef<AnyObject> for UIDocument

fn as_ref(&self) -> &AnyObject

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

impl AsRef<NSObject> for UIDocument

fn as_ref(&self) -> &NSObject

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

impl AsRef<UIDocument> for UIDocument

fn as_ref(&self) -> &Self

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

impl AsRef<UIDocument> for UIManagedDocument

Available on crate feature UIManagedDocument only.

fn as_ref(&self) -> &UIDocument

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

impl Borrow<AnyObject> for UIDocument

fn borrow(&self) -> &AnyObject

Immutably borrows from an owned value.

impl Borrow<NSObject> for UIDocument

fn borrow(&self) -> &NSObject

Immutably borrows from an owned value.

impl Borrow<UIDocument> for UIManagedDocument

Available on crate feature UIManagedDocument only.

fn borrow(&self) -> &UIDocument

Immutably borrows from an owned value.

impl BorrowMut<AnyObject> for UIDocument

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

Mutably borrows from an owned value.

impl BorrowMut<NSObject> for UIDocument

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

Mutably borrows from an owned value.

impl BorrowMut<UIDocument> for UIManagedDocument

Available on crate feature UIManagedDocument only.

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

Mutably borrows from an owned value.

impl ClassType for UIDocument

type Super = NSObject

The superclass of this class.

type Mutability = MainThreadOnly

Whether the type is mutable or immutable.

const NAME: &'static str = "UIDocument"

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) -> Retained<Self>

where Self: IsRetainable + Sized,

Increment the reference count of the receiver.

impl Debug for UIDocument

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

Formats the value using the given formatter.

impl Deref for UIDocument

type Target = NSObject

The resulting type after dereferencing.

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

Dereferences the value.

impl DerefMut for UIDocument

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

Mutably dereferences the value.

impl Hash for UIDocument

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 NSFilePresenter for UIDocument

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 relinquishPresentedItemToReader( &self, reader: &Block<dyn Fn(*mut Block<dyn Fn()>)> )

where Self: Sized + Message,

Available on crate feature block2 only.

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

where Self: Sized + Message,

Available on crate feature block2 only.

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

where Self: Sized + Message,

Available on crate features NSError and block2 only.

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

where Self: Sized + Message,

Available on crate features NSError and block2 only.

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

where Self: Sized + Message,

Available on crate features NSError and block2 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 accommodatePresentedSubitemDeletionAtURL_completionHandler( &self, url: &NSURL, completion_handler: &Block<dyn Fn(*mut NSError)> )

where Self: Sized + Message,

Available on crate features NSError and NSURL and block2 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.

impl NSObjectProtocol for UIDocument

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) -> 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 NSProgressReporting for UIDocument

unsafe fn progress(&self) -> Retained<NSProgress>

where Self: Sized + Message,

impl PartialEq for UIDocument

fn eq(&self, other: &UIDocument) -> 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 UIDocument

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

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

impl UINavigationItemRenameDelegate for UIDocument

Available on crate feature UINavigationItem only.

unsafe fn navigationItem_didEndRenamingWithTitle( &self, navigation_item: &UINavigationItem, title: &NSString )

where Self: Sized + Message,

unsafe fn navigationItemShouldBeginRenaming( &self, navigation_item: &UINavigationItem ) -> bool

where Self: Sized + Message,

unsafe fn navigationItem_willBeginRenamingWithSuggestedTitle_selectedRange( &self, navigation_item: &UINavigationItem, title: &NSString, selected_range: NonNull<NSRange> ) -> Retained<NSString>

where Self: Sized + Message,

unsafe fn navigationItem_shouldEndRenamingWithTitle( &self, navigation_item: &UINavigationItem, title: &NSString ) -> bool

where Self: Sized + Message,

impl UIUserActivityRestoring for UIDocument

Available on crate feature UIUserActivity only.

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

where Self: Sized + Message,

impl Eq for UIDocument

impl Message for UIDocument

impl StructuralPartialEq for UIDocument