#[repr(C)]pub struct UICommand { /* private fields */ }
UICommand
and UIMenuElement
only.Expand description
Represents an action to take.
See also Apple’s documentation
Implementations§
Source§impl UICommand
impl UICommand
Sourcepub unsafe fn image(&self) -> Option<Retained<UIImage>>
Available on crate feature UIImage
only.
pub unsafe fn image(&self) -> Option<Retained<UIImage>>
UIImage
only.Image that can appear next to this command
Sourcepub unsafe fn setImage(&self, image: Option<&UIImage>)
Available on crate feature UIImage
only.
pub unsafe fn setImage(&self, image: Option<&UIImage>)
UIImage
only.Setter for image
.
Sourcepub unsafe fn discoverabilityTitle(&self) -> Option<Retained<NSString>>
pub unsafe fn discoverabilityTitle(&self) -> Option<Retained<NSString>>
Elaborated title used in keyboard shortcut overlay.
Sourcepub unsafe fn setDiscoverabilityTitle(
&self,
discoverability_title: Option<&NSString>,
)
pub unsafe fn setDiscoverabilityTitle( &self, discoverability_title: Option<&NSString>, )
Setter for discoverabilityTitle
.
Sourcepub unsafe fn propertyList(&self) -> Option<Retained<AnyObject>>
pub unsafe fn propertyList(&self) -> Option<Retained<AnyObject>>
Property list object to distinguish commands, if needed.
Sourcepub unsafe fn attributes(&self) -> UIMenuElementAttributes
pub unsafe fn attributes(&self) -> UIMenuElementAttributes
Command attributes.
Sourcepub unsafe fn setAttributes(&self, attributes: UIMenuElementAttributes)
pub unsafe fn setAttributes(&self, attributes: UIMenuElementAttributes)
Setter for attributes
.
Sourcepub unsafe fn state(&self) -> UIMenuElementState
pub unsafe fn state(&self) -> UIMenuElementState
State that can appear next to the command.
Sourcepub unsafe fn setState(&self, state: UIMenuElementState)
pub unsafe fn setState(&self, state: UIMenuElementState)
Setter for state
.
Sourcepub unsafe fn alternates(&self) -> Retained<NSArray<UICommandAlternate>>
pub unsafe fn alternates(&self) -> Retained<NSArray<UICommandAlternate>>
Alternates that differ in modifier flags, if any.
Sourcepub 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( title: &NSString, image: Option<&UIImage>, action: Sel, property_list: Option<&AnyObject>, mtm: MainThreadMarker, ) -> Retained<Self>
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.
Sourcepub 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.
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>
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.
pub unsafe fn new(mtm: MainThreadMarker) -> Retained<Self>
pub unsafe fn init(this: Allocated<Self>) -> Retained<Self>
pub unsafe fn initWithCoder( this: Allocated<Self>, coder: &NSCoder, ) -> Option<Retained<Self>>
Methods from Deref<Target = UIMenuElement>§
Sourcepub unsafe fn setSubtitle(&self, subtitle: Option<&NSString>)
pub unsafe fn setSubtitle(&self, subtitle: Option<&NSString>)
Setter for subtitle
.
Methods from Deref<Target = NSObject>§
Sourcepub fn doesNotRecognizeSelector(&self, sel: Sel) -> !
pub fn doesNotRecognizeSelector(&self, sel: Sel) -> !
Handle messages the object doesn’t recognize.
See Apple’s documentation for details.
Methods from Deref<Target = AnyObject>§
Sourcepub fn class(&self) -> &'static AnyClass
Available on crate feature UIIndirectScribbleInteraction
only.
pub fn class(&self) -> &'static AnyClass
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());
Sourcepub unsafe fn get_ivar<T>(&self, name: &str) -> &Twhere
T: Encode,
👎Deprecated: this is difficult to use correctly, use Ivar::load
instead.Available on crate feature UIIndirectScribbleInteraction
only.
pub unsafe fn get_ivar<T>(&self, name: &str) -> &Twhere
T: Encode,
Ivar::load
instead.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.
Sourcepub fn downcast_ref<T>(&self) -> Option<&T>where
T: DowncastTarget,
Available on crate feature UIIndirectScribbleInteraction
only.
pub fn downcast_ref<T>(&self) -> Option<&T>where
T: DowncastTarget,
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<UICommand> for UIKeyCommand
Available on crate feature UIKeyCommand
only.
impl AsRef<UICommand> for UIKeyCommand
UIKeyCommand
only.Source§impl AsRef<UIMenuElement> for UICommand
impl AsRef<UIMenuElement> for UICommand
Source§fn as_ref(&self) -> &UIMenuElement
fn as_ref(&self) -> &UIMenuElement
Source§impl Borrow<UICommand> for UIKeyCommand
Available on crate feature UIKeyCommand
only.
impl Borrow<UICommand> for UIKeyCommand
UIKeyCommand
only.Source§impl Borrow<UIMenuElement> for UICommand
impl Borrow<UIMenuElement> for UICommand
Source§fn borrow(&self) -> &UIMenuElement
fn borrow(&self) -> &UIMenuElement
Source§impl ClassType for UICommand
impl ClassType for UICommand
Source§const NAME: &'static str = "UICommand"
const NAME: &'static str = "UICommand"
Source§type Super = UIMenuElement
type Super = UIMenuElement
Source§type ThreadKind = dyn MainThreadOnly
type ThreadKind = dyn MainThreadOnly
Source§impl CopyingHelper for UICommand
impl CopyingHelper for UICommand
Source§impl NSCopying for UICommand
impl NSCopying for UICommand
Source§impl NSObjectProtocol for UICommand
impl NSObjectProtocol for UICommand
Source§fn isEqual(&self, other: Option<&AnyObject>) -> bool
fn isEqual(&self, other: Option<&AnyObject>) -> bool
Source§fn hash(&self) -> usize
fn hash(&self) -> usize
Source§fn isKindOfClass(&self, cls: &AnyClass) -> bool
fn isKindOfClass(&self, cls: &AnyClass) -> bool
Source§fn is_kind_of<T>(&self) -> bool
fn is_kind_of<T>(&self) -> bool
isKindOfClass
directly, or cast your objects with AnyObject::downcast_ref
Source§fn isMemberOfClass(&self, cls: &AnyClass) -> bool
fn isMemberOfClass(&self, cls: &AnyClass) -> bool
Source§fn respondsToSelector(&self, aSelector: Sel) -> bool
fn respondsToSelector(&self, aSelector: Sel) -> bool
Source§fn conformsToProtocol(&self, aProtocol: &AnyProtocol) -> bool
fn conformsToProtocol(&self, aProtocol: &AnyProtocol) -> bool
Source§fn debugDescription(&self) -> Retained<NSObject>
fn debugDescription(&self) -> Retained<NSObject>
Source§impl NSSecureCoding for UICommand
impl NSSecureCoding for UICommand
Source§impl RefEncode for UICommand
impl RefEncode for UICommand
Source§const ENCODING_REF: Encoding = <UIMenuElement as ::objc2::RefEncode>::ENCODING_REF
const ENCODING_REF: Encoding = <UIMenuElement as ::objc2::RefEncode>::ENCODING_REF
Source§impl UIMenuLeaf for UICommand
impl UIMenuLeaf for UICommand
Source§unsafe fn title(&self) -> Retained<NSString>
unsafe fn title(&self) -> Retained<NSString>
UIMenuLeaf
only.Source§unsafe fn setTitle(&self, title: &NSString)
unsafe fn setTitle(&self, title: &NSString)
UIMenuLeaf
only.title
.Source§unsafe fn image(&self) -> Option<Retained<UIImage>>
unsafe fn image(&self) -> Option<Retained<UIImage>>
UIMenuLeaf
and UIImage
only.Source§unsafe fn setImage(&self, image: Option<&UIImage>)
unsafe fn setImage(&self, image: Option<&UIImage>)
UIMenuLeaf
and UIImage
only.image
.Source§unsafe fn selectedImage(&self) -> Option<Retained<UIImage>>
unsafe fn selectedImage(&self) -> Option<Retained<UIImage>>
UIMenuLeaf
and UIImage
only.state
is UIMenuElementStateOn
Source§unsafe fn setSelectedImage(&self, selected_image: Option<&UIImage>)
unsafe fn setSelectedImage(&self, selected_image: Option<&UIImage>)
UIMenuLeaf
and UIImage
only.selectedImage
.Source§unsafe fn discoverabilityTitle(&self) -> Option<Retained<NSString>>
unsafe fn discoverabilityTitle(&self) -> Option<Retained<NSString>>
UIMenuLeaf
only.Source§unsafe fn setDiscoverabilityTitle(
&self,
discoverability_title: Option<&NSString>,
)
unsafe fn setDiscoverabilityTitle( &self, discoverability_title: Option<&NSString>, )
UIMenuLeaf
only.discoverabilityTitle
.Source§unsafe fn attributes(&self) -> UIMenuElementAttributes
unsafe fn attributes(&self) -> UIMenuElementAttributes
UIMenuLeaf
and UIMenuElement
only.Source§unsafe fn setAttributes(&self, attributes: UIMenuElementAttributes)
unsafe fn setAttributes(&self, attributes: UIMenuElementAttributes)
UIMenuLeaf
and UIMenuElement
only.attributes
.Source§unsafe fn state(&self) -> UIMenuElementState
unsafe fn state(&self) -> UIMenuElementState
UIMenuLeaf
and UIMenuElement
only.Source§unsafe fn setState(&self, state: UIMenuElementState)
unsafe fn setState(&self, state: UIMenuElementState)
UIMenuLeaf
and UIMenuElement
only.state
.Source§unsafe fn sender(&self) -> Option<Retained<AnyObject>>
unsafe fn sender(&self) -> Option<Retained<AnyObject>>
UIMenuLeaf
only.Source§unsafe fn presentationSourceItem(
&self,
) -> Option<Retained<ProtocolObject<dyn UIPopoverPresentationControllerSourceItem>>>
unsafe fn presentationSourceItem( &self, ) -> Option<Retained<ProtocolObject<dyn UIPopoverPresentationControllerSourceItem>>>
UIMenuLeaf
and UIPopoverPresentationControllerSourceItem
only.UIButton
may 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).impl DowncastTarget for UICommand
impl Eq for UICommand
Auto Trait Implementations§
impl !Freeze for UICommand
impl !RefUnwindSafe for UICommand
impl !Send for UICommand
impl !Sync for UICommand
impl !Unpin for UICommand
impl !UnwindSafe for UICommand
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<'a, T> MainThreadOnly for T
impl<'a, T> MainThreadOnly for T
Source§fn mtm(&self) -> MainThreadMarker
fn mtm(&self) -> MainThreadMarker
MainThreadMarker
from the main-thread-only object. Read more