Struct UIBackgroundConfiguration

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

Available on crate feature UIBackgroundConfiguration only.

Apple’s documentation

Implementations

impl UIBackgroundConfiguration

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

Returns a clear configuration, with no default styling.

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

Represents a generic cell background configuration that automatically adopts the style of a containing list when updated for a new configuration state, by reading the listEnvironment trait from the state’s trait collection. Defaults to the background configuration for a cell in a plain-style list.

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

Represents a generic header background configuration that automatically adopts the style of a containing list when updated for a new configuration state, by reading the listEnvironment trait from the state’s trait collection. Defaults to the background configuration for a header in a plain-style list.

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

Represents a generic footer background configuration that automatically adopts the style of a containing list when updated for a new configuration state, by reading the listEnvironment trait from the state’s trait collection. Defaults to the background configuration for a footer in a plain-style list.

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

Returns the default configuration for an accompanied sidebar list cell.

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

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

pub unsafe fn updatedConfigurationForState( &self, state: &ProtocolObject<dyn UIConfigurationState>, ) -> Retained<Self>

Available on crate feature UIConfigurationState only.

Returns a copy of the configuration updated for the specified state, by applying the configuration’s default values for that state to any properties that have not been customized.

pub unsafe fn customView(&self) -> Option<Retained<UIView>>

Available on crate features UIResponder and UIView only.

A custom view for the background. The custom view must have translatesAutoresizingMaskIntoConstraints enabled, but may use auto layout constraints internally for layout of subviews.

pub unsafe fn setCustomView(&self, custom_view: Option<&UIView>)

Available on crate features UIResponder and UIView only.

Setter for customView.

pub unsafe fn cornerRadius(&self) -> CGFloat

Available on crate feature objc2-core-foundation only.

The preferred corner radius (using a continuous corner curve) for the background and stroke. This is also applied to the custom view. Default is 0. If the view is too small to fit the requested radius, the corner curve and radius will be adjusted to fit.

pub unsafe fn setCornerRadius(&self, corner_radius: CGFloat)

Available on crate feature objc2-core-foundation only.

Setter for cornerRadius.

pub unsafe fn backgroundInsets(&self) -> NSDirectionalEdgeInsets

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

Insets (or outsets, if negative) for the background and stroke, relative to the edges of the containing view. These also apply to the custom view. Default is NSDirectionalEdgeInsetsZero.

pub unsafe fn setBackgroundInsets( &self, background_insets: NSDirectionalEdgeInsets, )

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

Setter for backgroundInsets.

pub unsafe fn edgesAddingLayoutMarginsToBackgroundInsets( &self, ) -> NSDirectionalRectEdge

Available on crate feature UIGeometry only.

The edges on which the containing view’s layout margins are added to the backgroundInsets, effectively making the backgroundInsets values relative to the containing view’s layout margins for these edges. Default is NSDirectionalRectEdgeNone.

pub unsafe fn setEdgesAddingLayoutMarginsToBackgroundInsets( &self, edges_adding_layout_margins_to_background_insets: NSDirectionalRectEdge, )

Available on crate feature UIGeometry only.

Setter for edgesAddingLayoutMarginsToBackgroundInsets.

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

Available on crate feature UIColor only.

Configures the color of the background. A nil value uses the view’s tint color; use clearColor for no color (transparent).

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

Available on crate feature UIColor only.

Setter for backgroundColor.

pub unsafe fn backgroundColorTransformer( &self, ) -> UIConfigurationColorTransformer

Available on crate features UIColor and UIConfigurationColorTransformer and block2 only.

Optional color transformer that is used to resolve the background color. A nil value means the backgroundColor is used as-is.

pub unsafe fn setBackgroundColorTransformer( &self, background_color_transformer: UIConfigurationColorTransformer, )

Available on crate features UIColor and UIConfigurationColorTransformer and block2 only.

Setter for backgroundColorTransformer.

pub unsafe fn resolvedBackgroundColorForTintColor( &self, tint_color: &UIColor, ) -> Retained<UIColor>

Available on crate feature UIColor only.

Returns the resolved background color for the specified tint color, based on the backgroundColor and backgroundColorTransformer.

pub unsafe fn visualEffect(&self) -> Option<Retained<UIVisualEffect>>

Available on crate feature UIVisualEffect only.

The visual effect to apply to the background. Default is nil.

pub unsafe fn setVisualEffect(&self, visual_effect: Option<&UIVisualEffect>)

Available on crate feature UIVisualEffect only.

Setter for visualEffect.

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

Available on crate feature UIImage only.

The image to use. Default is nil.

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

Available on crate feature UIImage only.

Setter for image.

