Struct UIHoverGestureRecognizer

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

Available on crate features UIGestureRecognizer and UIHoverGestureRecognizer only.

Apple’s documentation

Implementations

impl UIHoverGestureRecognizer

pub unsafe fn zOffset(&self) -> CGFloat

Available on crate feature objc2-core-foundation only.

The normalized distance from the screen of the hovering device. This value will be 1 at the maximum distance from the screen and will approach 0 as the device gets closer to the screen. Will always return 0 for devices that don’t support z offset.

pub unsafe fn azimuthAngleInView(&self, view: Option<&UIView>) -> CGFloat

Available on crate features UIResponder and UIView and objc2-core-foundation only.

The azimuth angle of the current device in the specified view, or the gesture recognizer’s window if nil. 0 is returned for devices that don’t support azimuth.

pub unsafe fn azimuthUnitVectorInView(&self, view: Option<&UIView>) -> CGVector

Available on crate features UIResponder and UIView and objc2-core-foundation only.

The azimuth unit vector of the current device in the specified view, or the gesture recognizer’s window if nil. An empty vector is returned for devices that don’t support azimuth.

pub unsafe fn altitudeAngle(&self) -> CGFloat

Available on crate feature objc2-core-foundation only.

The altitude angle of the current device. 0 is returned for devices that don’t support altitude.

pub unsafe fn rollAngle(&self) -> CGFloat

Available on crate feature objc2-core-foundation only.

impl UIHoverGestureRecognizer

Methods declared on superclass UIGestureRecognizer.

pub unsafe fn initWithTarget_action( this: Allocated<Self>, target: Option<&AnyObject>, action: Option<Sel>, ) -> Retained<Self>

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

pub unsafe fn initWithCoder( this: Allocated<Self>, coder: &NSCoder, ) -> Option<Retained<Self>>

impl UIHoverGestureRecognizer

Methods declared on superclass NSObject.

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

Methods from Deref<Target = UIGestureRecognizer>

pub unsafe fn addTarget_action(&self, target: &AnyObject, action: Sel)

pub unsafe fn removeTarget_action( &self, target: Option<&AnyObject>, action: Option<Sel>, )

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

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

This is a weak property. Setter for delegate.

pub unsafe fn isEnabled(&self) -> bool

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

Setter for isEnabled.

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

Available on crate features UIResponder and UIView only.

pub unsafe fn cancelsTouchesInView(&self) -> bool

pub unsafe fn setCancelsTouchesInView(&self, cancels_touches_in_view: bool)

Setter for cancelsTouchesInView.

pub unsafe fn delaysTouchesBegan(&self) -> bool

pub unsafe fn setDelaysTouchesBegan(&self, delays_touches_began: bool)

Setter for delaysTouchesBegan.

pub unsafe fn delaysTouchesEnded(&self) -> bool

pub unsafe fn setDelaysTouchesEnded(&self, delays_touches_ended: bool)

Setter for delaysTouchesEnded.

pub unsafe fn allowedTouchTypes(&self) -> Retained<NSArray<NSNumber>>

pub unsafe fn setAllowedTouchTypes( &self, allowed_touch_types: &NSArray<NSNumber>, )

Setter for allowedTouchTypes.

pub unsafe fn allowedPressTypes(&self) -> Retained<NSArray<NSNumber>>

pub unsafe fn setAllowedPressTypes( &self, allowed_press_types: &NSArray<NSNumber>, )

Setter for allowedPressTypes.

pub unsafe fn requiresExclusiveTouchType(&self) -> bool

pub unsafe fn setRequiresExclusiveTouchType( &self, requires_exclusive_touch_type: bool, )

Setter for requiresExclusiveTouchType.

pub unsafe fn requireGestureRecognizerToFail( &self, other_gesture_recognizer: &UIGestureRecognizer, )

pub unsafe fn locationInView(&self, view: Option<&UIView>) -> CGPoint

Available on crate features UIResponder and UIView and objc2-core-foundation only.

pub unsafe fn numberOfTouches(&self) -> NSUInteger

pub unsafe fn locationOfTouch_inView( &self, touch_index: NSUInteger, view: Option<&UIView>, ) -> CGPoint

Available on crate features UIResponder and UIView and objc2-core-foundation only.

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

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

Setter for name.

pub unsafe fn modifierFlags(&self) -> UIKeyModifierFlags

Available on crate feature UICommand only.

pub unsafe fn buttonMask(&self) -> UIEventButtonMask

Available on crate feature UIEvent only.

pub unsafe fn setState(&self, state: UIGestureRecognizerState)

Available on crate feature UIGestureRecognizerSubclass only.

Setter for state.

pub unsafe fn ignoreTouch_forEvent(&self, touch: &UITouch, event: &UIEvent)

Available on crate features UIGestureRecognizerSubclass and UIEvent and UITouch only.

pub unsafe fn ignorePress_forEvent( &self, button: &UIPress, event: &UIPressesEvent, )

Available on crate features UIGestureRecognizerSubclass and UIEvent and UIPress and UIPressesEvent only.

