Struct UIDocument

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

Available on crate feature UIDocument only.

Apple’s documentation

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

Setter for fileModificationDate.

pub unsafe fn documentState(&self) -> UIDocumentState

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

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

Available on crate feature block2 only.

pub unsafe fn closeWithCompletionHandler( &self, completion_handler: Option<&DynBlock<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>)

Setter for undoManager.

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<&DynBlock<dyn Fn(Bool)>>, )

Available on crate feature block2 only.

pub unsafe fn autosaveWithCompletionHandler( &self, completion_handler: Option<&DynBlock<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: &DynBlock<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<&DynBlock<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>)

Setter for userActivity.

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.

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 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 fn downcast_ref<T>(&self) -> Option<&T>

where T: DowncastTarget,

Available on crate feature UIIndirectScribbleInteraction 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 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 ClassType for UIDocument

const NAME: &'static str = "UIDocument"

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

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

where Self: Sized,

Increment the reference count of the receiver.

impl NSFilePresenter for UIDocument

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

where Self: Sized + Message,

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

where Self: Sized + Message,

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

where Self: Sized + Message,

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

where Self: Sized + Message,

unsafe fn presentedItemDidChange(&self)

where Self: Sized + Message,

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

where Self: Sized + Message,

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

where Self: Sized + Message,

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

where Self: Sized + Message,

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

where Self: Sized + Message,

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

where Self: Sized + Message,

impl NSObjectProtocol for UIDocument

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

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

where Self: Sized + Message,

impl PartialEq for UIDocument

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

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

where Self: Sized + Message,

Available on crate feature UINavigationItem only.

This method is called when renaming has ended. The title on the navigation item has already been changed when this method is called but clients can make further adjustments to it when necessary.

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

where Self: Sized + Message,

Available on crate feature UINavigationItem only.

Controls whether the rename action is supported for the given navigation item. For example this method is called when the navigation bar’s document menu is shown to validate if the rename action should be part of that menu.

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

where Self: Sized + Message,

Available on crate feature UINavigationItem only.

Called when we begin renaming. Implementing this method allows for customizing the initial text that will show up in the text field as well as the selected range of that text.

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

where Self: Sized + Message,

Available on crate feature UINavigationItem only.

This method can be used to prevent renaming from happening. However there are cases (e.g. when a new navigation item is pushed on the navigation bar) where this method will not be called and instead navigationItem:didEndRenamingWithTitle: is called right away. Clients are therefore expected to handle titles in navigationItem:didEndRenamingWithTitle: for which they would return NO from navigationItem:shouldEndRenamingWithTitle:.

impl UIUserActivityRestoring for UIDocument

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

where Self: Sized + Message,

Available on crate feature UIUserActivity only.

impl DowncastTarget for UIDocument

impl Eq for UIDocument