#[repr(C)]pub struct NSGroupTouchBarItem { /* private fields */ }
NSGroupTouchBarItem
and NSTouchBarItem
only.Expand description
Implementations§
Source§impl NSGroupTouchBarItem
impl NSGroupTouchBarItem
pub unsafe fn groupItemWithIdentifier_items( identifier: &NSTouchBarItemIdentifier, items: &NSArray<NSTouchBarItem>, mtm: MainThreadMarker, ) -> Retained<Self>
pub unsafe fn groupItemWithIdentifier_items_allowedCompressionOptions( identifier: &NSTouchBarItemIdentifier, items: &NSArray<NSTouchBarItem>, allowed_compression_options: &NSUserInterfaceCompressionOptions, mtm: MainThreadMarker, ) -> Retained<Self>
NSUserInterfaceCompression
only.pub unsafe fn alertStyleGroupItemWithIdentifier( identifier: &NSTouchBarItemIdentifier, mtm: MainThreadMarker, ) -> Retained<Self>
pub unsafe fn groupTouchBar(&self) -> Retained<NSTouchBar>
NSTouchBar
only.Sourcepub unsafe fn setGroupTouchBar(&self, group_touch_bar: &NSTouchBar)
Available on crate feature NSTouchBar
only.
pub unsafe fn setGroupTouchBar(&self, group_touch_bar: &NSTouchBar)
NSTouchBar
only.Setter for groupTouchBar
.
pub unsafe fn customizationLabel(&self) -> Retained<NSString>
Sourcepub unsafe fn setCustomizationLabel(
&self,
customization_label: Option<&NSString>,
)
pub unsafe fn setCustomizationLabel( &self, customization_label: Option<&NSString>, )
Setter for customizationLabel
.
pub unsafe fn groupUserInterfaceLayoutDirection( &self, ) -> NSUserInterfaceLayoutDirection
NSUserInterfaceLayout
only.Sourcepub unsafe fn setGroupUserInterfaceLayoutDirection(
&self,
group_user_interface_layout_direction: NSUserInterfaceLayoutDirection,
)
Available on crate feature NSUserInterfaceLayout
only.
pub unsafe fn setGroupUserInterfaceLayoutDirection( &self, group_user_interface_layout_direction: NSUserInterfaceLayoutDirection, )
NSUserInterfaceLayout
only.Setter for groupUserInterfaceLayoutDirection
.
pub unsafe fn prefersEqualWidths(&self) -> bool
Sourcepub unsafe fn setPrefersEqualWidths(&self, prefers_equal_widths: bool)
pub unsafe fn setPrefersEqualWidths(&self, prefers_equal_widths: bool)
Setter for prefersEqualWidths
.
pub unsafe fn preferredItemWidth(&self) -> CGFloat
objc2-core-foundation
only.Sourcepub unsafe fn setPreferredItemWidth(&self, preferred_item_width: CGFloat)
Available on crate feature objc2-core-foundation
only.
pub unsafe fn setPreferredItemWidth(&self, preferred_item_width: CGFloat)
objc2-core-foundation
only.Setter for preferredItemWidth
.
pub unsafe fn effectiveCompressionOptions( &self, ) -> Retained<NSUserInterfaceCompressionOptions>
NSUserInterfaceCompression
only.pub unsafe fn prioritizedCompressionOptions( &self, ) -> Retained<NSArray<NSUserInterfaceCompressionOptions>>
NSUserInterfaceCompression
only.Sourcepub unsafe fn setPrioritizedCompressionOptions(
&self,
prioritized_compression_options: &NSArray<NSUserInterfaceCompressionOptions>,
)
Available on crate feature NSUserInterfaceCompression
only.
pub unsafe fn setPrioritizedCompressionOptions( &self, prioritized_compression_options: &NSArray<NSUserInterfaceCompressionOptions>, )
NSUserInterfaceCompression
only.Setter for prioritizedCompressionOptions
.
Source§impl NSGroupTouchBarItem
Methods declared on superclass NSTouchBarItem
.
impl NSGroupTouchBarItem
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 NSGroupTouchBarItem
Methods declared on superclass NSObject
.
impl NSGroupTouchBarItem
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 NSGroupTouchBarItem
impl AsRef<AnyObject> for NSGroupTouchBarItem
Source§impl AsRef<NSObject> for NSGroupTouchBarItem
impl AsRef<NSObject> for NSGroupTouchBarItem
Source§impl AsRef<NSTouchBarItem> for NSGroupTouchBarItem
impl AsRef<NSTouchBarItem> for NSGroupTouchBarItem
Source§fn as_ref(&self) -> &NSTouchBarItem
fn as_ref(&self) -> &NSTouchBarItem
Source§impl Borrow<AnyObject> for NSGroupTouchBarItem
impl Borrow<AnyObject> for NSGroupTouchBarItem
Source§impl Borrow<NSObject> for NSGroupTouchBarItem
impl Borrow<NSObject> for NSGroupTouchBarItem
Source§impl Borrow<NSTouchBarItem> for NSGroupTouchBarItem
impl Borrow<NSTouchBarItem> for NSGroupTouchBarItem
Source§fn borrow(&self) -> &NSTouchBarItem
fn borrow(&self) -> &NSTouchBarItem
Source§impl ClassType for NSGroupTouchBarItem
impl ClassType for NSGroupTouchBarItem
Source§const NAME: &'static str = "NSGroupTouchBarItem"
const NAME: &'static str = "NSGroupTouchBarItem"
Source§type Super = NSTouchBarItem
type Super = NSTouchBarItem
Source§type ThreadKind = <<NSGroupTouchBarItem as ClassType>::Super as ClassType>::ThreadKind
type ThreadKind = <<NSGroupTouchBarItem as ClassType>::Super as ClassType>::ThreadKind
Source§impl Debug for NSGroupTouchBarItem
impl Debug for NSGroupTouchBarItem
Source§impl Deref for NSGroupTouchBarItem
impl Deref for NSGroupTouchBarItem
Source§impl Hash for NSGroupTouchBarItem
impl Hash for NSGroupTouchBarItem
Source§impl Message for NSGroupTouchBarItem
impl Message for NSGroupTouchBarItem
Source§impl NSCoding for NSGroupTouchBarItem
impl NSCoding for NSGroupTouchBarItem
Source§impl NSObjectProtocol for NSGroupTouchBarItem
impl NSObjectProtocol for NSGroupTouchBarItem
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 NSGroupTouchBarItem
impl PartialEq for NSGroupTouchBarItem
Source§impl RefEncode for NSGroupTouchBarItem
impl RefEncode for NSGroupTouchBarItem
Source§const ENCODING_REF: Encoding = <NSTouchBarItem as ::objc2::RefEncode>::ENCODING_REF
const ENCODING_REF: Encoding = <NSTouchBarItem as ::objc2::RefEncode>::ENCODING_REF
impl DowncastTarget for NSGroupTouchBarItem
impl Eq for NSGroupTouchBarItem
Auto Trait Implementations§
impl !Freeze for NSGroupTouchBarItem
impl !RefUnwindSafe for NSGroupTouchBarItem
impl !Send for NSGroupTouchBarItem
impl !Sync for NSGroupTouchBarItem
impl !Unpin for NSGroupTouchBarItem
impl !UnwindSafe for NSGroupTouchBarItem
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