Struct UITabBarAppearance

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

Available on crate features UIBarAppearance and UITabBarAppearance only.

Apple’s documentation

Implementations

impl UITabBarAppearance

pub unsafe fn stackedLayoutAppearance(&self) -> Retained<UITabBarItemAppearance>

The appearance for the stacked tab bar item layout

pub unsafe fn setStackedLayoutAppearance( &self, stacked_layout_appearance: &UITabBarItemAppearance, )

Setter for stackedLayoutAppearance.

pub unsafe fn inlineLayoutAppearance(&self) -> Retained<UITabBarItemAppearance>

The appearance for the inline tab bar item layout

pub unsafe fn setInlineLayoutAppearance( &self, inline_layout_appearance: &UITabBarItemAppearance, )

Setter for inlineLayoutAppearance.

pub unsafe fn compactInlineLayoutAppearance( &self, ) -> Retained<UITabBarItemAppearance>

The appearance for the compact inline tab bar item layout

pub unsafe fn setCompactInlineLayoutAppearance( &self, compact_inline_layout_appearance: &UITabBarItemAppearance, )

Setter for compactInlineLayoutAppearance.

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

Available on crate feature UIColor only.

A color to use for the selectionIndicator, its specific behavior depends on the value of selectionIndicatorImage. If selectionIndicatorImage is nil, then the selectionIndicatorTintColor is used to color the UITabBar’s default selection indicator; a nil or clearColor selectionIndicatorTintColor will result in no indicator. If selectionIndicatorImage is a template image, then the selectionIndicatorTintColor is used to tint the image; a nil or clearColor selectionIndicatorTintColor will also result in no indicator. If the selectionIndicatorImage is not a template image, then it will be rendered without respect to the value of selectionIndicatorTintColor.

pub unsafe fn setSelectionIndicatorTintColor( &self, selection_indicator_tint_color: Option<&UIColor>, )

Available on crate feature UIColor only.

Setter for selectionIndicatorTintColor.

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

Available on crate feature UIImage only.

An image that is rendered behind the selected UITabBarItem and above the tab bar’s background. Modified by selectionIndicatorTintColor when appropriate.

pub unsafe fn setSelectionIndicatorImage( &self, selection_indicator_image: Option<&UIImage>, )

Available on crate feature UIImage only.

Setter for selectionIndicatorImage.

pub unsafe fn stackedItemPositioning(&self) -> UITabBarItemPositioning

Available on crate feature UITabBar only.

Determines how items in the tab bar lay out in the stacked item layout

pub unsafe fn setStackedItemPositioning( &self, stacked_item_positioning: UITabBarItemPositioning, )

Available on crate feature UITabBar only.

Setter for stackedItemPositioning.

pub unsafe fn stackedItemWidth(&self) -> CGFloat

Available on crate feature objc2-core-foundation only.

pub unsafe fn setStackedItemWidth(&self, stacked_item_width: CGFloat)

Available on crate feature objc2-core-foundation only.

Setter for stackedItemWidth.

pub unsafe fn stackedItemSpacing(&self) -> CGFloat

Available on crate feature objc2-core-foundation only.

pub unsafe fn setStackedItemSpacing(&self, stacked_item_spacing: CGFloat)

Available on crate feature objc2-core-foundation only.

Setter for stackedItemSpacing.

impl UITabBarAppearance

Methods declared on superclass UIBarAppearance.

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

Constructs a new bar appearance, configured with default values and targeting the device idiom.

pub unsafe fn initWithIdiom( this: Allocated<Self>, idiom: UIUserInterfaceIdiom, ) -> Retained<Self>

Available on crate feature UIDevice only.

Constructs a new bar appearance, targeting the passed-in idiom as a hint. Not all platforms support all available idioms. See the idiom property to determine the resolved idiom.

pub unsafe fn initWithBarAppearance( this: Allocated<Self>, bar_appearance: &UIBarAppearance, ) -> Retained<Self>

Constructs a new bar appearance, copying all relevant properties from the given appearance object. This initializer is useful for migrating configuration between UIBarAppearance subclasses. For example, you can initialize a UINavigationBarAppearance with a UIToolbarAppearance instance, and shared attributes will be identical between the two.

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

impl UITabBarAppearance

Methods declared on superclass NSObject.

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

Methods from Deref<Target = UIBarAppearance>

pub unsafe fn idiom(&self) -> UIUserInterfaceIdiom

Available on crate feature UIDevice only.

The idiom that this appearance object targets.

pub unsafe fn copy(&self) -> Retained<Self>

pub unsafe fn configureWithDefaultBackground(&self)

Reset background and shadow properties to their defaults.

pub unsafe fn configureWithOpaqueBackground(&self)

Reset background and shadow properties to display theme-appropriate opaque colors.

