Struct UIAccessibilityElement

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

Available on crate features UIAccessibilityElement and UIResponder only.

Apple’s documentation

Implementations

impl UIAccessibilityElement

pub unsafe fn initWithAccessibilityContainer( this: Allocated<Self>, container: &AnyObject, ) -> Retained<Self>

pub unsafe fn accessibilityContainer(&self) -> Option<Retained<AnyObject>>

pub unsafe fn setAccessibilityContainer( &self, accessibility_container: Option<&AnyObject>, )

This is a weak property. Setter for accessibilityContainer.

pub unsafe fn isAccessibilityElement(&self) -> bool

pub unsafe fn setIsAccessibilityElement(&self, is_accessibility_element: bool)

Setter for isAccessibilityElement.

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

pub unsafe fn setAccessibilityLabel( &self, accessibility_label: Option<&NSString>, )

Setter for accessibilityLabel.

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

pub unsafe fn setAccessibilityHint(&self, accessibility_hint: Option<&NSString>)

Setter for accessibilityHint.

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

pub unsafe fn setAccessibilityValue( &self, accessibility_value: Option<&NSString>, )

Setter for accessibilityValue.

pub unsafe fn accessibilityFrame(&self) -> CGRect

Available on crate feature objc2-core-foundation only.

pub unsafe fn setAccessibilityFrame(&self, accessibility_frame: CGRect)

Available on crate feature objc2-core-foundation only.

Setter for accessibilityFrame.

pub unsafe fn accessibilityTraits(&self) -> UIAccessibilityTraits

Available on crate feature UIAccessibilityConstants only.

pub unsafe fn setAccessibilityTraits( &self, accessibility_traits: UIAccessibilityTraits, )

Available on crate feature UIAccessibilityConstants only.

Setter for accessibilityTraits.

pub unsafe fn accessibilityFrameInContainerSpace(&self) -> CGRect

Available on crate feature objc2-core-foundation only.

pub unsafe fn setAccessibilityFrameInContainerSpace( &self, accessibility_frame_in_container_space: CGRect, )

Available on crate feature objc2-core-foundation only.

Setter for accessibilityFrameInContainerSpace.

impl UIAccessibilityElement

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 = UIResponder>

pub unsafe fn nextResponder(&self) -> Option<Retained<UIResponder>>

pub unsafe fn canBecomeFirstResponder(&self) -> bool

pub unsafe fn becomeFirstResponder(&self) -> bool

pub unsafe fn canResignFirstResponder(&self) -> bool

pub unsafe fn resignFirstResponder(&self) -> bool

pub unsafe fn isFirstResponder(&self) -> bool

pub unsafe fn touchesBegan_withEvent( &self, touches: &NSSet<UITouch>, event: Option<&UIEvent>, )

Available on crate features UIEvent and UITouch only.

pub unsafe fn touchesMoved_withEvent( &self, touches: &NSSet<UITouch>, event: Option<&UIEvent>, )

Available on crate features UIEvent and UITouch only.

pub unsafe fn touchesEnded_withEvent( &self, touches: &NSSet<UITouch>, event: Option<&UIEvent>, )

Available on crate features UIEvent and UITouch only.

pub unsafe fn touchesCancelled_withEvent( &self, touches: &NSSet<UITouch>, event: Option<&UIEvent>, )

Available on crate features UIEvent and UITouch only.

pub unsafe fn touchesEstimatedPropertiesUpdated(&self, touches: &NSSet<UITouch>)

Available on crate feature UITouch only.

pub unsafe fn pressesBegan_withEvent( &self, presses: &NSSet<UIPress>, event: Option<&UIPressesEvent>, )

Available on crate features UIEvent and UIPress and UIPressesEvent only.

pub unsafe fn pressesChanged_withEvent( &self, presses: &NSSet<UIPress>, event: Option<&UIPressesEvent>, )

Available on crate features UIEvent and UIPress and UIPressesEvent only.

pub unsafe fn pressesEnded_withEvent( &self, presses: &NSSet<UIPress>, event: Option<&UIPressesEvent>, )

Available on crate features UIEvent and UIPress and UIPressesEvent only.

pub unsafe fn pressesCancelled_withEvent( &self, presses: &NSSet<UIPress>, event: Option<&UIPressesEvent>, )

Available on crate features UIEvent and UIPress and UIPressesEvent only.

pub unsafe fn motionBegan_withEvent( &self, motion: UIEventSubtype, event: Option<&UIEvent>, )

Available on crate feature UIEvent only.

pub unsafe fn motionEnded_withEvent( &self, motion: UIEventSubtype, event: Option<&UIEvent>, )

Available on crate feature UIEvent only.

pub unsafe fn motionCancelled_withEvent( &self, motion: UIEventSubtype, event: Option<&UIEvent>, )

