Struct BETextInteraction

Source

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

Available on crate feature BETextInteraction only.

Expand description

Apple’s documentation

Implementations§

Source §

impl BETextInteraction

Source

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

Available on crate feature BETextInteractionDelegate only.

Assign a delegate to this object to receive callback information

Source

pub unsafe fn setDelegate( &self, delegate: Option<&ProtocolObject<dyn BETextInteractionDelegate>>, )

Available on crate feature BETextInteractionDelegate only.

This is a weak property. Setter for delegate.

Source

pub unsafe fn addShortcutForText_fromRect( &self, text: &NSString, presentation_rect: CGRect, )

Available on crate feature objc2-core-foundation only.

Presents a sheet to add a text replacement shortcut to the keyboard dictionary

Generally used for IME languages, such as Chinese/Japanese

Source

pub unsafe fn shareText_fromRect( &self, text: &NSString, presentation_rect: CGRect, )

Available on crate feature objc2-core-foundation only.

Presents a share sheet for the text positioned relative to the presentationRect

Source

pub unsafe fn showDictionaryForTextInContext_definingTextInRange_fromRect( &self, text_with_context: &NSString, range: NSRange, presentation_rect: CGRect, )

Available on crate feature objc2-core-foundation only.

Presents a dictionary definition view for the textWithContext positioned relative to the presentationRect

Source

pub unsafe fn translateText_fromRect( &self, text: &NSString, presentation_rect: CGRect, )

Available on crate feature objc2-core-foundation only.

Presents a translation view for the text positioned relative to the presentationRect

Source

pub unsafe fn showReplacementsForText(&self, text: &NSString)

Displays the inline text replacement UI for the current selection. For example, inline text replacements are displayed in response to the “Replace…” option in the edit menu.

Could be invoked when handling promptForReplace: action

Source

pub unsafe fn transliterateChineseForText(&self, text: &NSString)

Converts the text selection between traditional and simplified Chinese

Could be invoked when handling transliterateChinese action

Source

pub unsafe fn presentEditMenuForSelection(&self)

Presents an edit menu for the current text selection

Source

pub unsafe fn dismissEditMenuForSelection(&self)

Dismisses an edit menu for the current text selection

Source

pub unsafe fn editabilityChanged(&self)

Tells the system that the document’s editability status has changed.

In response, the system refreshes the text interaction gestures, depending on the value of isEditable

Source

pub unsafe fn refreshKeyboardUI(&self)

Tells the system to refresh the keyboard UI.

This lightweight method refreshes the selection UI. For example, this could be invoked in response to programmatic text selection changes, independent of text interaction gestures

Source

pub unsafe fn selectionChangedWithGestureAtPoint_gesture_state_flags( &self, point: CGPoint, gesture_type: BEGestureType, gesture_state: UIGestureRecognizerState, flags: BESelectionFlags, )

Available on crate features BETextSelectionTypes and objc2-core-foundation only.

Tells the system that the selection change has been handled for the given point and gesture.

Should be invoked in response to: -[BETextInput updateCurrentSelectionTo:fromGesture:inState:]

Source

pub unsafe fn selectionBoundaryAdjustedToPoint_touchPhase_flags( &self, point: CGPoint, touch: BESelectionTouchPhase, flags: BESelectionFlags, )

Available on crate features BETextSelectionTypes and objc2-core-foundation only.

Tells the system the selection adjustment has been handled for the given point and touch

Should be invoked in response to: -[BETextInput adjustSelectionBoundaryToPoint:touchPhase:baseIsStart:flags:]

Source

pub unsafe fn textSelectionDisplayInteraction( &self, ) -> Retained<UITextSelectionDisplayInteraction>

Returns a UITextSelectionDisplayInteraction that manages selection UI

Source

pub unsafe fn contextMenuInteractionDelegate( &self, ) -> Option<Retained<ProtocolObject<dyn UIContextMenuInteractionDelegate>>>

Set a delegate to receive callbacks for the context menu interaction

Source

pub unsafe fn setContextMenuInteractionDelegate( &self, context_menu_interaction_delegate: Option<&ProtocolObject<dyn UIContextMenuInteractionDelegate>>, )

This is a weak property. Setter for contextMenuInteractionDelegate.

Source

pub unsafe fn contextMenuInteraction( &self, ) -> Retained<UIContextMenuInteraction>

Returns a UIContextMenuInteraction object whose delegate methods will be invoked on contextMenuInteractionDelegate

Source §

impl BETextInteraction

Methods declared on superclass NSObject.

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

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