pub unsafe fn configureWithTransparentBackground(&self)

Reset background and shadow properties to be transparent.

pub unsafe fn backgroundEffect(&self) -> Option<Retained<UIBlurEffect>>

Available on crate features UIBlurEffect and UIVisualEffect only.

A specific blur effect to use for the bar background. This effect is composited first when constructing the bar’s background.

pub unsafe fn setBackgroundEffect( &self, background_effect: Option<&UIBlurEffect>, )

Available on crate features UIBlurEffect and UIVisualEffect only.

Setter for backgroundEffect.

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

Available on crate feature UIColor only.

A color to use for the bar background. This color is composited over backgroundEffects.

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

Available on crate feature UIColor only.

Setter for backgroundColor.

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

Available on crate feature UIImage only.

An image to use for the bar background. This image is composited over the backgroundColor, and resized per the backgroundImageContentMode.

pub unsafe fn setBackgroundImage(&self, background_image: Option<&UIImage>)

Available on crate feature UIImage only.

Setter for backgroundImage.

pub unsafe fn backgroundImageContentMode(&self) -> UIViewContentMode

Available on crate feature UIView only.

The content mode to use when rendering the backgroundImage. Defaults to UIViewContentModeScaleToFill. UIViewContentModeRedraw will be reinterpreted as UIViewContentModeScaleToFill.

pub unsafe fn setBackgroundImageContentMode( &self, background_image_content_mode: UIViewContentMode, )

Available on crate feature UIView only.

Setter for backgroundImageContentMode.

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

Available on crate feature UIColor only.

A color to use for the shadow. Its specific behavior depends on the value of shadowImage. If shadowImage is nil, then the shadowColor is used to color the bar’s default shadow; a nil or clearColor shadowColor will result in no shadow. If shadowImage is a template image, then the shadowColor is used to tint the image; a nil or clearColor shadowColor will also result in no shadow. If the shadowImage is not a template image, then it will be rendered regardless of the value of shadowColor.

pub unsafe fn setShadowColor(&self, shadow_color: Option<&UIColor>)

Available on crate feature UIColor only.

Setter for shadowColor.

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

Available on crate feature UIImage only.

Use an image for the shadow. See shadowColor for how they interact.

pub unsafe fn setShadowImage(&self, shadow_image: Option<&UIImage>)

Available on crate feature UIImage only.

Setter for shadowImage.

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.

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());

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 UITabBarAppearance

fn as_ref(&self) -> &AnyObject

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

impl AsRef<NSObject> for UITabBarAppearance

fn as_ref(&self) -> &NSObject

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

impl AsRef<UIBarAppearance> for UITabBarAppearance

fn as_ref(&self) -> &UIBarAppearance

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

impl AsRef<UITabBarAppearance> for UITabBarAppearance

fn as_ref(&self) -> &Self

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

impl Borrow<AnyObject> for UITabBarAppearance

fn borrow(&self) -> &AnyObject

Immutably borrows from an owned value.

impl Borrow<NSObject> for UITabBarAppearance

fn borrow(&self) -> &NSObject

Immutably borrows from an owned value.

impl Borrow<UIBarAppearance> for UITabBarAppearance

fn borrow(&self) -> &UIBarAppearance

Immutably borrows from an owned value.

impl ClassType for UITabBarAppearance

const NAME: &'static str = "UITabBarAppearance"

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

type Super = UIBarAppearance

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 CopyingHelper for UITabBarAppearance

type Result = UITabBarAppearance

The immutable counterpart of the type, or Self if the type has no immutable counterpart.

impl Debug for UITabBarAppearance

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

Formats the value using the given formatter.

impl Deref for UITabBarAppearance

type Target = UIBarAppearance

The resulting type after dereferencing.

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

Dereferences the value.

impl Hash for UITabBarAppearance

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 UITabBarAppearance

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

where Self: Sized,

Increment the reference count of the receiver.

impl NSCoding for UITabBarAppearance

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

where Self: Sized + Message,

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

where Self: Sized + Message,

impl NSCopying for UITabBarAppearance

fn copy(&self) -> Retained<Self::Result>

where Self: Sized + Message + CopyingHelper,

Returns a new instance that’s a copy of the receiver.

unsafe fn copyWithZone(&self, zone: *mut NSZone) -> Retained<Self::Result>

where Self: Sized + Message + CopyingHelper,

Returns a new instance that’s a copy of the receiver.

impl NSObjectProtocol for UITabBarAppearance

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 NSSecureCoding for UITabBarAppearance

unsafe fn supportsSecureCoding() -> bool

where Self: Sized + ClassType,

impl PartialEq for UITabBarAppearance

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 UITabBarAppearance

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

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

impl DowncastTarget for UITabBarAppearance

impl Eq for UITabBarAppearance