pub unsafe fn imageContentMode(&self) -> UIViewContentMode

Available on crate feature UIView only.

The content mode to use when rendering the image. Default is UIViewContentModeScaleToFill.

pub unsafe fn setImageContentMode(&self, image_content_mode: UIViewContentMode)

Available on crate feature UIView only.

Setter for imageContentMode.

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

Available on crate feature UIColor only.

Configures the color of the stroke. A nil value uses the view’s tint color; use clearColor for no color (transparent).

pub unsafe fn setStrokeColor(&self, stroke_color: Option<&UIColor>)

Available on crate feature UIColor only.

Setter for strokeColor.

pub unsafe fn strokeColorTransformer(&self) -> UIConfigurationColorTransformer

Available on crate features UIColor and UIConfigurationColorTransformer and block2 only.

Optional color transformer that is used to resolve the stroke color. A nil value means the strokeColor is used as-is.

pub unsafe fn setStrokeColorTransformer( &self, stroke_color_transformer: UIConfigurationColorTransformer, )

Available on crate features UIColor and UIConfigurationColorTransformer and block2 only.

Setter for strokeColorTransformer.

pub unsafe fn resolvedStrokeColorForTintColor( &self, tint_color: &UIColor, ) -> Retained<UIColor>

Available on crate feature UIColor only.

Returns the resolved stroke color for the specified tint color, based on the strokeColor and strokeColorTransformer.

pub unsafe fn strokeWidth(&self) -> CGFloat

Available on crate feature objc2-core-foundation only.

The width of the stroke. Default is 0.

pub unsafe fn setStrokeWidth(&self, stroke_width: CGFloat)

Available on crate feature objc2-core-foundation only.

Setter for strokeWidth.

pub unsafe fn strokeOutset(&self) -> CGFloat

Available on crate feature objc2-core-foundation only.

Outset (or inset, if negative) for the stroke, relative to the background (including any backgroundInsets). Default is 0. The corner radius of the stroke is adjusted for any outset to remain concentric with the background.

pub unsafe fn setStrokeOutset(&self, stroke_outset: CGFloat)

Available on crate feature objc2-core-foundation only.

Setter for strokeOutset.

pub unsafe fn shadowProperties(&self) -> Retained<UIShadowProperties>

Available on crate feature UIShadowProperties only.

Describes a shadow applied by the background. Defaults to no shadow (i.e. a shadow with an opacity of 0.0).

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

👎Deprecated

Returns the default configuration for a plain list cell.

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

👎Deprecated

Returns the default configuration for a grouped list cell.

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

👎Deprecated

Returns the default configuration for a sidebar list cell.

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

👎Deprecated: Use +listHeaderConfiguration or +listFooterConfiguration

Returns the default configuration for a plain list header or footer.

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

👎Deprecated: Use +listHeaderConfiguration or +listFooterConfiguration

Returns the default configuration for a grouped list header or footer.

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

👎Deprecated: Use +listHeaderConfiguration or +listFooterConfiguration

Returns the default configuration for a sidebar list header.

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 UIBackgroundConfiguration

fn as_ref(&self) -> &AnyObject

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

impl AsRef<NSObject> for UIBackgroundConfiguration

fn as_ref(&self) -> &NSObject

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

impl AsRef<UIBackgroundConfiguration> for UIBackgroundConfiguration

fn as_ref(&self) -> &Self

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

impl Borrow<AnyObject> for UIBackgroundConfiguration

fn borrow(&self) -> &AnyObject

Immutably borrows from an owned value.

impl Borrow<NSObject> for UIBackgroundConfiguration

fn borrow(&self) -> &NSObject

Immutably borrows from an owned value.

impl ClassType for UIBackgroundConfiguration

const NAME: &'static str = "UIBackgroundConfiguration"

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

type Super = NSObject

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 UIBackgroundConfiguration

type Result = UIBackgroundConfiguration

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

impl Debug for UIBackgroundConfiguration

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

Formats the value using the given formatter.

impl Deref for UIBackgroundConfiguration

type Target = NSObject

The resulting type after dereferencing.

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

Dereferences the value.

impl Hash for UIBackgroundConfiguration

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 UIBackgroundConfiguration

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

where Self: Sized,

Increment the reference count of the receiver.

impl NSCoding for UIBackgroundConfiguration

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 UIBackgroundConfiguration

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 UIBackgroundConfiguration

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 UIBackgroundConfiguration

unsafe fn supportsSecureCoding() -> bool

where Self: Sized + ClassType,

impl PartialEq for UIBackgroundConfiguration

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 UIBackgroundConfiguration

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

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

impl DowncastTarget for UIBackgroundConfiguration

impl Eq for UIBackgroundConfiguration