Struct UIKeyCommand

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

Available on crate features UICommand and UIKeyCommand and UIMenuElement only.

Apple’s documentation

Implementations

impl UIKeyCommand

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

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

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

Short display title.

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

Setter for title.

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

Available on crate feature UIImage only.

Image that can appear next to this command.

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

Available on crate feature UIImage only.

Setter for image.

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

Elaborated title, if any.

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

Setter for discoverabilityTitle.

pub unsafe fn action(&self) -> Option<Sel>

Action to take on choosing this command.

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

pub unsafe fn modifierFlags(&self) -> UIKeyModifierFlags

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

Property list object to distinguish commands, if needed.

pub unsafe fn attributes(&self) -> UIMenuElementAttributes

Command attributes.

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

Setter for attributes.

pub unsafe fn state(&self) -> UIMenuElementState

State that can appear next to this command.

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

Setter for state.

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

Alternates that differ in modifier flags, if any.

pub unsafe fn wantsPriorityOverSystemBehavior(&self) -> bool

Indicates whether the key command should execute if it conflicts with focus or text-editing system commands, defaults to NO

pub unsafe fn setWantsPriorityOverSystemBehavior( &self, wants_priority_over_system_behavior: bool, )

Setter for wantsPriorityOverSystemBehavior.

pub unsafe fn allowsAutomaticLocalization(&self) -> bool

Suppose the system detects a given key command that is not reachable in the current keyboard layout; it will localize the key command to something reachable. By setting this property to NO, you will opt-out this menu item from the system-provided localization. YES by default for apps linked against 15.0 and later SDK.

pub unsafe fn setAllowsAutomaticLocalization( &self, allows_automatic_localization: bool, )

Setter for allowsAutomaticLocalization.

pub unsafe fn allowsAutomaticMirroring(&self) -> bool

Suppose the system detects a given key command with the following input string [ ] { } ( ) <

