Struct NSAccessibilityCustomRotor

Source

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

Available on crate feature NSAccessibilityCustomRotor only.

Expand description

NSAccessibilityCustomRotors allow assistive technologies, like VoiceOver, to search applications for content related to the given label.

Implementations§

Source §

impl NSAccessibilityCustomRotor

Source

pub unsafe fn initWithLabel_itemSearchDelegate( this: Allocated<Self>, label: &NSString, item_search_delegate: &ProtocolObject<dyn NSAccessibilityCustomRotorItemSearchDelegate>, ) -> Retained<Self>

Convenience initializer that uses NSAccessibilityCustomRotorTypeCustom as the default rotor type. Use this initializer for custom rotors that are not one of the common types.

Source

pub unsafe fn initWithRotorType_itemSearchDelegate( this: Allocated<Self>, rotor_type: NSAccessibilityCustomRotorType, item_search_delegate: &ProtocolObject<dyn NSAccessibilityCustomRotorItemSearchDelegate>, ) -> Retained<Self>

Convenience initializer for custom rotors that use a common type such as links, headings, etc. A default label will be provided.

Source

pub unsafe fn type(&self) -> NSAccessibilityCustomRotorType

The rotor type to provide results for.

The default type is NSAccessibilityCustomRotorTypeCustom, unless the rotor type was specified in the initializer.

Source

pub unsafe fn setType(&self, type: NSAccessibilityCustomRotorType)

Setter for type.

Source

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

The localized label assistive technologies will use to describe the custom rotor.

The label is only used when the rotor type is NSAccessibilityCustomRotorTypeCustom since a default is provided for all other types.

Source

pub unsafe fn setLabel(&self, label: &NSString)

Setter for label.

Source

pub unsafe fn itemSearchDelegate( &self, ) -> Option<Retained<ProtocolObject<dyn NSAccessibilityCustomRotorItemSearchDelegate>>>

The itemSearchDelegate will be asked to find the next item result after performing a search with the given search parameters.

Source

pub unsafe fn setItemSearchDelegate( &self, item_search_delegate: Option<&ProtocolObject<dyn NSAccessibilityCustomRotorItemSearchDelegate>>, )

This is a weak property. Setter for itemSearchDelegate.

Source

pub unsafe fn itemLoadingDelegate( &self, ) -> Option<Retained<ProtocolObject<dyn NSAccessibilityElementLoading>>>

Available on crate feature NSAccessibilityProtocols only.

Provide an item load delegate if the rotor vends item results that do not have a backing UI element yet. The loader will be asked to load an element via the accessibilityElementWithToken protocol method when the item result is selected by an assistive client. Applications can use the item result’s token to determine which item to return.

Source

pub unsafe fn setItemLoadingDelegate( &self, item_loading_delegate: Option<&ProtocolObject<dyn NSAccessibilityElementLoading>>, )

Available on crate feature NSAccessibilityProtocols only.

This is a weak property. Setter for itemLoadingDelegate.

Source §

impl NSAccessibilityCustomRotor

Methods declared on superclass NSObject.

Source

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

Source

pub unsafe fn new() -> 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 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());

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 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.

Source

pub fn downcast_ref<T>(&self) -> Option<&T>
where T: DowncastTarget,

Available on crate feature 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`
    }
}