Available on crate feature UIEvent only.

pub unsafe fn remoteControlReceivedWithEvent(&self, event: Option<&UIEvent>)

Available on crate feature UIEvent only.

pub unsafe fn canPerformAction_withSender( &self, action: Sel, sender: Option<&AnyObject>, ) -> bool

pub unsafe fn targetForAction_withSender( &self, action: Sel, sender: Option<&AnyObject>, ) -> Option<Retained<AnyObject>>

pub unsafe fn buildMenuWithBuilder( &self, builder: &ProtocolObject<dyn UIMenuBuilder>, )

Available on crate feature UIMenuBuilder only.

pub unsafe fn validateCommand(&self, command: &UICommand)

Available on crate features UICommand and UIMenuElement only.

pub unsafe fn undoManager(&self) -> Option<Retained<NSUndoManager>>

pub unsafe fn editingInteractionConfiguration( &self, ) -> UIEditingInteractionConfiguration

pub unsafe fn keyCommands(&self) -> Option<Retained<NSArray<UIKeyCommand>>>

Available on crate features UICommand and UIKeyCommand and UIMenuElement only.

pub unsafe fn inputView(&self) -> Option<Retained<UIView>>

Available on crate feature UIView only.

pub unsafe fn inputAccessoryView(&self) -> Option<Retained<UIView>>

Available on crate feature UIView only.

pub unsafe fn inputAssistantItem(&self) -> Retained<UITextInputAssistantItem>

Available on crate feature UITextInput only.

This method is for clients that wish to put buttons on the Shortcuts Bar, shown on top of the keyboard. You may modify the returned inputAssistantItem to add to or replace the existing items on the bar. Modifications made to the returned UITextInputAssistantItem are reflected automatically. This method should not be overridden. Goes up the responder chain.

pub unsafe fn inputViewController( &self, ) -> Option<Retained<UIInputViewController>>

Available on crate features UIInputViewController and UIViewController only.

pub unsafe fn inputAccessoryViewController( &self, ) -> Option<Retained<UIInputViewController>>

Available on crate features UIInputViewController and UIViewController only.

pub unsafe fn textInputMode(&self) -> Option<Retained<UITextInputMode>>

Available on crate feature UITextInput only.

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

pub unsafe fn reloadInputViews(&self)

pub unsafe fn userActivity(&self) -> Option<Retained<NSUserActivity>>

pub unsafe fn setUserActivity(&self, user_activity: Option<&NSUserActivity>)

Setter for userActivity.

pub unsafe fn updateUserActivityState(&self, activity: &NSUserActivity)

pub unsafe fn restoreUserActivityState(&self, activity: &NSUserActivity)

pub unsafe fn captureTextFromCamera(&self, sender: Option<&AnyObject>)

pub unsafe fn activityItemsConfiguration( &self, ) -> Option<Retained<ProtocolObject<dyn UIActivityItemsConfigurationReading>>>

Available on crate features UIResponder_UIActivityItemsConfiguration and UIActivityItemsConfigurationReading only.

pub unsafe fn setActivityItemsConfiguration( &self, activity_items_configuration: Option<&ProtocolObject<dyn UIActivityItemsConfigurationReading>>, )

Available on crate features UIResponder_UIActivityItemsConfiguration and UIActivityItemsConfigurationReading only.

Setter for activityItemsConfiguration.

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 UIAccessibilityElement

fn as_ref(&self) -> &AnyObject

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

impl AsRef<NSObject> for UIAccessibilityElement

fn as_ref(&self) -> &NSObject

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

impl AsRef<UIAccessibilityElement> for UIAccessibilityElement

fn as_ref(&self) -> &Self

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

impl AsRef<UIResponder> for UIAccessibilityElement

fn as_ref(&self) -> &UIResponder

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

impl Borrow<AnyObject> for UIAccessibilityElement

fn borrow(&self) -> &AnyObject

Immutably borrows from an owned value.

impl Borrow<NSObject> for UIAccessibilityElement

fn borrow(&self) -> &NSObject

Immutably borrows from an owned value.

impl Borrow<UIResponder> for UIAccessibilityElement

fn borrow(&self) -> &UIResponder

Immutably borrows from an owned value.

impl ClassType for UIAccessibilityElement

const NAME: &'static str = "UIAccessibilityElement"

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

type Super = UIResponder

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 UIAccessibilityElement

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

Formats the value using the given formatter.

impl Deref for UIAccessibilityElement

type Target = UIResponder

The resulting type after dereferencing.

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

Dereferences the value.

impl Hash for UIAccessibilityElement

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 UIAccessibilityElement

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

where Self: Sized,

Increment the reference count of the receiver.