← → in a right-to-left user interface environment (UIUserInterfaceLayoutDirectionRightToLeft); in that case, the system will automatically mirror the key command. For example, a pair of key commands with input { and } will be localized to } and { in a right-to-left user interface. By setting this property to NO, you will opt-out this key command of automatically mirroring in RTL. It would be best only to do this if your action will result in some sort of directional change in the UI, e.g. a segmented control for text alignment or a D-pad in a game. YES by default for apps linked against 15.0 and later SDK.

pub unsafe fn setAllowsAutomaticMirroring( &self, allows_automatic_mirroring: bool, )

Setter for allowsAutomaticMirroring.

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

Available on crate feature UIImage only.

Initializes a key 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 input: Keys that must be pressed to choose this command.

Parameter modifierFlags: Bit mask of key modifier flags to choose this command.

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

Returns: A new key command.

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

Available on crate feature UIImage only.

Initializes a key 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 input: Keys that must be pressed to choose this command.

Parameter modifierFlags: Bit mask of key modifier flags to choose this command.

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

Parameter alternates: Alternates that differ in modifier flags.

Returns: A new key command.

pub unsafe fn keyCommandWithInput_modifierFlags_action( input: &NSString, modifier_flags: UIKeyModifierFlags, action: Sel, mtm: MainThreadMarker, ) -> Retained<Self>

pub unsafe fn keyCommandWithInput_modifierFlags_action_discoverabilityTitle( input: &NSString, modifier_flags: UIKeyModifierFlags, action: Sel, discoverability_title: &NSString, mtm: MainThreadMarker, ) -> Retained<Self>

👎Deprecated

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.

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.

impl UIKeyCommand

Methods declared on superclass UICommand.

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

Methods from Deref<Target = UICommand>

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

Short display title.

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

Setter for title.

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

Available on crate feature UIImage only.

Image that can appear next to this command

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

Available on crate feature UIImage only.

Setter for image.

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

Elaborated title used in keyboard shortcut overlay.

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

Setter for discoverabilityTitle.

pub unsafe fn action(&self) -> Sel

Action to take on choosing this command.

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

Property list object to distinguish commands, if needed.

pub unsafe fn attributes(&self) -> UIMenuElementAttributes

Command attributes.

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

Setter for attributes.

pub unsafe fn state(&self) -> UIMenuElementState

State that can appear next to the command.

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

Setter for state.

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

Alternates that differ in modifier flags, if any.

Methods from Deref<Target = UIMenuElement>

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

The element’s title.

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

The element’s subtitle.

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

Setter for subtitle.

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>

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 UIKeyCommand

fn as_ref(&self) -> &AnyObject

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

impl AsRef<NSObject> for UIKeyCommand

fn as_ref(&self) -> &NSObject

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

impl AsRef<UICommand> for UIKeyCommand

fn as_ref(&self) -> &UICommand

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

impl AsRef<UIKeyCommand> for UIKeyCommand

fn as_ref(&self) -> &Self

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

impl AsRef<UIMenuElement> for UIKeyCommand

fn as_ref(&self) -> &UIMenuElement

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

impl Borrow<AnyObject> for UIKeyCommand

fn borrow(&self) -> &AnyObject

Immutably borrows from an owned value.

impl Borrow<NSObject> for UIKeyCommand

fn borrow(&self) -> &NSObject

Immutably borrows from an owned value.

impl Borrow<UICommand> for UIKeyCommand

fn borrow(&self) -> &UICommand

Immutably borrows from an owned value.

impl Borrow<UIMenuElement> for UIKeyCommand

fn borrow(&self) -> &UIMenuElement

Immutably borrows from an owned value.

impl ClassType for UIKeyCommand

const NAME: &'static str = "UIKeyCommand"

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

type Super = UICommand

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 CopyingHelper for UIKeyCommand

type Result = UIKeyCommand

The immutable counterpart of the type, or Self if the type has no immutable counterpart.

impl Debug for UIKeyCommand

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

Formats the value using the given formatter.

impl Deref for UIKeyCommand

type Target = UICommand

The resulting type after dereferencing.

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

Dereferences the value.

impl Hash for UIKeyCommand

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 UIKeyCommand

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

where Self: Sized,

Increment the reference count of the receiver.

impl NSCoding for UIKeyCommand

unsafe fn encodeWithCoder(&self, coder: &NSCoder)

where Self: Sized + Message,

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

where Self: Sized + Message,

impl NSCopying for UIKeyCommand

fn copy(&self) -> Retained<Self::Result>

where Self: Sized + Message + CopyingHelper,

Returns a new instance that’s a copy of the receiver.

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.

impl NSObjectProtocol for UIKeyCommand

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 NSSecureCoding for UIKeyCommand

unsafe fn supportsSecureCoding() -> bool

where Self: Sized + ClassType,

impl PartialEq for UIKeyCommand

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 UIKeyCommand

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

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

impl UIMenuLeaf for UIKeyCommand

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

where Self: Sized + Message,

Available on crate feature UIMenuLeaf only.

Short display title.

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

where Self: Sized + Message,

Available on crate feature UIMenuLeaf only.

Setter for title.

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.

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

where Self: Sized + Message,

Available on crate features UIMenuLeaf and UIImage only.

Setter for image.

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

unsafe fn setSelectedImage(&self, selected_image: Option<&UIImage>)

where Self: Sized + Message,

Available on crate features UIMenuLeaf and UIImage only.

Setter for selectedImage.

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

where Self: Sized + Message,

Available on crate feature UIMenuLeaf only.

Elaborated title used in keyboard shortcut overlay.

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

where Self: Sized + Message,

Available on crate feature UIMenuLeaf only.

Setter for discoverabilityTitle.

unsafe fn attributes(&self) -> UIMenuElementAttributes

where Self: Sized + Message,

Available on crate features UIMenuLeaf and UIMenuElement only.

The element’s attributes.

unsafe fn setAttributes(&self, attributes: UIMenuElementAttributes)

where Self: Sized + Message,

Available on crate features UIMenuLeaf and UIMenuElement only.

Setter for attributes.

unsafe fn state(&self) -> UIMenuElementState

where Self: Sized + Message,

Available on crate features UIMenuLeaf and UIMenuElement only.

The element’s selection state.

unsafe fn setState(&self, state: UIMenuElementState)

where Self: Sized + Message,

Available on crate features UIMenuLeaf and UIMenuElement only.

Setter for state.

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.

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

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

impl DowncastTarget for UIKeyCommand

impl Eq for UIKeyCommand