Struct UITabBarItem

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

Available on crate features UIBarItem and UITabBarItem only.

Apple’s documentation

Implementations

impl UITabBarItem

UIPopoverPresentationControllerSourceItem.

This impl block contains no items.

impl UITabBarItem

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

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

pub unsafe fn initWithTitle_image_tag( this: Allocated<Self>, title: Option<&NSString>, image: Option<&UIImage>, tag: NSInteger, ) -> Retained<Self>

Available on crate feature UIImage only.

pub unsafe fn initWithTitle_image_selectedImage( this: Allocated<Self>, title: Option<&NSString>, image: Option<&UIImage>, selected_image: Option<&UIImage>, ) -> Retained<Self>

Available on crate feature UIImage only.

pub unsafe fn initWithTabBarSystemItem_tag( this: Allocated<Self>, system_item: UITabBarSystemItem, tag: NSInteger, ) -> Retained<Self>

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

Available on crate feature UIImage only.

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

Available on crate feature UIImage only.

Setter for selectedImage.

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

pub unsafe fn setBadgeValue(&self, badge_value: Option<&NSString>)

Setter for badgeValue.

pub unsafe fn setFinishedSelectedImage_withFinishedUnselectedImage( &self, selected_image: Option<&UIImage>, unselected_image: Option<&UIImage>, )

👎Deprecated: Use initWithTitle:image:selectedImage: or the image and selectedImage properties along with UIImageRenderingModeAlwaysOriginal

Available on crate feature UIImage only.

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

👎Deprecated

Available on crate feature UIImage only.

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

👎Deprecated

Available on crate feature UIImage only.

pub unsafe fn titlePositionAdjustment(&self) -> UIOffset

Available on crate features UIGeometry and objc2-core-foundation only.

pub unsafe fn setTitlePositionAdjustment( &self, title_position_adjustment: UIOffset, )

Available on crate features UIGeometry and objc2-core-foundation only.

Setter for titlePositionAdjustment.

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

Available on crate feature UIColor only.

If this item displays a badge, this color will be used for the badge’s background. If set to nil, the default background color will be used instead.

pub unsafe fn setBadgeColor(&self, badge_color: Option<&UIColor>)

Available on crate feature UIColor only.

Setter for badgeColor.

pub unsafe fn setBadgeTextAttributes_forState( &self, text_attributes: Option<&NSDictionary<NSAttributedStringKey, AnyObject>>, state: UIControlState, )

Available on crate feature UIControl only.

Provide text attributes to use to draw the badge text for the given singular control state (Normal, Disabled, Focused, Selected, or Highlighted). Default values will be supplied for keys that are not provided by this dictionary. See NSAttributedString.h for details on what keys are available.

pub unsafe fn badgeTextAttributesForState( &self, state: UIControlState, ) -> Option<Retained<NSDictionary<NSAttributedStringKey, AnyObject>>>

Available on crate feature UIControl only.

Returns attributes previously set via -setBadgeTextAttributes:forState:.

pub unsafe fn standardAppearance(&self) -> Option<Retained<UITabBarAppearance>>

Available on crate features UIBarAppearance and UITabBarAppearance only.

When set and this item is selected, overrides the hosting tab bar’s standardAppearance.

pub unsafe fn setStandardAppearance( &self, standard_appearance: Option<&UITabBarAppearance>, )

Available on crate features UIBarAppearance and UITabBarAppearance only.

Setter for standardAppearance.

pub unsafe fn scrollEdgeAppearance( &self, ) -> Option<Retained<UITabBarAppearance>>

Available on crate features UIBarAppearance and UITabBarAppearance only.

When set and this item is selected, overrides the hosting tab bar’s scrollEdgeAppearance.

pub unsafe fn setScrollEdgeAppearance( &self, scroll_edge_appearance: Option<&UITabBarAppearance>, )

Available on crate features UIBarAppearance and UITabBarAppearance only.

Setter for scrollEdgeAppearance.

impl UITabBarItem

Methods declared on superclass NSObject.

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

impl UITabBarItem

SpringLoading.

This impl block contains no items.

Methods from Deref<Target = UIBarItem>

pub unsafe fn isEnabled(&self) -> bool

pub unsafe fn setEnabled(&self, enabled: bool)

Setter for isEnabled.

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

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

Setter for title.

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

Available on crate feature UIImage only.

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

Available on crate feature UIImage only.

Setter for image.

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

Available on crate feature UIImage only.

pub unsafe fn setLandscapeImagePhone( &self, landscape_image_phone: Option<&UIImage>, )

Available on crate feature UIImage only.

Setter for landscapeImagePhone.

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

Available on crate feature UIImage only.

pub unsafe fn setLargeContentSizeImage( &self, large_content_size_image: Option<&UIImage>, )

Available on crate feature UIImage only.

Setter for largeContentSizeImage.

