Struct UIHoverEffectLayer

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

Available on crate feature UIHoverEffectLayer and crate feature objc2-quartz-core and non-watchOS only.

A layer type that can be used to apply a hover effect to its sublayers.

This layer type is useful for adding hover effects to an existing CALayer hierarchy. Where possible, use UIView.hoverStyle instead.

A UIHoverEffectLayer is configured with:

1. A container UIView, which is used to infer some properties of the hover effect from its trait collection and to allow some aspects of the hover effect to behave correctly. This view’s layer should be an ancestor layer of the UIHoverEffectLayer.
2. A UIHoverStyle, which describes the effect to use and the shape of that effect. You then add your content layers that should receive a hover effect as sublayers of this layer.

UIHoverEffectLayer may add its own internal sublayers as background or overlay layers relative to your content sublayers. To preserve the correct appearance of the effect, these internal sublayers are automatically sorted accordingly within the layer’s layout pass. As such, do not assume that the indices of your content sublayers will remain stable throughout the lifetime of the layer.

• Note: Not all UIHoverStyles may be supported by UIHoverEffectLayer. If the provided style is not supported, a fallback style will be selected instead.

See also Apple’s documentation

Implementations

impl UIHoverEffectLayer

pub unsafe fn hoverStyle(&self) -> Retained<UIHoverStyle>

Available on crate feature UIHoverStyle only.

The hover style to apply to the sublayers of this layer when this layer is hovered (e.g., when the user looks at this layer). Defaults to the automatic style.

• Note: Not all UIHoverStyles may be supported by UIHoverEffectLayer. If the provided style is not supported, a fallback style will be selected instead.

pub unsafe fn setHoverStyle(&self, hover_style: &UIHoverStyle)

Available on crate feature UIHoverStyle only.

Setter for hoverStyle.

pub unsafe fn containerView(&self) -> Option<Retained<UIView>>

Available on crate features UIResponder and UIView only.

The UIView in which this layer is contained. This view is used to derive traits and other properties for applying the correct hover effect to the layer. It may also be used to assist with applying some kinds of hover effects to the layer.

The containerView should be an ancestor of this layer (once it has been added to a layer hierarchy) to behave correctly, but does not need to be the immediate parent of this layer. If the containerView is set to nil or is deallocated, some aspects of this layer’s hover effect may no longer work correctly.

pub unsafe fn setContainerView(&self, container_view: Option<&UIView>)

Available on crate features UIResponder and UIView only.

This is a weak property. Setter for containerView.

pub unsafe fn initWithContainerView_style( this: Allocated<Self>, container_view: &UIView, style: Option<&UIHoverStyle>, ) -> Retained<Self>

Available on crate features UIHoverStyle and UIResponder and UIView only.

Creates a UIHoverEffectLayer with the provided containerView and style. If a nil style is provided, the automatic style will be used instead.

impl UIHoverEffectLayer

Methods declared on superclass CALayer.

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

Layer creation and initialization. *

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

pub unsafe fn initWithLayer( this: Allocated<Self>, layer: &AnyObject, ) -> Retained<Self>

impl UIHoverEffectLayer

Methods declared on superclass NSObject.

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

Methods from Deref<Target = CALayer>

pub unsafe fn presentationLayer(&self) -> Option<Retained<CALayer>>

pub unsafe fn modelLayer(&self) -> Retained<CALayer>

pub unsafe fn shouldArchiveValueForKey(&self, key: &NSString) -> bool

pub fn bounds(&self) -> CGRect

Geometry and layer hierarchy properties. *

pub fn setBounds(&self, bounds: CGRect)

Setter for bounds.

pub fn position(&self) -> CGPoint

pub fn setPosition(&self, position: CGPoint)

Setter for position.

pub fn zPosition(&self) -> f64

pub fn setZPosition(&self, z_position: f64)

Setter for zPosition.

pub fn anchorPoint(&self) -> CGPoint

pub fn setAnchorPoint(&self, anchor_point: CGPoint)

Setter for anchorPoint.

pub fn anchorPointZ(&self) -> f64

pub fn setAnchorPointZ(&self, anchor_point_z: f64)

Setter for anchorPointZ.

pub fn transform(&self) -> CATransform3D

pub fn setTransform(&self, transform: CATransform3D)

Setter for transform.

pub fn affineTransform(&self) -> CGAffineTransform

pub fn setAffineTransform(&self, m: CGAffineTransform)

pub fn frame(&self) -> CGRect

pub fn setFrame(&self, frame: CGRect)

Setter for frame.

