Struct UICommand

Source
#[repr(C)]
pub struct UICommand { /* private fields */ }
Available on crate features UICommand and UIMenuElement only.
Expand description

Represents an action to take.

See also Apple’s documentation

Implementations§

Source§

impl UICommand

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 command

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>, )

Source

pub unsafe fn action(&self) -> Sel

Action to take on choosing this command.

Source

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

Property list object to distinguish commands, if needed.

Source

pub unsafe fn attributes(&self) -> UIMenuElementAttributes

Command attributes.

Source

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

Setter for attributes.

Source

pub unsafe fn state(&self) -> UIMenuElementState

State that can appear next to the command.

Source

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

Setter for state.

Source

pub unsafe fn alternates(&self) -> Retained<NSArray<UICommandAlternate>>

Alternates that differ in modifier flags, if any.

Source

pub unsafe fn commandWithTitle_image_action_propertyList( title: &NSString, image: Option<&UIImage>, action: Sel, property_list: Option<&AnyObject>, mtm: MainThreadMarker, ) -> Retained<Self>

Available on crate feature UIImage only.

Initializes a keyless command.

Parameter title: Short display title. This should be localized.

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

Parameter action: Action to take on choosing this command.

Parameter propertyList: Property list object to distinguish commands, if needed.

Returns: A new keyless command.

Source

pub unsafe fn commandWithTitle_image_action_propertyList_alternates( title: &NSString, image: Option<&UIImage>, action: Sel, property_list: Option<&AnyObject>, alternates: &NSArray<UICommandAlternate>, mtm: MainThreadMarker, ) -> Retained<Self>

Available on crate feature UIImage only.

Initializes a keyless command with alternates.

Parameter title: Short display title. This should be localized.

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

Parameter action: Action to take on choosing this command.

Parameter propertyList: Property list object to distinguish commands, if needed.

Parameter alternates: Alternates that differ in modifier flags.

Returns: A new keyless command with alternates.

Source

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

Source

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

Source

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

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§

impl AsRef<AnyObject> for UICommand

Source§

fn as_ref(&self) -> &AnyObject

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

impl AsRef<NSObject> for UICommand

Source§

fn as_ref(&self) -> &NSObject

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

impl AsRef<UICommand> for UICommand

Source§

fn as_ref(&self) -> &Self

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

impl AsRef<UICommand> for UIKeyCommand

Available on crate feature UIKeyCommand only.
Source§

fn as_ref(&self) -> &UICommand

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

impl AsRef<UIMenuElement> for UICommand

Source§

fn as_ref(&self) -> &UIMenuElement

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

impl Borrow<AnyObject> for UICommand

Source§

fn borrow(&self) -> &AnyObject

Immutably borrows from an owned value. Read more
Source§

impl Borrow<NSObject> for UICommand

Source§

fn borrow(&self) -> &NSObject

Immutably borrows from an owned value. Read more
Source§

impl Borrow<UICommand> for UIKeyCommand

Available on crate feature UIKeyCommand only.
Source§

fn borrow(&self) -> &UICommand

Immutably borrows from an owned value. Read more
Source§

impl Borrow<UIMenuElement> for UICommand

Source§

fn borrow(&self) -> &UIMenuElement

Immutably borrows from an owned value. Read more
Source§

impl ClassType for UICommand

Source§

const NAME: &'static str = "UICommand"

The name of the Objective-C class that this type represents. Read more
Source§

type Super = UIMenuElement

The superclass of this class. Read more
Source§

type ThreadKind = dyn MainThreadOnly

Whether the type can be used from any thread, or from only the main thread. Read more
Source§

fn class() -> &'static AnyClass

Get a reference to the Objective-C class that this type represents. Read more
Source§

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

Get an immutable reference to the superclass.
Source§

impl CopyingHelper for UICommand

Source§

type Result = UICommand

The immutable counterpart of the type, or Self if the type has no immutable counterpart. Read more
Source§

impl Debug for UICommand

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Deref for UICommand

Source§

type Target = UIMenuElement

The resulting type after dereferencing.
Source§

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

Dereferences the value.
Source§

impl Hash for UICommand

Source§

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

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

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

Feeds a slice of this type into the given Hasher. Read more
Source§

impl Message for UICommand

Source§

fn retain(&self) -> Retained<Self>
where Self: Sized,

Increment the reference count of the receiver. Read more
Source§

impl NSCoding for UICommand

Source§

unsafe fn encodeWithCoder(&self, coder: &NSCoder)
where Self: Sized + Message,

Source§

unsafe fn initWithCoder( this: Allocated<Self>, coder: &NSCoder, ) -> Option<Retained<Self>>
where Self: Sized + Message,

Source§

impl NSCopying for UICommand

Source§

fn copy(&self) -> Retained<Self::Result>
where Self: Sized + Message + CopyingHelper,

Returns a new instance that’s a copy of the receiver. Read more
Source§

unsafe fn copyWithZone(&self, zone: *mut NSZone) -> Retained<Self::Result>
where Self: Sized + Message + CopyingHelper,

Returns a new instance that’s a copy of the receiver. Read more
Source§

impl NSObjectProtocol for UICommand

Source§

fn isEqual(&self, other: Option<&AnyObject>) -> bool
where Self: Sized + Message,

Check whether the object is equal to an arbitrary other object. Read more
Source§

fn hash(&self) -> usize
where Self: Sized + Message,

An integer that can be used as a table address in a hash table structure. Read more
Source§

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. Read more
Source§

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. Read more
Source§

