Struct UIFindSession

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

Available on crate feature UIFindSession only.

An abstract base class for managing a find session.

A UIFindSession instance is returned by UIFindInteractionDelegate when a find session is initiated by the user. You can choose to implement a subclass of UIFindSession to handle all state, decoration, and behavior yourself. This would be the preferred choice if the view your find interaction is attached to is very custom in the way it handles the presentation of found results. Other clients are encouraged to instead use UISearchableObjectFindSession and the UITextSearching protocol, which manages the state of a find session automatically using behavior consistent with the rest of the system.

See also Apple’s documentation

Implementations

impl UIFindSession

pub unsafe fn resultCount(&self) -> NSInteger

Returns the total number of results. You may call UIFindInteraction’s updateResultCountto update the system find panel’s UI if already visible.

pub unsafe fn highlightedResultIndex(&self) -> NSInteger

Returns the index of the currently highlighted result, out of resultCount.If no result is currently highlighted, return NSNotFound. You may call UIFindInteraction’s updateResultCountto update the system find panel’s UI if already visible.

pub unsafe fn searchResultDisplayStyle( &self, ) -> UIFindSessionSearchResultDisplayStyle

Defines how results are reported through the find panel’s UI. The default style is CurrentAndTotal.

pub unsafe fn setSearchResultDisplayStyle( &self, search_result_display_style: UIFindSessionSearchResultDisplayStyle, )

Setter for searchResultDisplayStyle.

pub unsafe fn supportsReplacement(&self) -> bool

Return YES if replacement is supported. This gates the appearance of replace UI in the find navigator panel. Default is NO.

pub unsafe fn allowsReplacementForCurrentlyHighlightedResult(&self) -> bool

Return YES if replacement is allowed for the currently highlighted item. This property controls the enabled state of the “replace” button in the find navigator, as well as various hardware keyboard shortcuts involving replacement. Default is YES, if supportsReplacement is YES.

pub unsafe fn performSearchWithQuery_options( &self, query: &NSString, options: Option<&UITextSearchOptions>, )

Called when the user requests a search to be performed for query,using options.

Parameter query: The search string entered into the search text field in the system find panel.

Parameter options: Object representing all configured search options for this search.

pub unsafe fn performSingleReplacementWithSearchQuery_replacementString_options( &self, search_query: &NSString, replacement_string: &NSString, options: Option<&UITextSearchOptions>, )

Called when the user requests a single replacement to occur given searchQueryand replacementString.

Parameter searchQuery: The search string entered into the search text field in the system find panel.

Parameter replacementString: The replacement string entered into the replace text field in the system find panel.

Parameter options: Object representing all configured search options for this replacement.

pub unsafe fn replaceAllInstancesOfSearchQuery_withReplacementString_options( &self, search_query: &NSString, replacement_string: &NSString, options: Option<&UITextSearchOptions>, )

Called when the user requests a document-wide replacement to occur.

Parameter searchQuery: The search string entered into the search text field in the system find panel.

Parameter replacementString: The replacement string entered into the replace text field in the system find panel.

Parameter options: Object representing all configured search options for this replacement.

pub unsafe fn highlightNextResultInDirection( &self, direction: UITextStorageDirection, )

Available on crate feature UITextInput only.

Called when either the next or previous button is activated, or when return or shift+return is pressed in the search field.

Parameter direction: Which direction the user intends to move, either forward or backward.

pub unsafe fn invalidateFoundResults(&self)

This method will be called whenever the current find session’s found/highlighted results are to be invalidated. For instance, when the search query is cleared, options changed, or any other event where we may not perform another search right away.

pub unsafe fn allowsReplacement(&self) -> bool

👎Deprecated

impl UIFindSession

Methods declared on superclass NSObject.

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

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

Methods from Deref<Target = NSObject>

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

Handle messages the object doesn’t recognize.

See Apple’s documentation for details.

Methods from Deref<Target = AnyObject>

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

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.

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

Trait Implementations

impl AsRef<AnyObject> for UIFindSession

fn as_ref(&self) -> &AnyObject

Converts this type into a shared reference of the (usually inferred) input type.

impl AsRef<NSObject> for UIFindSession

fn as_ref(&self) -> &NSObject

Converts this type into a shared reference of the (usually inferred) input type.

impl AsRef<UIFindSession> for UIFindSession

fn as_ref(&self) -> &Self

Converts this type into a shared reference of the (usually inferred) input type.

impl AsRef<UIFindSession> for UITextSearchingFindSession

fn as_ref(&self) -> &UIFindSession

Converts this type into a shared reference of the (usually inferred) input type.

impl Borrow<AnyObject> for UIFindSession

fn borrow(&self) -> &AnyObject

Immutably borrows from an owned value.

impl Borrow<NSObject> for UIFindSession

fn borrow(&self) -> &NSObject

Immutably borrows from an owned value.

impl Borrow<UIFindSession> for UITextSearchingFindSession

fn borrow(&self) -> &UIFindSession

Immutably borrows from an owned value.

impl ClassType for UIFindSession

const NAME: &'static str = "UIFindSession"

The name of the Objective-C class that this type represents.

type Super = NSObject

The superclass of this class.

type ThreadKind = dyn MainThreadOnly

Whether the type can be used from any thread, or from only the main thread.

fn class() -> &'static AnyClass

Get a reference to the Objective-C class that this type represents.

fn as_super(&self) -> &Self::Super

Get an immutable reference to the superclass.

impl Debug for UIFindSession

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Deref for UIFindSession

type Target = NSObject

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl Hash for UIFindSession

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Message for UIFindSession

fn retain(&self) -> Retained<Self>

where Self: Sized,

Increment the reference count of the receiver.

impl NSObjectProtocol for UIFindSession

fn isEqual(&self, other: Option<&AnyObject>) -> bool

where Self: Sized + Message,

Check whether the object is equal to an arbitrary other object.

fn hash(&self) -> usize

where Self: Sized + Message,

An integer that can be used as a table address in a hash table structure.

fn isKindOfClass(&self, cls: &AnyClass) -> bool

where Self: Sized + Message,

Check if the object is an instance of the class, or one of its subclasses.

fn is_kind_of<T>(&self) -> bool

where T: ClassType, Self: Sized + Message,

👎Deprecated: use isKindOfClass directly, or cast your objects with AnyObject::downcast_ref

Check if the object is an instance of the class type, or one of its subclasses.

fn isMemberOfClass(&self, cls: &AnyClass) -> bool

where Self: Sized + Message,

Check if the object is an instance of a specific class, without checking subclasses.

fn respondsToSelector(&self, aSelector: Sel) -> bool

where Self: Sized + Message,

Check whether the object implements or inherits a method with the given selector.

fn conformsToProtocol(&self, aProtocol: &AnyProtocol) -> bool

where Self: Sized + Message,

Check whether the object conforms to a given protocol.

fn description(&self) -> Retained<NSObject>

where Self: Sized + Message,

A textual representation of the object.

fn debugDescription(&self) -> Retained<NSObject>

where Self: Sized + Message,

A textual representation of the object to use when debugging.

fn isProxy(&self) -> bool

where Self: Sized + Message,

Check whether the receiver is a subclass of the NSProxy root class instead of the usual NSObject.

fn retainCount(&self) -> usize

where Self: Sized + Message,

The reference count of the object.

impl PartialEq for UIFindSession

fn eq(&self, other: &Self) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl RefEncode for UIFindSession

const ENCODING_REF: Encoding = <NSObject as ::objc2::RefEncode>::ENCODING_REF

The Objective-C type-encoding for a reference of this type.

impl DowncastTarget for UIFindSession

impl Eq for UIFindSession