#[repr(C)]pub struct NSAccessibilityCustomRotorSearchParameters { /* private fields */ }
NSAccessibilityCustomRotor
only.Expand description
NSAccessibilityCustomRotorSearchParameters is a container for search parameters. It should be examined to determine the next matching NSAccessibilityCustomRotorItemResult.
See also Apple’s documentation
Implementations§
Source§impl NSAccessibilityCustomRotorSearchParameters
impl NSAccessibilityCustomRotorSearchParameters
Sourcepub unsafe fn currentItem(
&self,
) -> Option<Retained<NSAccessibilityCustomRotorItemResult>>
pub unsafe fn currentItem( &self, ) -> Option<Retained<NSAccessibilityCustomRotorItemResult>>
The currentItem determines where the search will start from. If it is nil, the search should begin from, and include, the first or last item, depending on which search direction is used (e.g. search direction next will return the first item and previous will return the last item).
Sourcepub unsafe fn setCurrentItem(
&self,
current_item: Option<&NSAccessibilityCustomRotorItemResult>,
)
pub unsafe fn setCurrentItem( &self, current_item: Option<&NSAccessibilityCustomRotorItemResult>, )
Setter for currentItem
.
Sourcepub unsafe fn searchDirection(
&self,
) -> NSAccessibilityCustomRotorSearchDirection
pub unsafe fn searchDirection( &self, ) -> NSAccessibilityCustomRotorSearchDirection
Either NSAccessibilityCustomRotorSearchDirectionPrevious or NSAccessibilityCustomRotorSearchDirectionNext.
Sourcepub unsafe fn setSearchDirection(
&self,
search_direction: NSAccessibilityCustomRotorSearchDirection,
)
pub unsafe fn setSearchDirection( &self, search_direction: NSAccessibilityCustomRotorSearchDirection, )
Setter for searchDirection
.
Sourcepub unsafe fn filterString(&self) -> Retained<NSString>
pub unsafe fn filterString(&self) -> Retained<NSString>
A string of text to filter the results against. This is used to get type-ahead results. For example, given a list of primary colors and filter text “Re”, color item “Red” would be returned as a result.
Sourcepub unsafe fn setFilterString(&self, filter_string: &NSString)
pub unsafe fn setFilterString(&self, filter_string: &NSString)
Setter for filterString
.
Methods from Deref<Target = NSObject>§
Sourcepub fn doesNotRecognizeSelector(&self, sel: Sel) -> !
pub fn doesNotRecognizeSelector(&self, sel: Sel) -> !
Handle messages the object doesn’t recognize.
See Apple’s documentation for details.
Methods from Deref<Target = AnyObject>§
Sourcepub fn class(&self) -> &'static AnyClass
Available on crate feature NSAccessibilityConstants
only.
pub fn class(&self) -> &'static AnyClass
NSAccessibilityConstants
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());
Sourcepub unsafe fn get_ivar<T>(&self, name: &str) -> &Twhere
T: Encode,
👎Deprecated: this is difficult to use correctly, use Ivar::load
instead.Available on crate feature NSAccessibilityConstants
only.
pub unsafe fn get_ivar<T>(&self, name: &str) -> &Twhere
T: Encode,
Ivar::load
instead.NSAccessibilityConstants
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.
Sourcepub fn downcast_ref<T>(&self) -> Option<&T>where
T: DowncastTarget,
Available on crate feature NSAccessibilityConstants
only.
pub fn downcast_ref<T>(&self) -> Option<&T>where
T: DowncastTarget,
NSAccessibilityConstants
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§
Source§impl AsRef<NSAccessibilityCustomRotorSearchParameters> for NSAccessibilityCustomRotorSearchParameters
impl AsRef<NSAccessibilityCustomRotorSearchParameters> for NSAccessibilityCustomRotorSearchParameters
Source§impl ClassType for NSAccessibilityCustomRotorSearchParameters
impl ClassType for NSAccessibilityCustomRotorSearchParameters
Source§const NAME: &'static str = "NSAccessibilityCustomRotorSearchParameters"
const NAME: &'static str = "NSAccessibilityCustomRotorSearchParameters"
Source§type ThreadKind = <<NSAccessibilityCustomRotorSearchParameters as ClassType>::Super as ClassType>::ThreadKind
type ThreadKind = <<NSAccessibilityCustomRotorSearchParameters as ClassType>::Super as ClassType>::ThreadKind
Source§impl NSObjectProtocol for NSAccessibilityCustomRotorSearchParameters
impl NSObjectProtocol for NSAccessibilityCustomRotorSearchParameters
Source§fn isEqual(&self, other: Option<&AnyObject>) -> bool
fn isEqual(&self, other: Option<&AnyObject>) -> bool
Source§fn hash(&self) -> usize
fn hash(&self) -> usize
Source§fn isKindOfClass(&self, cls: &AnyClass) -> bool
fn isKindOfClass(&self, cls: &AnyClass) -> bool
Source§fn is_kind_of<T>(&self) -> bool
fn is_kind_of<T>(&self) -> bool
isKindOfClass
directly, or cast your objects with AnyObject::downcast_ref