pub fn isHidden(&self) -> bool

pub fn setHidden(&self, hidden: bool)

Setter for isHidden.

pub fn isDoubleSided(&self) -> bool

pub fn setDoubleSided(&self, double_sided: bool)

Setter for isDoubleSided.

pub fn isGeometryFlipped(&self) -> bool

pub fn setGeometryFlipped(&self, geometry_flipped: bool)

Setter for isGeometryFlipped.

pub fn contentsAreFlipped(&self) -> bool

pub fn superlayer(&self) -> Option<Retained<CALayer>>

pub fn removeFromSuperlayer(&self)

pub unsafe fn sublayers(&self) -> Option<Retained<NSArray<CALayer>>>

pub unsafe fn setSublayers(&self, sublayers: Option<&NSArray<CALayer>>)

Setter for sublayers.

pub fn addSublayer(&self, layer: &CALayer)

pub fn insertSublayer_atIndex(&self, layer: &CALayer, idx: u32)

pub fn insertSublayer_below(&self, layer: &CALayer, sibling: Option<&CALayer>)

pub fn insertSublayer_above(&self, layer: &CALayer, sibling: Option<&CALayer>)

pub unsafe fn replaceSublayer_with( &self, old_layer: &CALayer, new_layer: &CALayer, )

pub fn sublayerTransform(&self) -> CATransform3D

pub fn setSublayerTransform(&self, sublayer_transform: CATransform3D)

Setter for sublayerTransform.

pub fn mask(&self) -> Option<Retained<CALayer>>

pub unsafe fn setMask(&self, mask: Option<&CALayer>)

Setter for mask.

pub fn masksToBounds(&self) -> bool

pub fn setMasksToBounds(&self, masks_to_bounds: bool)

Setter for masksToBounds.

pub fn convertPoint_fromLayer(&self, p: CGPoint, l: Option<&CALayer>) -> CGPoint

Mapping between layer coordinate and time spaces. *

pub fn convertPoint_toLayer(&self, p: CGPoint, l: Option<&CALayer>) -> CGPoint

pub fn convertRect_fromLayer(&self, r: CGRect, l: Option<&CALayer>) -> CGRect

pub fn convertRect_toLayer(&self, r: CGRect, l: Option<&CALayer>) -> CGRect

pub fn convertTime_fromLayer(&self, t: f64, l: Option<&CALayer>) -> f64

pub fn convertTime_toLayer(&self, t: f64, l: Option<&CALayer>) -> f64

pub fn hitTest(&self, p: CGPoint) -> Option<Retained<CALayer>>

Hit testing methods. *

pub fn containsPoint(&self, p: CGPoint) -> bool

pub unsafe fn contents(&self) -> Option<Retained<AnyObject>>

Layer content properties and methods. *

pub unsafe fn setContents(&self, contents: Option<&AnyObject>)

Setter for contents.

pub fn contentsRect(&self) -> CGRect

pub fn setContentsRect(&self, contents_rect: CGRect)

Setter for contentsRect.

pub fn contentsGravity(&self) -> Retained<NSString>

pub fn setContentsGravity(&self, contents_gravity: &NSString)

Setter for contentsGravity.

pub fn contentsScale(&self) -> f64

pub fn setContentsScale(&self, contents_scale: f64)

Setter for contentsScale.

pub fn contentsCenter(&self) -> CGRect

pub fn setContentsCenter(&self, contents_center: CGRect)

Setter for contentsCenter.

pub fn contentsFormat(&self) -> Retained<NSString>

pub fn setContentsFormat(&self, contents_format: &NSString)

Setter for contentsFormat.

pub unsafe fn wantsExtendedDynamicRangeContent(&self) -> bool

pub unsafe fn setWantsExtendedDynamicRangeContent( &self, wants_extended_dynamic_range_content: bool, )

Setter for wantsExtendedDynamicRangeContent.

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

pub unsafe fn setToneMapMode(&self, tone_map_mode: &NSString)

Setter for toneMapMode.

pub unsafe fn wantsDynamicContentScaling(&self) -> bool

pub unsafe fn setWantsDynamicContentScaling( &self, wants_dynamic_content_scaling: bool, )

Setter for wantsDynamicContentScaling.

pub fn minificationFilter(&self) -> Retained<NSString>

pub fn setMinificationFilter(&self, minification_filter: &NSString)

Setter for minificationFilter.

pub fn magnificationFilter(&self) -> Retained<NSString>

pub fn setMagnificationFilter(&self, magnification_filter: &NSString)

Setter for magnificationFilter.

pub fn minificationFilterBias(&self) -> f32

