Struct UIContentUnavailableConfiguration

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

Available on crate feature UIContentUnavailableConfiguration only.

Apple’s documentation

Implementations

impl UIContentUnavailableConfiguration

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

Returns the default configuration for unavailable content.

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

Returns the default configuration for content which is loading.

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

Returns the default configuration for searches which return no results.

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

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

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

Available on crate feature UIImage only.

The image to display.

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

Available on crate feature UIImage only.

Setter for image.

pub unsafe fn imageProperties( &self, ) -> Retained<UIContentUnavailableImageProperties>

Available on crate feature UIContentUnavailableImageProperties only.

Additional properties to configure the image. When adopting the loading configuration, relevant properties are applied to the activity indicator.

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

The primary text.

pub unsafe fn setText(&self, text: Option<&NSString>)

Setter for text.

pub unsafe fn attributedText(&self) -> Option<Retained<NSAttributedString>>

An attributed variant of the primary text, which supersedes the text and some properties of the textProperties if set.

pub unsafe fn setAttributedText( &self, attributed_text: Option<&NSAttributedString>, )

Setter for attributedText.

pub unsafe fn textProperties( &self, ) -> Retained<UIContentUnavailableTextProperties>

Available on crate feature UIContentUnavailableTextProperties only.

Additional properties to configure the primary text.

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

The secondary text.

pub unsafe fn setSecondaryText(&self, secondary_text: Option<&NSString>)

Setter for secondaryText.

pub unsafe fn secondaryAttributedText( &self, ) -> Option<Retained<NSAttributedString>>

An attributed variant of the secondary text, which supersedes the secondaryText and some properties of the secondaryTextProperties if set.

pub unsafe fn setSecondaryAttributedText( &self, secondary_attributed_text: Option<&NSAttributedString>, )

Setter for secondaryAttributedText.

pub unsafe fn secondaryTextProperties( &self, ) -> Retained<UIContentUnavailableTextProperties>

Available on crate feature UIContentUnavailableTextProperties only.

Additional properties to configure the secondary text.

pub unsafe fn button(&self) -> Retained<UIButtonConfiguration>

Available on crate feature UIButtonConfiguration only.

The primary button.

pub unsafe fn setButton(&self, button: &UIButtonConfiguration)

Available on crate feature UIButtonConfiguration only.

Setter for button.

pub unsafe fn buttonProperties( &self, ) -> Retained<UIContentUnavailableButtonProperties>

Available on crate feature UIContentUnavailableButtonProperties only.

Additional properties to configure the primary button.

pub unsafe fn secondaryButton(&self) -> Retained<UIButtonConfiguration>

Available on crate feature UIButtonConfiguration only.

The secondary button.

pub unsafe fn setSecondaryButton( &self, secondary_button: &UIButtonConfiguration, )

Available on crate feature UIButtonConfiguration only.

Setter for secondaryButton.

pub unsafe fn secondaryButtonProperties( &self, ) -> Retained<UIContentUnavailableButtonProperties>

Available on crate feature UIContentUnavailableButtonProperties only.

Additional properties to configure the secondary button.

pub unsafe fn alignment(&self) -> UIContentUnavailableAlignment

The alignment of the image, text and buttons.

pub unsafe fn setAlignment(&self, alignment: UIContentUnavailableAlignment)

Setter for alignment.

pub unsafe fn axesPreservingSuperviewLayoutMargins(&self) -> UIAxis

Available on crate feature UIGeometry only.

Whether the content view will preserve inherited layout margins from its superview on the horizontal and/or vertical axes.

pub unsafe fn setAxesPreservingSuperviewLayoutMargins( &self, axes_preserving_superview_layout_margins: UIAxis, )

Available on crate feature UIGeometry only.

Setter for axesPreservingSuperviewLayoutMargins.

pub unsafe fn directionalLayoutMargins(&self) -> NSDirectionalEdgeInsets

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

The margins for the content to the edges of the content view. (When preserving superview layout margins on one or both axes, these are just minimum margins, as inherited margins may be larger.)

pub unsafe fn setDirectionalLayoutMargins( &self, directional_layout_margins: NSDirectionalEdgeInsets, )

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

