Struct UIAction

Source

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

Available on crate features UIAction and UIMenuElement only.

Expand description

Apple’s documentation

Implementations§

Source §

impl UIAction

Source

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

Short display title.

Source

pub unsafe fn setTitle(&self, title: &NSString)

Setter for title.

Source

pub unsafe fn image(&self) -> Option<Retained<UIImage>>

Available on crate feature UIImage only.

Image that can appear next to this action.

Source

pub unsafe fn setImage(&self, image: Option<&UIImage>)

Available on crate feature UIImage only.

Setter for image.

Source

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

Elaborated title used in keyboard shortcut overlay.

Source

pub unsafe fn setDiscoverabilityTitle( &self, discoverability_title: Option<&NSString>, )

Setter for discoverabilityTitle.

Source

pub unsafe fn identifier(&self) -> Retained<UIActionIdentifier>

This action’s identifier.

Source

pub unsafe fn attributes(&self) -> UIMenuElementAttributes

This action’s style.

Source

pub unsafe fn setAttributes(&self, attributes: UIMenuElementAttributes)

Setter for attributes.

Source

pub unsafe fn state(&self) -> UIMenuElementState

State that can appear next to this action.

Source

pub unsafe fn setState(&self, state: UIMenuElementState)

Setter for state.

Source

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

If available, the object on behalf of which the actionHandler is called.

Source

pub unsafe fn actionWithHandler( handler: UIActionHandler, mtm: MainThreadMarker, ) -> Retained<Self>

Available on crate feature block2 only.

Creates a UIAction with an empty title, nil image, and automatically generated identifier

Parameter handler: Handler block. Called when the user selects the action.

Returns: A new UIAction.

Source

pub unsafe fn actionWithTitle_image_identifier_handler( title: &NSString, image: Option<&UIImage>, identifier: Option<&UIActionIdentifier>, handler: UIActionHandler, mtm: MainThreadMarker, ) -> Retained<Self>

Available on crate features UIImage and block2 only.

Creates a UIAction with the given arguments.

Parameter title: The action’s title.

Parameter image: Image that can appear next to this action, if needed.

Parameter identifier: The action’s identifier. Pass nil to use an auto-generated identifier.

Parameter handler: Handler block. Called when the user selects the action.

Returns: A new UIAction.

Source

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

Source

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

Source §

impl UIAction

Methods declared on superclass UIMenuElement.

Source

pub unsafe fn initWithCoder( this: Allocated<Self>, coder: &NSCoder, ) -> Option<Retained<Self>>

Source §

impl UIAction

UICaptureTextFromCameraSupporting.

Source

pub unsafe fn captureTextFromCameraActionForResponder_identifier( responder: &UIResponder, identifier: Option<&UIActionIdentifier>, ) -> Retained<Self>

Available on crate features UIResponder and UITextInput and UITextInputTraits only.

Creates a new UIAction for the captureTextFromCamera: standard edit action.

Parameter responder: The UIKeyInput responder to send captureTextFromCamera: to.

Parameter identifier: The action’s identifier. Pass nil to use an auto-generated identifier.

Returns: A new UIAction.

Methods from Deref<Target = UIMenuElement>§

Source

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

The element’s title.

Source

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

The element’s subtitle.

Source

pub unsafe fn setSubtitle(&self, subtitle: Option<&NSString>)

Setter for subtitle.

Source

pub unsafe fn image(&self) -> Option<Retained<UIImage>>

Available on crate feature UIImage only.

Image to be displayed alongside the element’s title.

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

Trait Implementations§

Source §