pub unsafe fn imageInsets(&self) -> UIEdgeInsets

Available on crate features UIGeometry and objc2-core-foundation only.

pub unsafe fn setImageInsets(&self, image_insets: UIEdgeInsets)

Available on crate features UIGeometry and objc2-core-foundation only.

Setter for imageInsets.

pub unsafe fn landscapeImagePhoneInsets(&self) -> UIEdgeInsets

Available on crate features UIGeometry and objc2-core-foundation only.

pub unsafe fn setLandscapeImagePhoneInsets( &self, landscape_image_phone_insets: UIEdgeInsets, )

Available on crate features UIGeometry and objc2-core-foundation only.

Setter for landscapeImagePhoneInsets.

pub unsafe fn largeContentSizeImageInsets(&self) -> UIEdgeInsets

Available on crate features UIGeometry and objc2-core-foundation only.

pub unsafe fn setLargeContentSizeImageInsets( &self, large_content_size_image_insets: UIEdgeInsets, )

Available on crate features UIGeometry and objc2-core-foundation only.

Setter for largeContentSizeImageInsets.

pub unsafe fn tag(&self) -> NSInteger

pub unsafe fn setTag(&self, tag: NSInteger)

Setter for tag.

pub unsafe fn setTitleTextAttributes_forState( &self, attributes: Option<&NSDictionary<NSAttributedStringKey, AnyObject>>, state: UIControlState, )

Available on crate feature UIControl only.

pub unsafe fn titleTextAttributesForState( &self, state: UIControlState, ) -> Option<Retained<NSDictionary<NSAttributedStringKey, AnyObject>>>

Available on crate feature UIControl only.

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.

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 UITabBarItem

fn as_ref(&self) -> &AnyObject

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

impl AsRef<NSObject> for UITabBarItem

fn as_ref(&self) -> &NSObject

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

impl AsRef<UIBarItem> for UITabBarItem

fn as_ref(&self) -> &UIBarItem

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

impl AsRef<UITabBarItem> for UITabBarItem

fn as_ref(&self) -> &Self

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

impl Borrow<AnyObject> for UITabBarItem

fn borrow(&self) -> &AnyObject

Immutably borrows from an owned value.

impl Borrow<NSObject> for UITabBarItem

fn borrow(&self) -> &NSObject

Immutably borrows from an owned value.

impl Borrow<UIBarItem> for UITabBarItem

fn borrow(&self) -> &UIBarItem

Immutably borrows from an owned value.

impl ClassType for UITabBarItem

const NAME: &'static str = "UITabBarItem"

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

type Super = UIBarItem

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 Debug for UITabBarItem

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

Formats the value using the given formatter.

impl Deref for UITabBarItem

type Target = UIBarItem

The resulting type after dereferencing.

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

Dereferences the value.

impl Hash for UITabBarItem

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 UITabBarItem

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

where Self: Sized,

Increment the reference count of the receiver.

impl NSCoding for UITabBarItem

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

where Self: Sized + Message,

Available on crate feature NSCoder only.

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

where Self: Sized + Message,

Available on crate feature NSCoder only.

impl NSObjectProtocol for UITabBarItem

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 PartialEq for UITabBarItem

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 UITabBarItem

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

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

impl UIAppearance for UITabBarItem

Available on crate feature UIAppearance only.

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

where Self: Sized + ClassType,

unsafe fn appearanceWhenContainedInInstancesOfClasses( container_types: &NSArray<AnyClass>, mtm: MainThreadMarker, ) -> Retained<Self>

where Self: Sized + ClassType,

unsafe fn appearanceForTraitCollection( trait: &UITraitCollection, mtm: MainThreadMarker, ) -> Retained<Self>

where Self: Sized + ClassType,

Available on crate feature UITraitCollection only.

unsafe fn appearanceForTraitCollection_whenContainedInInstancesOfClasses( trait: &UITraitCollection, container_types: &NSArray<AnyClass>, mtm: MainThreadMarker, ) -> Retained<Self>

where Self: Sized + ClassType,

Available on crate feature UITraitCollection only.

impl UIPopoverPresentationControllerSourceItem for UITabBarItem

Available on crate feature UIPopoverPresentationControllerSourceItem only.

unsafe fn frameInView(&self, reference_view: &UIView) -> CGRect

where Self: Sized + Message,

Available on crate features UIResponder and UIView and objc2-core-foundation only.

impl UISpringLoadedInteractionSupporting for UITabBarItem

Available on crate feature UISpringLoadedInteractionSupporting only.

unsafe fn isSpringLoaded(&self) -> bool

where Self: Sized + Message,

unsafe fn setSpringLoaded(&self, spring_loaded: bool)

where Self: Sized + Message,

Setter for isSpringLoaded.

impl DowncastTarget for UITabBarItem

impl Eq for UITabBarItem