#[repr(C)]pub struct UIToolbarAppearance { /* private fields */ }
UIBarAppearance
and UIToolbarAppearance
only.Expand description
Implementations§
Source§impl UIToolbarAppearance
impl UIToolbarAppearance
Available on crate feature UIBarButtonItemAppearance
only.
UIBarButtonItemAppearance
only.The appearance for plain-style bar button items
Sourcepub unsafe fn setButtonAppearance(
&self,
button_appearance: &UIBarButtonItemAppearance,
)
Available on crate feature UIBarButtonItemAppearance
only.
pub unsafe fn setButtonAppearance( &self, button_appearance: &UIBarButtonItemAppearance, )
UIBarButtonItemAppearance
only.Setter for buttonAppearance
.
Sourcepub unsafe fn doneButtonAppearance(&self) -> Retained<UIBarButtonItemAppearance>
Available on crate feature UIBarButtonItemAppearance
only.
pub unsafe fn doneButtonAppearance(&self) -> Retained<UIBarButtonItemAppearance>
UIBarButtonItemAppearance
only.The appearance for done-style bar button items
Sourcepub unsafe fn setDoneButtonAppearance(
&self,
done_button_appearance: &UIBarButtonItemAppearance,
)
Available on crate feature UIBarButtonItemAppearance
only.
pub unsafe fn setDoneButtonAppearance( &self, done_button_appearance: &UIBarButtonItemAppearance, )
UIBarButtonItemAppearance
only.Setter for doneButtonAppearance
.
Source§impl UIToolbarAppearance
Methods declared on superclass UIBarAppearance
.
impl UIToolbarAppearance
Methods declared on superclass UIBarAppearance
.
Sourcepub unsafe fn init(this: Allocated<Self>) -> Retained<Self>
pub unsafe fn init(this: Allocated<Self>) -> Retained<Self>
Constructs a new bar appearance, configured with default values and targeting the device idiom.
Sourcepub unsafe fn initWithIdiom(
this: Allocated<Self>,
idiom: UIUserInterfaceIdiom,
) -> Retained<Self>
Available on crate feature UIDevice
only.
pub unsafe fn initWithIdiom( this: Allocated<Self>, idiom: UIUserInterfaceIdiom, ) -> Retained<Self>
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.
Sourcepub unsafe fn initWithBarAppearance(
this: Allocated<Self>,
bar_appearance: &UIBarAppearance,
) -> Retained<Self>
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>
Source§impl UIToolbarAppearance
Methods declared on superclass NSObject
.
impl UIToolbarAppearance
Methods declared on superclass NSObject
.
pub unsafe fn new(mtm: MainThreadMarker) -> Retained<Self>
Methods from Deref<Target = UIBarAppearance>§
Sourcepub unsafe fn idiom(&self) -> UIUserInterfaceIdiom
Available on crate feature UIDevice
only.
pub unsafe fn idiom(&self) -> UIUserInterfaceIdiom
UIDevice
only.The idiom that this appearance object targets.
pub unsafe fn copy(&self) -> Retained<Self>
Sourcepub unsafe fn configureWithDefaultBackground(&self)
pub unsafe fn configureWithDefaultBackground(&self)
Reset background and shadow properties to their defaults.
Sourcepub unsafe fn configureWithOpaqueBackground(&self)
pub unsafe fn configureWithOpaqueBackground(&self)
Reset background and shadow properties to display theme-appropriate opaque colors.
Sourcepub unsafe fn configureWithTransparentBackground(&self)
pub unsafe fn configureWithTransparentBackground(&self)
Reset background and shadow properties to be transparent.
Sourcepub unsafe fn backgroundEffect(&self) -> Option<Retained<UIBlurEffect>>
Available on crate features UIBlurEffect
and UIVisualEffect
only.
pub unsafe fn backgroundEffect(&self) -> Option<Retained<UIBlurEffect>>
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.
Sourcepub unsafe fn setBackgroundEffect(
&self,
background_effect: Option<&UIBlurEffect>,
)
Available on crate features UIBlurEffect
and UIVisualEffect
only.
pub unsafe fn setBackgroundEffect( &self, background_effect: Option<&UIBlurEffect>, )
UIBlurEffect
and UIVisualEffect
only.Setter for backgroundEffect
.
Sourcepub unsafe fn backgroundColor(&self) -> Option<Retained<UIColor>>
Available on crate feature UIColor
only.
pub unsafe fn backgroundColor(&self) -> Option<Retained<UIColor>>
UIColor
only.A color to use for the bar background. This color is composited over backgroundEffects.
Sourcepub unsafe fn setBackgroundColor(&self, background_color: Option<&UIColor>)
Available on crate feature UIColor
only.
pub unsafe fn setBackgroundColor(&self, background_color: Option<&UIColor>)
UIColor
only.Setter for backgroundColor
.
Sourcepub unsafe fn backgroundImage(&self) -> Option<Retained<UIImage>>
Available on crate feature UIImage
only.
pub unsafe fn backgroundImage(&self) -> Option<Retained<UIImage>>
UIImage
only.An image to use for the bar background. This image is composited over the backgroundColor, and resized per the backgroundImageContentMode.
Sourcepub unsafe fn setBackgroundImage(&self, background_image: Option<&UIImage>)
Available on crate feature UIImage
only.
pub unsafe fn setBackgroundImage(&self, background_image: Option<&UIImage>)
UIImage
only.Setter for backgroundImage
.
Sourcepub unsafe fn backgroundImageContentMode(&self) -> UIViewContentMode
Available on crate feature UIView
only.
pub unsafe fn backgroundImageContentMode(&self) -> UIViewContentMode
UIView
only.The content mode to use when rendering the backgroundImage. Defaults to UIViewContentModeScaleToFill. UIViewContentModeRedraw will be reinterpreted as UIViewContentModeScaleToFill.
Sourcepub unsafe fn setBackgroundImageContentMode(
&self,
background_image_content_mode: UIViewContentMode,
)
Available on crate feature UIView
only.
pub unsafe fn setBackgroundImageContentMode( &self, background_image_content_mode: UIViewContentMode, )
UIView
only.Setter for backgroundImageContentMode
.
Sourcepub unsafe fn shadowColor(&self) -> Option<Retained<UIColor>>
Available on crate feature UIColor
only.
pub unsafe fn shadowColor(&self) -> Option<Retained<UIColor>>
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.
Sourcepub unsafe fn setShadowColor(&self, shadow_color: Option<&UIColor>)
Available on crate feature UIColor
only.
pub unsafe fn setShadowColor(&self, shadow_color: Option<&UIColor>)
UIColor
only.Setter for shadowColor
.
Sourcepub unsafe fn shadowImage(&self) -> Option<Retained<UIImage>>
Available on crate feature UIImage
only.
pub unsafe fn shadowImage(&self) -> Option<Retained<UIImage>>
UIImage
only.Use an image for the shadow. See shadowColor for how they interact.
Sourcepub unsafe fn setShadowImage(&self, shadow_image: Option<&UIImage>)
Available on crate feature UIImage
only.
pub unsafe fn setShadowImage(&self, shadow_image: Option<&UIImage>)
UIImage
only.Setter for shadowImage
.
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 UIIndirectScribbleInteraction
only.
pub fn class(&self) -> &'static AnyClass
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());
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 UIIndirectScribbleInteraction
only.
pub unsafe fn get_ivar<T>(&self, name: &str) -> &Twhere
T: Encode,
Ivar::load
instead.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.
Sourcepub fn downcast_ref<T>(&self) -> Option<&T>where
T: DowncastTarget,
Available on crate feature UIIndirectScribbleInteraction
only.
pub fn downcast_ref<T>(&self) -> Option<&T>where
T: DowncastTarget,
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§
Source§impl AsRef<AnyObject> for UIToolbarAppearance
impl AsRef<AnyObject> for UIToolbarAppearance
Source§impl AsRef<NSObject> for UIToolbarAppearance
impl AsRef<NSObject> for UIToolbarAppearance
Source§impl AsRef<UIBarAppearance> for UIToolbarAppearance
impl AsRef<UIBarAppearance> for UIToolbarAppearance
Source§fn as_ref(&self) -> &UIBarAppearance
fn as_ref(&self) -> &UIBarAppearance
Source§impl Borrow<AnyObject> for UIToolbarAppearance
impl Borrow<AnyObject> for UIToolbarAppearance
Source§impl Borrow<NSObject> for UIToolbarAppearance
impl Borrow<NSObject> for UIToolbarAppearance
Source§impl Borrow<UIBarAppearance> for UIToolbarAppearance
impl Borrow<UIBarAppearance> for UIToolbarAppearance
Source§fn borrow(&self) -> &UIBarAppearance
fn borrow(&self) -> &UIBarAppearance
Source§impl ClassType for UIToolbarAppearance
impl ClassType for UIToolbarAppearance
Source§const NAME: &'static str = "UIToolbarAppearance"
const NAME: &'static str = "UIToolbarAppearance"
Source§type Super = UIBarAppearance
type Super = UIBarAppearance
Source§type ThreadKind = dyn MainThreadOnly
type ThreadKind = dyn MainThreadOnly
Source§impl CopyingHelper for UIToolbarAppearance
impl CopyingHelper for UIToolbarAppearance
Source§type Result = UIToolbarAppearance
type Result = UIToolbarAppearance
Self
if the type has no
immutable counterpart. Read moreSource§impl Debug for UIToolbarAppearance
impl Debug for UIToolbarAppearance
Source§impl Deref for UIToolbarAppearance
impl Deref for UIToolbarAppearance
Source§impl Hash for UIToolbarAppearance
impl Hash for UIToolbarAppearance
Source§impl Message for UIToolbarAppearance
impl Message for UIToolbarAppearance
Source§impl NSCoding for UIToolbarAppearance
impl NSCoding for UIToolbarAppearance
Source§impl NSCopying for UIToolbarAppearance
impl NSCopying for UIToolbarAppearance
Source§impl NSObjectProtocol for UIToolbarAppearance
impl NSObjectProtocol for UIToolbarAppearance
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 NSSecureCoding for UIToolbarAppearance
impl NSSecureCoding for UIToolbarAppearance
Source§impl PartialEq for UIToolbarAppearance
impl PartialEq for UIToolbarAppearance
Source§impl RefEncode for UIToolbarAppearance
impl RefEncode for UIToolbarAppearance
Source§const ENCODING_REF: Encoding = <UIBarAppearance as ::objc2::RefEncode>::ENCODING_REF
const ENCODING_REF: Encoding = <UIBarAppearance as ::objc2::RefEncode>::ENCODING_REF
impl DowncastTarget for UIToolbarAppearance
impl Eq for UIToolbarAppearance
Auto Trait Implementations§
impl !Freeze for UIToolbarAppearance
impl !RefUnwindSafe for UIToolbarAppearance
impl !Send for UIToolbarAppearance
impl !Sync for UIToolbarAppearance
impl !Unpin for UIToolbarAppearance
impl !UnwindSafe for UIToolbarAppearance
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