Struct UIPointerStyle

Source

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

Available on crate features UIHoverStyle and UIPointerStyle only.

Expand description

Apple’s documentation

Implementations§

Source §

impl UIPointerStyle

Source

pub unsafe fn accessories(&self) -> Retained<NSArray<UIPointerAccessory>>

Available on crate feature UIPointerAccessory only.

Accessories to display alongside this UIPointerStyle. Supports up to 4 accessories. The system will attempt to animate between neighboring or similar accessories.

Source

pub unsafe fn setAccessories(&self, accessories: &NSArray<UIPointerAccessory>)

Available on crate feature UIPointerAccessory only.

Setter for accessories.

Source

pub unsafe fn styleWithEffect_shape( effect: &UIPointerEffect, shape: Option<&UIPointerShape>, ) -> Retained<Self>

Applies the provided content effect and pointer shape within the current region.

Parameter effect: The desired pointer effect.

Parameter shape: The desired pointer shape. If omitted, a pointer will be generated automatically from the effect’s preview view.

Source

pub unsafe fn styleWithShape_constrainedAxes( shape: &UIPointerShape, axes: UIAxis, ) -> Retained<Self>

Available on crate feature UIGeometry only.

Morphs the pointer into the provided shape when hovering over the current region.

Parameter shape: The desired pointer shape.

Parameter axes: Axes along which to recenter the pointer on touch up.

Source

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

Hides the pointer when hovering over the current region.

Source

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

Pointer style that displays an unconstrained system pointer. Use this to display accessories alongside the default pointer.

Source

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

Source

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

Source §

impl UIPointerStyle

Methods declared on superclass UIHoverStyle.

Source

pub unsafe fn styleWithShape( shape: Option<&UIShape>, mtm: MainThreadMarker, ) -> Retained<Self>

Available on crate feature UIShape only.

Creates a hover style with the provided shape and a UIHoverAutomaticEffect.

Source

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

Creates a hover style with the default shape and a UIHoverAutomaticEffect.

Methods from Deref<Target = UIHoverStyle>§

Source

pub unsafe fn effect(&self) -> Retained<ProtocolObject<dyn UIHoverEffect>>

Available on crate feature UIHoverEffect only.

The effect to apply to the view with this style. Use UIHoverAutomaticEffect to apply a system-default effect to the view.

Source

pub unsafe fn setEffect(&self, effect: &ProtocolObject<dyn UIHoverEffect>)

Available on crate feature UIHoverEffect only.

Setter for effect.

Source

pub unsafe fn shape(&self) -> Option<Retained<UIShape>>

Available on crate feature UIShape only.

The shape to use for the hover effect. If a nil shape is used, a system-default shape will be chosen based on the view.

Source

pub unsafe fn setShape(&self, shape: Option<&UIShape>)

Available on crate feature UIShape only.

Setter for shape.

Source

pub unsafe fn isEnabled(&self) -> bool

Whether the effect to apply to the view with this style is enabled. Use this property to temporarily disable a view’s hover effect without removing it from the view entirely.

Source

pub unsafe fn setEnabled(&self, enabled: bool)

Setter for isEnabled.

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