pub fn setMinificationFilterBias(&self, minification_filter_bias: f32)

Setter for minificationFilterBias.

pub fn isOpaque(&self) -> bool

pub fn setOpaque(&self, opaque: bool)

Setter for isOpaque.

pub fn display(&self)

pub fn setNeedsDisplay(&self)

pub fn setNeedsDisplayInRect(&self, r: CGRect)

pub fn needsDisplay(&self) -> bool

pub fn displayIfNeeded(&self)

pub fn needsDisplayOnBoundsChange(&self) -> bool

pub fn setNeedsDisplayOnBoundsChange( &self, needs_display_on_bounds_change: bool, )

Setter for needsDisplayOnBoundsChange.

pub fn drawsAsynchronously(&self) -> bool

pub fn setDrawsAsynchronously(&self, draws_asynchronously: bool)

Setter for drawsAsynchronously.

pub fn edgeAntialiasingMask(&self) -> CAEdgeAntialiasingMask

pub fn setEdgeAntialiasingMask( &self, edge_antialiasing_mask: CAEdgeAntialiasingMask, )

Setter for edgeAntialiasingMask.

pub fn allowsEdgeAntialiasing(&self) -> bool

pub fn setAllowsEdgeAntialiasing(&self, allows_edge_antialiasing: bool)

Setter for allowsEdgeAntialiasing.

pub fn cornerRadius(&self) -> f64

pub fn setCornerRadius(&self, corner_radius: f64)

Setter for cornerRadius.

pub fn maskedCorners(&self) -> CACornerMask

pub fn setMaskedCorners(&self, masked_corners: CACornerMask)

Setter for maskedCorners.

pub fn cornerCurve(&self) -> Retained<NSString>

pub fn setCornerCurve(&self, corner_curve: &NSString)

Setter for cornerCurve.

pub fn borderWidth(&self) -> f64

pub fn setBorderWidth(&self, border_width: f64)

Setter for borderWidth.

pub fn opacity(&self) -> f32

pub fn setOpacity(&self, opacity: f32)

Setter for opacity.

pub fn allowsGroupOpacity(&self) -> bool

pub fn setAllowsGroupOpacity(&self, allows_group_opacity: bool)

Setter for allowsGroupOpacity.

pub unsafe fn compositingFilter(&self) -> Option<Retained<AnyObject>>

pub unsafe fn setCompositingFilter( &self, compositing_filter: Option<&AnyObject>, )

Setter for compositingFilter.

pub unsafe fn filters(&self) -> Option<Retained<NSArray>>

pub unsafe fn setFilters(&self, filters: Option<&NSArray>)

Setter for filters.

pub unsafe fn backgroundFilters(&self) -> Option<Retained<NSArray>>

pub unsafe fn setBackgroundFilters(&self, background_filters: Option<&NSArray>)

Setter for backgroundFilters.

pub fn shouldRasterize(&self) -> bool

pub fn setShouldRasterize(&self, should_rasterize: bool)

Setter for shouldRasterize.

pub fn rasterizationScale(&self) -> f64

pub fn setRasterizationScale(&self, rasterization_scale: f64)

Setter for rasterizationScale.

pub fn shadowOpacity(&self) -> f32

pub fn setShadowOpacity(&self, shadow_opacity: f32)

Setter for shadowOpacity.

pub fn shadowOffset(&self) -> CGSize

pub fn setShadowOffset(&self, shadow_offset: CGSize)

Setter for shadowOffset.

pub fn shadowRadius(&self) -> f64

pub fn setShadowRadius(&self, shadow_radius: f64)

Setter for shadowRadius.

pub fn autoresizingMask(&self) -> CAAutoresizingMask

Layout methods. *

pub fn setAutoresizingMask(&self, autoresizing_mask: CAAutoresizingMask)

Setter for autoresizingMask.

pub fn layoutManager( &self, ) -> Option<Retained<ProtocolObject<dyn CALayoutManager>>>

pub fn setLayoutManager( &self, layout_manager: Option<&ProtocolObject<dyn CALayoutManager>>, )

Setter for layoutManager.

pub fn preferredFrameSize(&self) -> CGSize

pub fn setNeedsLayout(&self)

pub fn needsLayout(&self) -> bool

pub fn layoutIfNeeded(&self)

pub fn layoutSublayers(&self)

pub fn resizeSublayersWithOldSize(&self, size: CGSize)

pub fn resizeWithOldSuperlayerSize(&self, size: CGSize)

pub fn actionForKey( &self, event: &NSString, ) -> Option<Retained<ProtocolObject<dyn CAAction>>>

