Struct UIListContentTextProperties

Source

pub struct UIListContentTextProperties { /* private fields */ }

Available on crate feature UIListContentTextProperties only.

Expand description

Apple’s documentation

Implementations§

Source §

impl UIListContentTextProperties

Source

pub fn font(&self) -> Retained<UIFont>

Available on crate feature UIFont only.

The font used for the text.

Source

pub fn setFont(&self, font: &UIFont)

Available on crate feature UIFont only.

Setter for font.

Source

pub fn color(&self) -> Retained<UIColor>

Available on crate feature UIColor only.

The color of the text.

Source

pub fn setColor(&self, color: &UIColor)

Available on crate feature UIColor only.

Setter for color.

Source

pub unsafe fn colorTransformer(&self) -> UIConfigurationColorTransformer

Available on crate features UIColor and UIConfigurationColorTransformer and block2 only.

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

§Safety

The returned block’s argument must be a valid pointer.

Source

pub unsafe fn setColorTransformer( &self, color_transformer: UIConfigurationColorTransformer, )

Available on crate features UIColor and UIConfigurationColorTransformer and block2 only.

Setter for colorTransformer.

This is copied when set.

§Safety

color_transformer must be a valid pointer or null.

Source

pub fn resolvedColor(&self) -> Retained<UIColor>

Available on crate feature UIColor only.

Returns the resolved color, based on the color and colorTransformer.

Source

pub fn alignment(&self) -> UIListContentTextAlignment

The alignment for the text.

Source

pub fn setAlignment(&self, alignment: UIListContentTextAlignment)

Setter for alignment.

Source

pub fn lineBreakMode(&self) -> NSLineBreakMode

Available on crate feature NSParagraphStyle only.

The line break mode to use for the text.

Source

pub fn setLineBreakMode(&self, line_break_mode: NSLineBreakMode)

Available on crate feature NSParagraphStyle only.

Setter for lineBreakMode.

Source

pub fn numberOfLines(&self) -> NSInteger

The maximum number of lines for the text. 0 indicates the number of lines is unlimited.

Source

pub fn setNumberOfLines(&self, number_of_lines: NSInteger)

Setter for numberOfLines.

Source

pub fn adjustsFontSizeToFitWidth(&self) -> bool

Whether the font size of the text is automatically adjusted when necessary to fit in the available width.

Source

pub fn setAdjustsFontSizeToFitWidth(&self, adjusts_font_size_to_fit_width: bool)

Setter for adjustsFontSizeToFitWidth.

Source

pub fn minimumScaleFactor(&self) -> CGFloat

Available on crate feature objc2-core-foundation only.

When adjustsFontSizeToFitWidth is enabled, the smallest multiplier for the font size used to make the text fit.

Source

pub fn setMinimumScaleFactor(&self, minimum_scale_factor: CGFloat)

Available on crate feature objc2-core-foundation only.

Setter for minimumScaleFactor.

Source

pub fn allowsDefaultTighteningForTruncation(&self) -> bool

Whether the text is tightened before truncating.

Source

pub fn setAllowsDefaultTighteningForTruncation( &self, allows_default_tightening_for_truncation: bool, )

Setter for allowsDefaultTighteningForTruncation.

Source

pub fn adjustsFontForContentSizeCategory(&self) -> bool

Whether the font is automatically updated when the content size category changes.

Source

pub fn setAdjustsFontForContentSizeCategory( &self, adjusts_font_for_content_size_category: bool, )

Setter for adjustsFontForContentSizeCategory.

Source

pub fn showsExpansionTextWhenTruncated(&self) -> bool

Whether the full text will be shown when a pointer hovers over truncated text.

Source

pub fn setShowsExpansionTextWhenTruncated( &self, shows_expansion_text_when_truncated: bool, )

Setter for showsExpansionTextWhenTruncated.

Source

pub fn transform(&self) -> UIListContentTextTransform

A transform that is applied to the text before it is displayed.

Source

pub fn setTransform(&self, transform: UIListContentTextTransform)

Setter for transform.

Source §

impl UIListContentTextProperties

Methods declared on superclass NSObject.

Source

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

Source

pub fn new(mtm: MainThreadMarker) -> 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

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