impl NSObjectProtocol for UIAccessibilityElement

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 UIAccessibilityElement

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 UIAccessibilityElement

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

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

impl UIAccessibilityIdentification for UIAccessibilityElement

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

where Self: Sized + Message,

Available on crate feature UIAccessibilityIdentification only.

unsafe fn setAccessibilityIdentifier( &self, accessibility_identifier: Option<&NSString>, )

where Self: Sized + Message,

Available on crate feature UIAccessibilityIdentification only.

Setter for accessibilityIdentifier.

impl UIResponderStandardEditActions for UIAccessibilityElement

unsafe fn cut(&self, sender: Option<&AnyObject>)

where Self: Sized + Message,

Available on crate feature UIResponder only.

unsafe fn copy(&self, sender: Option<&AnyObject>)

where Self: Sized + Message,

Available on crate feature UIResponder only.

unsafe fn paste(&self, sender: Option<&AnyObject>)

where Self: Sized + Message,

Available on crate feature UIResponder only.

unsafe fn pasteAndMatchStyle(&self, sender: Option<&AnyObject>)

where Self: Sized + Message,

Available on crate feature UIResponder only.

unsafe fn pasteAndGo(&self, sender: Option<&AnyObject>)

where Self: Sized + Message,

Available on crate feature UIResponder only.

unsafe fn pasteAndSearch(&self, sender: Option<&AnyObject>)

where Self: Sized + Message,

Available on crate feature UIResponder only.

unsafe fn select(&self, sender: Option<&AnyObject>)

where Self: Sized + Message,

Available on crate feature UIResponder only.

unsafe fn selectAll(&self, sender: Option<&AnyObject>)

where Self: Sized + Message,

Available on crate feature UIResponder only.

unsafe fn delete(&self, sender: Option<&AnyObject>)

where Self: Sized + Message,

Available on crate feature UIResponder only.

unsafe fn makeTextWritingDirectionLeftToRight(&self, sender: Option<&AnyObject>)

where Self: Sized + Message,

Available on crate feature UIResponder only.

unsafe fn makeTextWritingDirectionRightToLeft(&self, sender: Option<&AnyObject>)

where Self: Sized + Message,

Available on crate feature UIResponder only.

unsafe fn toggleBoldface(&self, sender: Option<&AnyObject>)

where Self: Sized + Message,

Available on crate feature UIResponder only.

unsafe fn toggleItalics(&self, sender: Option<&AnyObject>)

where Self: Sized + Message,

Available on crate feature UIResponder only.

unsafe fn toggleUnderline(&self, sender: Option<&AnyObject>)

where Self: Sized + Message,

Available on crate feature UIResponder only.

unsafe fn increaseSize(&self, sender: Option<&AnyObject>)

where Self: Sized + Message,

Available on crate feature UIResponder only.

unsafe fn decreaseSize(&self, sender: Option<&AnyObject>)

where Self: Sized + Message,

Available on crate feature UIResponder only.

unsafe fn find(&self, sender: Option<&AnyObject>)

where Self: Sized + Message,

Available on crate feature UIResponder only.

unsafe fn findAndReplace(&self, sender: Option<&AnyObject>)

where Self: Sized + Message,

Available on crate feature UIResponder only.

unsafe fn findNext(&self, sender: Option<&AnyObject>)

where Self: Sized + Message,

Available on crate feature UIResponder only.

unsafe fn findPrevious(&self, sender: Option<&AnyObject>)

where Self: Sized + Message,

Available on crate feature UIResponder only.

unsafe fn useSelectionForFind(&self, sender: Option<&AnyObject>)

where Self: Sized + Message,

Available on crate feature UIResponder only.

unsafe fn updateTextAttributesWithConversionHandler( &self, conversion_handler: UITextAttributesConversionHandler, )

where Self: Sized + Message,

Available on crate features UIResponder and block2 only.

unsafe fn print(&self, sender: Option<&AnyObject>)

where Self: Sized + Message,

Available on crate feature UIResponder only.

unsafe fn rename(&self, sender: Option<&AnyObject>)

where Self: Sized + Message,

Available on crate feature UIResponder only.

unsafe fn duplicate(&self, sender: Option<&AnyObject>)

where Self: Sized + Message,

Available on crate feature UIResponder only.

unsafe fn move(&self, sender: Option<&AnyObject>)

where Self: Sized + Message,

Available on crate feature UIResponder only.

unsafe fn export(&self, sender: Option<&AnyObject>)

where Self: Sized + Message,

Available on crate feature UIResponder only.

unsafe fn showWritingTools(&self, sender: &AnyObject)

where Self: Sized + Message,

Available on crate feature UIResponder only.

impl DowncastTarget for UIAccessibilityElement

impl Eq for UIAccessibilityElement