Struct UIBarButtonItemBadge

Source

pub struct UIBarButtonItemBadge { /* private fields */ }

Available on crate feature UIBarButtonItemBadge only.

Expand description

A badge to be rendered on a bar button item.

Implementations§

Source §

impl UIBarButtonItemBadge

Source

pub fn badgeWithCount( count: NSUInteger, mtm: MainThreadMarker, ) -> Retained<Self>

Creates a badge with the specified count.

The count is localized when shown, and will update when the app’s locale changes.

Source

pub fn badgeWithString( string_value: &NSString, mtm: MainThreadMarker, ) -> Retained<Self>

Creates a badge with the specified string.

Source

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

Creates a badge that’s empty, and just renders the badge background with no content.

Source

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

Source

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

Source

pub fn backgroundColor(&self) -> Option<Retained<UIColor>>

Available on crate feature UIColor only.

The badge’s background color. A nil value will be treated as an indication to use the system default.

Source

pub fn setBackgroundColor(&self, background_color: Option<&UIColor>)

Available on crate feature UIColor only.

Setter for backgroundColor.

Source

pub fn foregroundColor(&self) -> Option<Retained<UIColor>>

Available on crate feature UIColor only.

The badge’s foreground color. A nil value will be treated as an indication to use the system default.

Source

pub fn setForegroundColor(&self, foreground_color: Option<&UIColor>)

Available on crate feature UIColor only.

Setter for foregroundColor.

Source

pub fn font(&self) -> Option<Retained<UIFont>>

Available on crate feature UIFont only.

The font to use for the badge. A nil value will be treated as an indication to use the system default.

Source

pub fn setFont(&self, font: Option<&UIFont>)

Available on crate feature UIFont only.

Setter for font.

Source §

impl UIBarButtonItemBadge

Methods declared on superclass NSObject.

Source

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

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`
    }
}