Setter for directionalLayoutMargins.

pub unsafe fn imageToTextPadding(&self) -> CGFloat

Available on crate feature objc2-core-foundation only.

Padding between the image and text. Only applies when there is both an image and text.

pub unsafe fn setImageToTextPadding(&self, image_to_text_padding: CGFloat)

Available on crate feature objc2-core-foundation only.

Setter for imageToTextPadding.

pub unsafe fn textToSecondaryTextPadding(&self) -> CGFloat

Available on crate feature objc2-core-foundation only.

Padding between the text and secondary text. Only applies when there is both text and secondary text.

pub unsafe fn setTextToSecondaryTextPadding( &self, text_to_secondary_text_padding: CGFloat, )

Available on crate feature objc2-core-foundation only.

Setter for textToSecondaryTextPadding.

pub unsafe fn textToButtonPadding(&self) -> CGFloat

Available on crate feature objc2-core-foundation only.

Padding between the button and text. Only applies when there is both a button and text.

pub unsafe fn setTextToButtonPadding(&self, text_to_button_padding: CGFloat)

Available on crate feature objc2-core-foundation only.

Setter for textToButtonPadding.

pub unsafe fn buttonToSecondaryButtonPadding(&self) -> CGFloat

Available on crate feature objc2-core-foundation only.

Padding between the button and secondary button. Only applies when there is both a button and a secondary button.

pub unsafe fn setButtonToSecondaryButtonPadding( &self, button_to_secondary_button_padding: CGFloat, )

Available on crate feature objc2-core-foundation only.

Setter for buttonToSecondaryButtonPadding.

pub unsafe fn background(&self) -> Retained<UIBackgroundConfiguration>

Available on crate feature UIBackgroundConfiguration only.

The background configuration.

pub unsafe fn setBackground(&self, background: &UIBackgroundConfiguration)

Available on crate feature UIBackgroundConfiguration only.

Setter for background.

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 UIContentUnavailableConfiguration

fn as_ref(&self) -> &AnyObject

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

impl AsRef<NSObject> for UIContentUnavailableConfiguration

fn as_ref(&self) -> &NSObject

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

impl AsRef<UIContentUnavailableConfiguration> for UIContentUnavailableConfiguration

fn as_ref(&self) -> &Self

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

impl Borrow<AnyObject> for UIContentUnavailableConfiguration

fn borrow(&self) -> &AnyObject

Immutably borrows from an owned value.

impl Borrow<NSObject> for UIContentUnavailableConfiguration

fn borrow(&self) -> &NSObject

Immutably borrows from an owned value.

impl ClassType for UIContentUnavailableConfiguration

const NAME: &'static str = "UIContentUnavailableConfiguration"

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 UIContentUnavailableConfiguration

type Result = UIContentUnavailableConfiguration

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

impl Debug for UIContentUnavailableConfiguration

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

Formats the value using the given formatter.

impl Deref for UIContentUnavailableConfiguration

type Target = NSObject

The resulting type after dereferencing.

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

Dereferences the value.

impl Hash for UIContentUnavailableConfiguration

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 UIContentUnavailableConfiguration

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

where Self: Sized,

Increment the reference count of the receiver.

impl NSCoding for UIContentUnavailableConfiguration

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 UIContentUnavailableConfiguration

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 UIContentUnavailableConfiguration

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 UIContentUnavailableConfiguration

unsafe fn supportsSecureCoding() -> bool

where Self: Sized + ClassType,

impl PartialEq for UIContentUnavailableConfiguration

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 UIContentUnavailableConfiguration

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

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

impl UIContentConfiguration for UIContentUnavailableConfiguration

unsafe fn makeContentView(&self) -> Retained<UIView>

where Self: Sized + Message,

Available on crate features UIResponder and UIView and UIContentConfiguration only.

Initializes and returns a new instance of the content view using this configuration.

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

where Self: Sized + Message,

Available on crate features UIContentConfiguration and 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.

impl DowncastTarget for UIContentUnavailableConfiguration

impl Eq for UIContentUnavailableConfiguration