Struct BEContextMenuConfiguration

Source

pub struct BEContextMenuConfiguration { /* private fields */ }

Available on crate feature BEContextMenuConfiguration only.

Expand description

A specialized UIContextMenuConfiguration object to defer a context menu presentation when the when the context menu gestures are first recognized and a possible menu presentation is not immediately known.

Implementations§

Source §

impl BEContextMenuConfiguration

Source

pub unsafe fn fulfillUsingConfiguration( &self, configuration: Option<&UIContextMenuConfiguration>, ) -> bool

Fulfills the configuration with a concrete configuration. Once fulfilled, the context menu presentation will begin. You should call this method as soon as you have determined that a menu presentation is possible for the configuration, as to minimize the delay between the context menu gesture’s recognition and the menu’s presentation. If no menu presentation is possible, fulfill with a nil configuration.

There is a system-defined timeout before the configuration is cancelled, where no menu presents. This method returns YES if the configuration did successfully prepare, and NO otherwise.

: The fulfilled configuration is used by UIContextMenuInteractionDelegate when referencing any UIContextMenuConfiguration, rather than this object.

Source

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

Creates a new configuration for the context menu interaction.

Source

pub unsafe fn configurationWithIdentifier_previewProvider_actionProvider( identifier: Option<&ProtocolObject<dyn NSCopying>>, preview_provider: UIContextMenuContentPreviewProvider, action_provider: UIContextMenuActionProvider, mtm: MainThreadMarker, ) -> Retained<Self>

For a concrete configuration, use the parent UIContextMenuConfiguration class instead.

§Safety

identifier should be of the correct type.
preview_provider must be a valid pointer or null.
action_provider must be a valid pointer or null.

Source §

impl BEContextMenuConfiguration

Methods declared on superclass NSObject.

Source

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

Methods from Deref<Target = UIContextMenuConfiguration>§

Source

pub fn identifier(&self) -> Retained<ProtocolObject<dyn NSCopying>>

This configuration’s identifier. When representing multiple items in your app, this identifier corresponds to the primary item (i.e. the one with which the user interacted when invoking the menu).

Source

pub fn secondaryItemIdentifiers( &self, ) -> Retained<NSSet<ProtocolObject<dyn NSCopying>>>

When this menu acts on multiple items, you may include the identifiers of secondary items to display a multi-item menu.

Source

pub unsafe fn setSecondaryItemIdentifiers( &self, secondary_item_identifiers: &NSSet<ProtocolObject<dyn NSCopying>>, )

Setter for secondaryItemIdentifiers.

This is copied when set.

§Safety

secondary_item_identifiers generic should be of the correct type.

Source

pub fn badgeCount(&self) -> isize

Number of items on which this menu acts. Used to badge a multi-item menu’s preview stack. When unset, this value is determined automatically by the system. Values lower than 2 hide the badge.

Source

pub fn setBadgeCount(&self, badge_count: isize)

Setter for badgeCount.

Source

pub fn preferredMenuElementOrder( &self, ) -> UIContextMenuConfigurationElementOrder

Preferred menu element ordering strategy for this menu.

Source

pub fn setPreferredMenuElementOrder( &self, preferred_menu_element_order: UIContextMenuConfigurationElementOrder, )

Setter for preferredMenuElementOrder.

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

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.

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,

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