pub fn actions( &self, ) -> Option<Retained<NSDictionary<NSString, ProtocolObject<dyn CAAction>>>>

pub fn setActions( &self, actions: Option<&NSDictionary<NSString, ProtocolObject<dyn CAAction>>>, )

Setter for actions.

pub fn removeAllAnimations(&self)

pub fn removeAnimationForKey(&self, key: &NSString)

pub fn animationKeys(&self) -> Option<Retained<NSArray<NSString>>>

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

Miscellaneous properties. *

pub fn setName(&self, name: Option<&NSString>)

Setter for name.

pub fn delegate(&self) -> Option<Retained<ProtocolObject<dyn CALayerDelegate>>>

pub fn setDelegate( &self, delegate: Option<&ProtocolObject<dyn CALayerDelegate>>, )

This is a weak property. Setter for delegate.

pub unsafe fn style(&self) -> Option<Retained<NSDictionary>>

pub unsafe fn setStyle(&self, style: Option<&NSDictionary>)

Setter for style.

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 UIHoverEffectLayer

fn as_ref(&self) -> &AnyObject

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

impl AsRef<CALayer> for UIHoverEffectLayer

fn as_ref(&self) -> &CALayer

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

impl AsRef<NSObject> for UIHoverEffectLayer

fn as_ref(&self) -> &NSObject

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

impl AsRef<UIHoverEffectLayer> for UIHoverEffectLayer

fn as_ref(&self) -> &Self

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

impl Borrow<AnyObject> for UIHoverEffectLayer

fn borrow(&self) -> &AnyObject

Immutably borrows from an owned value.

impl Borrow<CALayer> for UIHoverEffectLayer

fn borrow(&self) -> &CALayer

Immutably borrows from an owned value.

impl Borrow<NSObject> for UIHoverEffectLayer

fn borrow(&self) -> &NSObject

Immutably borrows from an owned value.

impl CAMediaTiming for UIHoverEffectLayer

unsafe fn beginTime(&self) -> f64

where Self: Sized + Message,

unsafe fn setBeginTime(&self, begin_time: f64)

where Self: Sized + Message,

Setter for beginTime.

unsafe fn duration(&self) -> f64

where Self: Sized + Message,

unsafe fn setDuration(&self, duration: f64)

where Self: Sized + Message,

Setter for duration.

unsafe fn speed(&self) -> f32

where Self: Sized + Message,

unsafe fn setSpeed(&self, speed: f32)

where Self: Sized + Message,

Setter for speed.

unsafe fn timeOffset(&self) -> f64

where Self: Sized + Message,

unsafe fn setTimeOffset(&self, time_offset: f64)

where Self: Sized + Message,

Setter for timeOffset.

unsafe fn repeatCount(&self) -> f32

where Self: Sized + Message,

unsafe fn setRepeatCount(&self, repeat_count: f32)

where Self: Sized + Message,

Setter for repeatCount.

unsafe fn repeatDuration(&self) -> f64

where Self: Sized + Message,

unsafe fn setRepeatDuration(&self, repeat_duration: f64)

where Self: Sized + Message,

Setter for repeatDuration.

unsafe fn autoreverses(&self) -> bool

where Self: Sized + Message,

unsafe fn setAutoreverses(&self, autoreverses: bool)

where Self: Sized + Message,

Setter for autoreverses.

unsafe fn fillMode(&self) -> Retained<NSString>

where Self: Sized + Message,

unsafe fn setFillMode(&self, fill_mode: &NSString)

where Self: Sized + Message,

Setter for fillMode.

impl ClassType for UIHoverEffectLayer

const NAME: &'static str = "UIHoverEffectLayer"

The name of the Objective-C class that this type represents.

type Super = CALayer

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 Debug for UIHoverEffectLayer

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

Formats the value using the given formatter.

impl Deref for UIHoverEffectLayer

type Target = CALayer

The resulting type after dereferencing.

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

Dereferences the value.

impl Hash for UIHoverEffectLayer

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 UIHoverEffectLayer

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

where Self: Sized,

Increment the reference count of the receiver.

impl NSCoding for UIHoverEffectLayer

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 NSObjectProtocol for UIHoverEffectLayer

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 UIHoverEffectLayer

unsafe fn supportsSecureCoding() -> bool

where Self: Sized + ClassType,

impl PartialEq for UIHoverEffectLayer

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 UIHoverEffectLayer

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

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

impl DowncastTarget for UIHoverEffectLayer

impl Eq for UIHoverEffectLayer