fn isMemberOfClass(&self, cls: &AnyClass) -> bool
where Self: Sized + Message,

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

fn respondsToSelector(&self, aSelector: Sel) -> bool
where Self: Sized + Message,

Check whether the object implements or inherits a method with the given selector. Read more
Source§

fn conformsToProtocol(&self, aProtocol: &AnyProtocol) -> bool
where Self: Sized + Message,

Check whether the object conforms to a given protocol. Read more
Source§

fn description(&self) -> Retained<NSObject>
where Self: Sized + Message,

A textual representation of the object. Read more
Source§

fn debugDescription(&self) -> Retained<NSObject>
where Self: Sized + Message,

A textual representation of the object to use when debugging. Read more
Source§

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. Read more
Source§

fn retainCount(&self) -> usize
where Self: Sized + Message,

The reference count of the object. Read more
Source§

impl NSSecureCoding for UICommand

Source§

unsafe fn supportsSecureCoding() -> bool
where Self: Sized + ClassType,

Source§

impl PartialEq for UICommand

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

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

impl RefEncode for UICommand

Source§

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

The Objective-C type-encoding for a reference of this type. Read more
Source§

impl UIMenuLeaf for UICommand

Source§

unsafe fn title(&self) -> Retained<NSString>
where Self: Sized + Message,

Available on crate feature UIMenuLeaf only.
Short display title.
Source§

unsafe fn setTitle(&self, title: &NSString)
where Self: Sized + Message,

Available on crate feature UIMenuLeaf only.
Setter for title.
Source§

unsafe fn image(&self) -> Option<Retained<UIImage>>
where Self: Sized + Message,

Available on crate features UIMenuLeaf and UIImage only.
Image that can appear next to this element.
Source§

unsafe fn setImage(&self, image: Option<&UIImage>)
where Self: Sized + Message,

Available on crate features UIMenuLeaf and UIImage only.
Setter for image.
Source§

unsafe fn selectedImage(&self) -> Option<Retained<UIImage>>
where Self: Sized + Message,

Available on crate features UIMenuLeaf and UIImage only.
Image that can appear next to this action when the state is UIMenuElementStateOn
Source§

unsafe fn setSelectedImage(&self, selected_image: Option<&UIImage>)
where Self: Sized + Message,

Available on crate features UIMenuLeaf and UIImage only.
Setter for selectedImage.
Source§

unsafe fn discoverabilityTitle(&self) -> Option<Retained<NSString>>
where Self: Sized + Message,

Available on crate feature UIMenuLeaf only.
Elaborated title used in keyboard shortcut overlay.
Source§

unsafe fn setDiscoverabilityTitle( &self, discoverability_title: Option<&NSString>, )
where Self: Sized + Message,

Available on crate feature UIMenuLeaf only.
Source§

unsafe fn attributes(&self) -> UIMenuElementAttributes
where Self: Sized + Message,

Available on crate features UIMenuLeaf and UIMenuElement only.
The element’s attributes.
Source§

unsafe fn setAttributes(&self, attributes: UIMenuElementAttributes)
where Self: Sized + Message,

Available on crate features UIMenuLeaf and UIMenuElement only.
Setter for attributes.
Source§

unsafe fn state(&self) -> UIMenuElementState
where Self: Sized + Message,

Available on crate features UIMenuLeaf and UIMenuElement only.
The element’s selection state.
Source§

unsafe fn setState(&self, state: UIMenuElementState)
where Self: Sized + Message,

Available on crate features UIMenuLeaf and UIMenuElement only.
Setter for state.
Source§

unsafe fn sender(&self) -> Option<Retained<AnyObject>>
where Self: Sized + Message,

Available on crate feature UIMenuLeaf only.
The object on behalf of which the element’s primary action is being performed. This property is only populated during the execution of the element’s primary action (i.e. its handler or selector) if available.
Source§

unsafe fn presentationSourceItem( &self, ) -> Option<Retained<ProtocolObject<dyn UIPopoverPresentationControllerSourceItem>>>
where Self: Sized + Message,

Available on crate features UIMenuLeaf and UIPopoverPresentationControllerSourceItem only.
Source item for subsequent presentations. For example, an element displayed in a menu attached to a UIButtonmay return the button so that a popover may be presented from it when the element is tapped. If available, this property is only populated during the execution of the element’s action (i.e. its handler or selector).
Source§

unsafe fn performWithSender_target( &self, sender: Option<&AnyObject>, target: Option<&AnyObject>, )
where Self: Sized + Message,

Available on crate feature UIMenuLeaf only.
Performs the element’s primary action (i.e. it’s handler or selector).
Source§

impl DowncastTarget for UICommand

Source§

impl Eq for UICommand

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<'a, T> MainThreadOnly for T
where T: ClassType<ThreadKind = dyn MainThreadOnly + 'a> + ?Sized,

Source§

fn mtm(&self) -> MainThreadMarker

Get a MainThreadMarker from the main-thread-only object. Read more
Source§

fn alloc(mtm: MainThreadMarker) -> Allocated<Self>
where Self: Sized + ClassType,

Allocate a new instance of the class on the main thread. Read more
Source§

impl<P, T> Receiver for P
where P: Deref<Target = T> + ?Sized, T: ?Sized,

Source§

type Target = T

🔬This is a nightly-only experimental API. (arbitrary_self_types)
The target type on which the method may be called.
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> AutoreleaseSafe for T
where T: ?Sized,