pub unsafe fn reset(&self)

Available on crate feature UIGestureRecognizerSubclass only.

pub unsafe fn canPreventGestureRecognizer( &self, prevented_gesture_recognizer: &UIGestureRecognizer, ) -> bool

Available on crate feature UIGestureRecognizerSubclass only.

pub unsafe fn canBePreventedByGestureRecognizer( &self, preventing_gesture_recognizer: &UIGestureRecognizer, ) -> bool

Available on crate feature UIGestureRecognizerSubclass only.

pub unsafe fn shouldRequireFailureOfGestureRecognizer( &self, other_gesture_recognizer: &UIGestureRecognizer, ) -> bool

Available on crate feature UIGestureRecognizerSubclass only.

pub unsafe fn shouldBeRequiredToFailByGestureRecognizer( &self, other_gesture_recognizer: &UIGestureRecognizer, ) -> bool

Available on crate feature UIGestureRecognizerSubclass only.

pub unsafe fn shouldReceiveEvent(&self, event: &UIEvent) -> bool

Available on crate features UIGestureRecognizerSubclass and UIEvent only.

pub unsafe fn touchesBegan_withEvent( &self, touches: &NSSet<UITouch>, event: &UIEvent, )

Available on crate features UIGestureRecognizerSubclass and UIEvent and UITouch only.

pub unsafe fn touchesMoved_withEvent( &self, touches: &NSSet<UITouch>, event: &UIEvent, )

Available on crate features UIGestureRecognizerSubclass and UIEvent and UITouch only.

pub unsafe fn touchesEnded_withEvent( &self, touches: &NSSet<UITouch>, event: &UIEvent, )

Available on crate features UIGestureRecognizerSubclass and UIEvent and UITouch only.

pub unsafe fn touchesCancelled_withEvent( &self, touches: &NSSet<UITouch>, event: &UIEvent, )

Available on crate features UIGestureRecognizerSubclass and UIEvent and UITouch only.

pub unsafe fn touchesEstimatedPropertiesUpdated(&self, touches: &NSSet<UITouch>)

Available on crate features UIGestureRecognizerSubclass and UITouch only.

pub unsafe fn pressesBegan_withEvent( &self, presses: &NSSet<UIPress>, event: &UIPressesEvent, )

Available on crate features UIGestureRecognizerSubclass and UIEvent and UIPress and UIPressesEvent only.

pub unsafe fn pressesChanged_withEvent( &self, presses: &NSSet<UIPress>, event: &UIPressesEvent, )

Available on crate features UIGestureRecognizerSubclass and UIEvent and UIPress and UIPressesEvent only.

pub unsafe fn pressesEnded_withEvent( &self, presses: &NSSet<UIPress>, event: &UIPressesEvent, )

Available on crate features UIGestureRecognizerSubclass and UIEvent and UIPress and UIPressesEvent only.

pub unsafe fn pressesCancelled_withEvent( &self, presses: &NSSet<UIPress>, event: &UIPressesEvent, )

Available on crate features UIGestureRecognizerSubclass and UIEvent and UIPress and UIPressesEvent only.

pub fn state(&self) -> UIGestureRecognizerState

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 UIHoverGestureRecognizer

fn as_ref(&self) -> &AnyObject

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

impl AsRef<NSObject> for UIHoverGestureRecognizer

fn as_ref(&self) -> &NSObject

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

impl AsRef<UIGestureRecognizer> for UIHoverGestureRecognizer

fn as_ref(&self) -> &UIGestureRecognizer

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

impl AsRef<UIHoverGestureRecognizer> for UIHoverGestureRecognizer

fn as_ref(&self) -> &Self

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

impl Borrow<AnyObject> for UIHoverGestureRecognizer

fn borrow(&self) -> &AnyObject

Immutably borrows from an owned value.

impl Borrow<NSObject> for UIHoverGestureRecognizer

fn borrow(&self) -> &NSObject

Immutably borrows from an owned value.

impl Borrow<UIGestureRecognizer> for UIHoverGestureRecognizer

fn borrow(&self) -> &UIGestureRecognizer

Immutably borrows from an owned value.

impl ClassType for UIHoverGestureRecognizer

const NAME: &'static str = "UIHoverGestureRecognizer"

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

type Super = UIGestureRecognizer

The superclass of this class.

type ThreadKind = <<UIHoverGestureRecognizer as ClassType>::Super as ClassType>::ThreadKind

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 UIHoverGestureRecognizer

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

Formats the value using the given formatter.

impl Deref for UIHoverGestureRecognizer

type Target = UIGestureRecognizer

The resulting type after dereferencing.

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

Dereferences the value.

impl Hash for UIHoverGestureRecognizer

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 UIHoverGestureRecognizer

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

where Self: Sized,

Increment the reference count of the receiver.

impl NSObjectProtocol for UIHoverGestureRecognizer

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 PartialEq for UIHoverGestureRecognizer

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 UIHoverGestureRecognizer

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

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

impl DowncastTarget for UIHoverGestureRecognizer

impl Eq for UIHoverGestureRecognizer