Struct MSMessageTemplateLayout

Source

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

Available on crate features MSMessageLayout and MSMessageTemplateLayout only.

Expand description

The MSMessageTemplateLayout encapsulates properties used in the construction of UI representing a message using the default message layout template.

Implementations§

Source §

impl MSMessageTemplateLayout

Source

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

Text to be used as a caption related to the message content.

Source

pub unsafe fn setCaption(&self, caption: Option<&NSString>)

Setter for caption.

Source

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

Text to be used as a subcaption related to the message content.

Source

pub unsafe fn setSubcaption(&self, subcaption: Option<&NSString>)

Setter for subcaption.

Source

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

Text to be drawn right aligned on the same line as the caption text.

Source

pub unsafe fn setTrailingCaption(&self, trailing_caption: Option<&NSString>)

Setter for trailingCaption.

Source

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

Text to be drawn right aligned on the same line as the subcaption text.

Source

pub unsafe fn setTrailingSubcaption( &self, trailing_subcaption: Option<&NSString>, )

Setter for trailingSubcaption.

Source

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

Available on crate feature objc2-ui-kit only.

A UIImage object used to construct the message representation in the conversation transcript.

When this property and the mediaURL property are both set, the mediaURL property will be ignored.

Source

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

Available on crate feature objc2-ui-kit only.

Setter for image.

Source

pub unsafe fn mediaFileURL(&self) -> Option<Retained<NSURL>>

The URL to a media file used to construct the message representation in the conversation transcript.

This must be a file URL, the data contained in the file must conform to kUTTypeImage or kUTTypeMovie. When image property and this property are both set, then this property will be ignored.

Source

pub unsafe fn setMediaFileURL(&self, media_file_url: Option<&NSURL>)

Setter for mediaFileURL.

Source

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

Title text associated with the image or media .

Source

pub unsafe fn setImageTitle(&self, image_title: Option<&NSString>)

Setter for imageTitle.

Source

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

Subtitle text associated with the image or media .

Source

pub unsafe fn setImageSubtitle(&self, image_subtitle: Option<&NSString>)

Setter for imageSubtitle.

Source §

impl MSMessageTemplateLayout

Methods declared on superclass NSObject.

Source

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

Source

pub unsafe fn new() -> Retained<Self>

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

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.

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,

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