Struct UINavigationBarAppearance

Source

pub struct UINavigationBarAppearance { /* private fields */ }

Available on crate features UIBarAppearance and UINavigationBarAppearance only.

Expand description

Apple’s documentation

Implementations§

Source §

impl UINavigationBarAppearance

Source

pub fn titleTextAttributes( &self, ) -> Retained<NSDictionary<NSAttributedStringKey, AnyObject>>

Inline Title text attributes. If the font or color are unspecified, appropriate defaults are supplied.

Source

pub unsafe fn setTitleTextAttributes( &self, title_text_attributes: &NSDictionary<NSAttributedStringKey, AnyObject>, )

Setter for titleTextAttributes.

This is copied when set.

§Safety

title_text_attributes generic should be of the correct type.

Source

pub fn titlePositionAdjustment(&self) -> UIOffset

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

An additional adjustment to the inline title’s position.

Source

pub fn setTitlePositionAdjustment(&self, title_position_adjustment: UIOffset)

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

Setter for titlePositionAdjustment.

Source

pub fn subtitleTextAttributes( &self, ) -> Retained<NSDictionary<NSAttributedStringKey, AnyObject>>

The default text attributes to apply to the subtitle rendered in the navigation bar.

Source

pub unsafe fn setSubtitleTextAttributes( &self, subtitle_text_attributes: &NSDictionary<NSAttributedStringKey, AnyObject>, )

Setter for subtitleTextAttributes.

This is copied when set.

§Safety

subtitle_text_attributes generic should be of the correct type.

Source

pub fn largeTitleTextAttributes( &self, ) -> Retained<NSDictionary<NSAttributedStringKey, AnyObject>>

Large Title text attributes. If the font or color are unspecified, appropriate defaults are supplied.

Source

pub unsafe fn setLargeTitleTextAttributes( &self, large_title_text_attributes: &NSDictionary<NSAttributedStringKey, AnyObject>, )

Setter for largeTitleTextAttributes.

This is copied when set.

§Safety

large_title_text_attributes generic should be of the correct type.

Source

pub fn largeSubtitleTextAttributes( &self, ) -> Retained<NSDictionary<NSAttributedStringKey, AnyObject>>

The default text attributes to apply to the subtitle when it’s rendered under the large title.

Source

pub unsafe fn setLargeSubtitleTextAttributes( &self, large_subtitle_text_attributes: &NSDictionary<NSAttributedStringKey, AnyObject>, )

Setter for largeSubtitleTextAttributes.

This is copied when set.

§Safety

large_subtitle_text_attributes generic should be of the correct type.

Source

pub fn buttonAppearance(&self) -> Retained<UIBarButtonItemAppearance>

Available on crate feature UIBarButtonItemAppearance only.

The appearance for plain-style bar button items

Source

pub fn setButtonAppearance(&self, button_appearance: &UIBarButtonItemAppearance)

Available on crate feature UIBarButtonItemAppearance only.

Setter for buttonAppearance.

This is copied when set.

Source

pub fn prominentButtonAppearance(&self) -> Retained<UIBarButtonItemAppearance>

Available on crate feature UIBarButtonItemAppearance only.

The appearance attributes for Prominent buttons.

Use this property to configure the appearance of bar button items that use UIBarButtonItemStyleProminent. If the navigation bar doesn’t have any buttons using this style, this property has no effect.

Source

pub fn setProminentButtonAppearance( &self, prominent_button_appearance: &UIBarButtonItemAppearance, )

Available on crate feature UIBarButtonItemAppearance only.

Setter for prominentButtonAppearance.

This is copied when set.

Source

pub fn backButtonAppearance(&self) -> Retained<UIBarButtonItemAppearance>

Available on crate feature UIBarButtonItemAppearance only.

The appearance for back buttons. Defaults are drawn from buttonAppearance when appropriate.

Source

pub fn setBackButtonAppearance( &self, back_button_appearance: &UIBarButtonItemAppearance, )

Available on crate feature UIBarButtonItemAppearance only.

Setter for backButtonAppearance.

This is copied when set.

Source

pub fn backIndicatorImage(&self) -> Retained<UIImage>

Available on crate feature UIImage only.

The image shown on the leading edge of the back button.

Source

pub fn backIndicatorTransitionMaskImage(&self) -> Retained<UIImage>

Available on crate feature UIImage only.

This image is used to mask content flowing underneath the backIndicatorImage during push & pop transitions

Source

pub fn setBackIndicatorImage_transitionMaskImage( &self, back_indicator_image: Option<&UIImage>, back_indicator_transition_mask_image: Option<&UIImage>, )

Available on crate feature UIImage only.

Set the backIndicatorImage & backIndicatorTransitionMaskImage images. If either image is nil, then both images will be reset to their default.

Source

pub fn doneButtonAppearance(&self) -> Retained<UIBarButtonItemAppearance>

👎Deprecated

Available on crate feature UIBarButtonItemAppearance only.

The appearance for done-style bar button items

Source

pub fn setDoneButtonAppearance( &self, done_button_appearance: &UIBarButtonItemAppearance, )

👎Deprecated

Available on crate feature UIBarButtonItemAppearance only.

Setter for doneButtonAppearance.

This is copied when set.

Source §

impl UINavigationBarAppearance

Methods declared on superclass UIBarAppearance.

Source

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

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

Source

pub 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.

Source

pub 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.

Source

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

§Safety

coder possibly has further requirements.

Source §

impl UINavigationBarAppearance

Methods declared on superclass NSObject.

Source

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

Methods from Deref<Target = UIBarAppearance>§

Source

pub fn idiom(&self) -> UIUserInterfaceIdiom

Available on crate feature UIDevice only.

The idiom that this appearance object targets.

Source

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

Source

pub fn configureWithDefaultBackground(&self)

Reset background and shadow properties to their defaults.

Source

pub fn configureWithOpaqueBackground(&self)

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

Source

pub fn configureWithTransparentBackground(&self)

Reset background and shadow properties to be transparent.

Source

pub 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.

Source

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

Available on crate features UIBlurEffect and UIVisualEffect only.

Setter for backgroundEffect.

This is copied when set.

Source

pub 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.

Source

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

Available on crate feature UIColor only.

Setter for backgroundColor.

This is copied when set.

Source

pub 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.

Source

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

Available on crate feature UIImage only.

Setter for backgroundImage.

Source

pub 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.

Source

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

Available on crate feature UIView only.

Setter for backgroundImageContentMode.

Source

pub 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.

Source

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

Available on crate feature UIColor only.

Setter for shadowColor.

This is copied when set.

Source

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

Available on crate feature UIImage only.

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

Source

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

Available on crate feature UIImage only.

Setter for shadowImage.

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