Struct UIFindInteraction

Source

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

Available on crate feature UIFindInteraction only.

Expand description

Apple’s documentation

Implementations§

Source §

impl UIFindInteraction

Source

pub unsafe fn isFindNavigatorVisible(&self) -> bool

Returns YES if the find navigator panel is currently visible.

Source

pub unsafe fn activeFindSession(&self) -> Option<Retained<UIFindSession>>

Available on crate feature UIFindSession only.

If there’s a currently active find session (implying isFindNavigatorVisible is true), returns the active find session.

Source

pub unsafe fn searchText(&self) -> Option<Retained<NSString>>

Assign this property to pre-populate the system find panel’s search text field with a search query.

Source

pub unsafe fn setSearchText(&self, search_text: Option<&NSString>)

Setter for searchText.

Source

pub unsafe fn replacementText(&self) -> Option<Retained<NSString>>

If replacement is supported, assign this property to pre-populate the system find panel’s replace text field with a replacement string.

Source

pub unsafe fn setReplacementText(&self, replacement_text: Option<&NSString>)

Setter for replacementText.

Source

pub unsafe fn optionsMenuProvider( &self, ) -> mut DynBlock<dyn Fn(NonNull<NSArray<UIMenuElement>>) -> mut UIMenu>

Available on crate features UIMenu and UIMenuElement and block2 only.

This provider is consulted when the search options menu is being populated. A default set of search options is provided, representing the options available in UITextSearchOptions,which can be either modified, augmented, or omitted.

Source

pub unsafe fn setOptionsMenuProvider( &self, options_menu_provider: Option<&DynBlock<dyn Fn(NonNull<NSArray<UIMenuElement>>) -> *mut UIMenu>>, )

Available on crate features UIMenu and UIMenuElement and block2 only.

Setter for optionsMenuProvider.

Source

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

See UIFindInteractionDelegate above.

Source

pub unsafe fn initWithSessionDelegate( this: Allocated<Self>, session_delegate: &ProtocolObject<dyn UIFindInteractionDelegate>, ) -> Retained<Self>

Creates a find interaction object with the specified delegate.

Source

pub unsafe fn presentFindNavigatorShowingReplace(&self, showing_replace: bool)

Shows the find navigator panel, if not already visible.

Parameter replaceVisible: If the delegate supports text replacement, will make the replace text field visible on first appearance.

Source

pub unsafe fn dismissFindNavigator(&self)

Dismisses the find navigator panel.

Source

pub unsafe fn findNext(&self)

Jump to the next found result in the document, relative to the currently highlighted result.

Source

pub unsafe fn findPrevious(&self)

Jump to the previous found result in the document, relative to the currently highlighted result.

Source

pub unsafe fn updateResultCount(&self)

Calling this triggers an update of the UI to reflect changes to the currently shown result count or result index, as defined by UIFindSession.

Source

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

Source

pub unsafe fn init(this: Allocated<Self>) -> 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`
    }
}