Struct UIEditMenuInteraction

Source

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

Available on crate feature UIEditMenuInteraction only.

Expand description

Apple’s documentation

Implementations§

Source §

impl UIEditMenuInteraction

Source

pub unsafe fn delegate( &self, ) -> Option<Retained<ProtocolObject<dyn UIEditMenuInteractionDelegate>>>

The object that defines the delegate of the interaction.

Source

pub unsafe fn initWithDelegate( this: Allocated<Self>, delegate: Option<&ProtocolObject<dyn UIEditMenuInteractionDelegate>>, ) -> Retained<Self>

Creates a new edit menu interaction with the specified delegate.

Source

pub unsafe fn presentEditMenuWithConfiguration( &self, configuration: &UIEditMenuConfiguration, )

Presents an edit menu with the specified configurationobject. If a menu is already presented, it will be dismissed automatically before the new menu is presented.

: presentEditMenuWithConfiguration:is not supported on Mac Catalyst.

Source

pub unsafe fn dismissMenu(&self)

Dismiss the currently active menu if one is currently presented.

Source

pub unsafe fn reloadVisibleMenu(&self)

Reloads the visible menu. This menu has no effect if there is no menu presented. This method will query the menu again from the delegate method editMenuInteraction:menuForConfiguration:suggestedActions:and refresh the UI with the updated menu.

Source

pub unsafe fn updateVisibleMenuPositionAnimated(&self, animated: bool)

Updates the position of the currently visible menu, with an option to animate the action. This method has no effect if no menu is presented. This method will query the position from the delegate method editMenuInteraction:targetRectForConfiguration:if it is implemented.

Source

pub unsafe fn locationInView(&self, view: Option<&UIView>) -> CGPoint

Available on crate features UIResponder and UIView and objc2-core-foundation only.

Returns the interaction’s location within the given view.

Source

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

Source

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

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