#[repr(C)]pub struct NSButtonTouchBarItem { /* private fields */ }
NSButtonTouchBarItem
and NSTouchBarItem
only.Expand description
Implementations§
Source§impl NSButtonTouchBarItem
impl NSButtonTouchBarItem
NSImage
only.NSImage
only.pub unsafe fn title(&self) -> Retained<NSString>
pub unsafe fn image(&self) -> Option<Retained<NSImage>>
NSImage
only.Sourcepub unsafe fn setImage(&self, image: Option<&NSImage>)
Available on crate feature NSImage
only.
pub unsafe fn setImage(&self, image: Option<&NSImage>)
NSImage
only.Setter for image
.
pub unsafe fn bezelColor(&self) -> Option<Retained<NSColor>>
NSColor
only.Sourcepub unsafe fn setBezelColor(&self, bezel_color: Option<&NSColor>)
Available on crate feature NSColor
only.
pub unsafe fn setBezelColor(&self, bezel_color: Option<&NSColor>)
NSColor
only.Setter for bezelColor
.
pub unsafe fn target(&self) -> Option<Retained<AnyObject>>
Sourcepub unsafe fn setTarget(&self, target: Option<&AnyObject>)
pub unsafe fn setTarget(&self, target: Option<&AnyObject>)
This is a weak property.
Setter for target
.
pub unsafe fn action(&self) -> Option<Sel>
pub unsafe fn isEnabled(&self) -> bool
Sourcepub unsafe fn setEnabled(&self, enabled: bool)
pub unsafe fn setEnabled(&self, enabled: bool)
Setter for isEnabled
.
Sourcepub unsafe fn customizationLabel(&self) -> Retained<NSString>
pub unsafe fn customizationLabel(&self) -> Retained<NSString>
The localized string labelling this item during user customization. The default value is empty string.
Sourcepub unsafe fn setCustomizationLabel(
&self,
customization_label: Option<&NSString>,
)
pub unsafe fn setCustomizationLabel( &self, customization_label: Option<&NSString>, )
Setter for customizationLabel
.
Source§impl NSButtonTouchBarItem
Methods declared on superclass NSTouchBarItem
.
impl NSButtonTouchBarItem
Methods declared on superclass NSTouchBarItem
.
pub unsafe fn initWithIdentifier( this: Allocated<Self>, identifier: &NSTouchBarItemIdentifier, ) -> Retained<Self>
pub unsafe fn initWithCoder( this: Allocated<Self>, coder: &NSCoder, ) -> Option<Retained<Self>>
pub unsafe fn init(this: Allocated<Self>) -> Retained<Self>
Source§impl NSButtonTouchBarItem
Methods declared on superclass NSObject
.
impl NSButtonTouchBarItem
Methods declared on superclass NSObject
.
pub unsafe fn new(mtm: MainThreadMarker) -> Retained<Self>
Methods from Deref<Target = NSTouchBarItem>§
pub unsafe fn identifier(&self) -> Retained<NSTouchBarItemIdentifier>
pub unsafe fn visibilityPriority(&self) -> NSTouchBarItemPriority
Sourcepub unsafe fn setVisibilityPriority(
&self,
visibility_priority: NSTouchBarItemPriority,
)
pub unsafe fn setVisibilityPriority( &self, visibility_priority: NSTouchBarItemPriority, )
Setter for visibilityPriority
.
pub unsafe fn view(&self) -> Option<Retained<NSView>>
NSResponder
and NSView
only.pub unsafe fn viewController(&self) -> Option<Retained<NSViewController>>
NSResponder
and NSViewController
only.pub unsafe fn customizationLabel(&self) -> Retained<NSString>
pub unsafe fn isVisible(&self) -> bool
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 NSAccessibilityConstants
only.
pub fn class(&self) -> &'static AnyClass
NSAccessibilityConstants
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 NSAccessibilityConstants
only.
pub unsafe fn get_ivar<T>(&self, name: &str) -> &Twhere
T: Encode,
Ivar::load
instead.NSAccessibilityConstants
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 NSAccessibilityConstants
only.
pub fn downcast_ref<T>(&self) -> Option<&T>where
T: DowncastTarget,
NSAccessibilityConstants
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 NSButtonTouchBarItem
impl AsRef<AnyObject> for NSButtonTouchBarItem
Source§impl AsRef<NSObject> for NSButtonTouchBarItem
impl AsRef<NSObject> for NSButtonTouchBarItem
Source§impl AsRef<NSTouchBarItem> for NSButtonTouchBarItem
impl AsRef<NSTouchBarItem> for NSButtonTouchBarItem
Source§fn as_ref(&self) -> &NSTouchBarItem
fn as_ref(&self) -> &NSTouchBarItem
Source§impl Borrow<AnyObject> for NSButtonTouchBarItem
impl Borrow<AnyObject> for NSButtonTouchBarItem
Source§impl Borrow<NSObject> for NSButtonTouchBarItem
impl Borrow<NSObject> for NSButtonTouchBarItem
Source§impl Borrow<NSTouchBarItem> for NSButtonTouchBarItem
impl Borrow<NSTouchBarItem> for NSButtonTouchBarItem
Source§fn borrow(&self) -> &NSTouchBarItem
fn borrow(&self) -> &NSTouchBarItem
Source§impl ClassType for NSButtonTouchBarItem
impl ClassType for NSButtonTouchBarItem
Source§const NAME: &'static str = "NSButtonTouchBarItem"
const NAME: &'static str = "NSButtonTouchBarItem"
Source§type Super = NSTouchBarItem
type Super = NSTouchBarItem
Source§type ThreadKind = <<NSButtonTouchBarItem as ClassType>::Super as ClassType>::ThreadKind
type ThreadKind = <<NSButtonTouchBarItem as ClassType>::Super as ClassType>::ThreadKind
Source§impl Debug for NSButtonTouchBarItem
impl Debug for NSButtonTouchBarItem
Source§impl Deref for NSButtonTouchBarItem
impl Deref for NSButtonTouchBarItem
Source§impl Hash for NSButtonTouchBarItem
impl Hash for NSButtonTouchBarItem
Source§impl Message for NSButtonTouchBarItem
impl Message for NSButtonTouchBarItem
Source§impl NSCoding for NSButtonTouchBarItem
impl NSCoding for NSButtonTouchBarItem
Source§impl NSObjectProtocol for NSButtonTouchBarItem
impl NSObjectProtocol for NSButtonTouchBarItem
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 PartialEq for NSButtonTouchBarItem
impl PartialEq for NSButtonTouchBarItem
Source§impl RefEncode for NSButtonTouchBarItem
impl RefEncode for NSButtonTouchBarItem
Source§const ENCODING_REF: Encoding = <NSTouchBarItem as ::objc2::RefEncode>::ENCODING_REF
const ENCODING_REF: Encoding = <NSTouchBarItem as ::objc2::RefEncode>::ENCODING_REF
impl DowncastTarget for NSButtonTouchBarItem
impl Eq for NSButtonTouchBarItem
Auto Trait Implementations§
impl !Freeze for NSButtonTouchBarItem
impl !RefUnwindSafe for NSButtonTouchBarItem
impl !Send for NSButtonTouchBarItem
impl !Sync for NSButtonTouchBarItem
impl !Unpin for NSButtonTouchBarItem
impl !UnwindSafe for NSButtonTouchBarItem
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