Struct UIListContentImageProperties

Source

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

Available on crate feature UIListContentImageProperties only.

Expand description

Apple’s documentation

Implementations§

Source §

impl UIListContentImageProperties

Source

pub unsafe fn preferredSymbolConfiguration( &self, ) -> Option<Retained<UIImageSymbolConfiguration>>

Available on crate features UIImageConfiguration and UIImageSymbolConfiguration only.

The symbol configuration to use.

Source

pub unsafe fn setPreferredSymbolConfiguration( &self, preferred_symbol_configuration: Option<&UIImageSymbolConfiguration>, )

Available on crate features UIImageConfiguration and UIImageSymbolConfiguration only.

Setter for preferredSymbolConfiguration.

Source

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

Available on crate feature UIColor only.

The tintColor to apply to the image view. Nil will use the image view’s normal inherited tintColor.

Source

pub unsafe fn setTintColor(&self, tint_color: Option<&UIColor>)

Available on crate feature UIColor only.

Setter for tintColor.

Source

pub unsafe fn tintColorTransformer(&self) -> UIConfigurationColorTransformer

Available on crate features UIColor and UIConfigurationColorTransformer and block2 only.

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

Source

pub unsafe fn setTintColorTransformer( &self, tint_color_transformer: UIConfigurationColorTransformer, )

Available on crate features UIColor and UIConfigurationColorTransformer and block2 only.

Setter for tintColorTransformer.

Source

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

Available on crate feature UIColor only.

Returns the resolved image tint color for the specified tint color of the view, based on the tintColor and tintColorTransformer.

Source

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 image. Default is 0. If the image is too small to fit the requested radius, the corner curve and radius will be adjusted to fit.

Source

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

Available on crate feature objc2-core-foundation only.

Setter for cornerRadius.

Source

pub unsafe fn maximumSize(&self) -> CGSize

Available on crate feature objc2-core-foundation only.

Enforces a maximum size for the image. The default value is CGSizeZero. A zero width or height means the size is unconstrained on that dimension. If the image exceeds this size on either dimension, its size will be reduced proportionately (maintaining aspect ratio).

Source

pub unsafe fn setMaximumSize(&self, maximum_size: CGSize)

Available on crate feature objc2-core-foundation only.

Setter for maximumSize.

Source

pub unsafe fn reservedLayoutSize(&self) -> CGSize

Available on crate feature objc2-core-foundation only.

The layout size that is reserved for the image, inside which the image will be centered. The default value is CGSizeZero. The reservedLayoutSize width & height only affect the space reserved for the image and its positioning; they do not affect the image’s size. A zero width or height means the default behavior is used for that dimension:

Symbol images will be centered inside a standard width/height that is scaled with the content size category.
Non-symbol images will use a reservedLayoutSize equal to the actual size of the displayed image. Use the UIListContentImageStandardDimension constant for the width and/or height to force the standard symbol image value to be used for that dimension, regardless of the image. This property is used to horizontally align images across adjacent content views (even when the actual image widths may vary slightly), and/or to ensure a consistent height is reserved for different images across different content views (so that the content view heights are consistent even when the actual image heights may vary slightly). The reservedLayoutSize.width is ignored by content views at Accessibility Dynamic Type sizes, and the reservedLayoutSize.height is ignored when using the special Accessibility Dynamic Type layout where text wraps around the image.

Source

pub unsafe fn setReservedLayoutSize(&self, reserved_layout_size: CGSize)

Available on crate feature objc2-core-foundation only.

Setter for reservedLayoutSize.

Source

pub unsafe fn accessibilityIgnoresInvertColors(&self) -> bool

Prevents the image from inverting its colors when the accessibility setting is enabled.

Source

pub unsafe fn setAccessibilityIgnoresInvertColors( &self, accessibility_ignores_invert_colors: bool, )

Setter for accessibilityIgnoresInvertColors.

Source

pub unsafe fn strokeWidth(&self) -> CGFloat

Available on crate feature objc2-core-foundation only.

The width of the stroke to draw around the image. Default is 0.0.

Source

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

Available on crate feature objc2-core-foundation only.

Setter for strokeWidth.

Source

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).

Source

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

Available on crate feature UIColor only.

Setter for strokeColor.

Source

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.

Source

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

Available on crate features UIColor and UIConfigurationColorTransformer and block2 only.

Setter for strokeColorTransformer.

Source

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.

Source §

impl UIListContentImageProperties

Methods declared on superclass NSObject.

Source

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

Source

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