Struct UIDragItem

Source

pub struct UIDragItem { /* private fields */ }

Available on crate feature UIDragItem only.

Expand description

Apple’s documentation

Implementations§

Source §

impl UIDragItem

Source

pub fn initWithItemProvider( this: Allocated<Self>, item_provider: &NSItemProvider, ) -> Retained<Self>

Source

pub fn localObject(&self) -> Option<Retained<AnyObject>>

Use localObject to attach additional information to this drag item, visible only inside the app that started the drag.

Source

pub unsafe fn setLocalObject(&self, local_object: Option<&AnyObject>)

Setter for localObject.

§Safety

local_object should be of the correct type.

Source

pub fn previewProvider(&self) -> mut DynBlock<dyn Fn() -> mut UIDragPreview>

Available on crate features UIDragPreview and block2 only.

Use previewProvider to change the preview for an item.

Each item is usually given a preview when the drag begins, either by the UIDragInteractionDelegate’s -dragInteraction:previewForLiftingItem:session: method, or by creating a preview from the dragging view.

During the drag, applications may attempt to change the item’s preview, by setting previewProvider to a block that returns a preview. It will be called when and if the system requests it.

To use the default preview, set previewProvider to nil. To hide the preview, set previewProvider to a block that returns nil.

Source

pub unsafe fn setPreviewProvider( &self, preview_provider: Option<&DynBlock<dyn Fn() -> *mut UIDragPreview>>, )

Available on crate features UIDragPreview and block2 only.

Setter for previewProvider.

This is copied when set.

§Safety

preview_provider block’s return must be a valid pointer or null.

Source

pub fn setNeedsDropPreviewUpdate(&self)

Requests for the drop preview to be updated if an active drop animation is in progress, and can handle updates. If no active drop animation is in progress for the specified item, then nothing happens.

Methods from Deref<Target = NSObject>§

Source

pub fn doesNotRecognizeSelector(&self, sel: Sel) -> !

Handle messages the object doesn’t recognize.

See Apple’s documentation for details.

Methods from Deref<Target = AnyObject>§

Source

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());

Source

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.

Source

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