Struct NSGestureRecognizer

Source
#[repr(C)]
pub struct NSGestureRecognizer { /* private fields */ }
Available on crate feature NSGestureRecognizer only.
Expand description

Implementations§

Source§

impl NSGestureRecognizer

Source

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

Source

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

Source

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

Source

pub unsafe fn setTarget(&self, target: Option<&AnyObject>)

This is a weak property. Setter for target.

Source

pub unsafe fn action(&self) -> Option<Sel>

Source

pub unsafe fn setAction(&self, action: Option<Sel>)

Setter for action.

Source

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

Source

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

This is a weak property. Setter for delegate.

Source

pub unsafe fn isEnabled(&self) -> bool

Source

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

Setter for isEnabled.

Source

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

Available on crate features NSResponder and NSView only.
Source

pub unsafe fn pressureConfiguration(&self) -> Retained<NSPressureConfiguration>

Available on crate feature NSPressureConfiguration only.
Source

pub unsafe fn setPressureConfiguration( &self, pressure_configuration: &NSPressureConfiguration, )

Available on crate feature NSPressureConfiguration only.
Source

pub unsafe fn delaysPrimaryMouseButtonEvents(&self) -> bool

Source

pub unsafe fn setDelaysPrimaryMouseButtonEvents( &self, delays_primary_mouse_button_events: bool, )

Source

pub unsafe fn delaysSecondaryMouseButtonEvents(&self) -> bool

Source

pub unsafe fn setDelaysSecondaryMouseButtonEvents( &self, delays_secondary_mouse_button_events: bool, )

Source

pub unsafe fn delaysOtherMouseButtonEvents(&self) -> bool

Source

pub unsafe fn setDelaysOtherMouseButtonEvents( &self, delays_other_mouse_button_events: bool, )

Source

pub unsafe fn delaysKeyEvents(&self) -> bool

Source

pub unsafe fn setDelaysKeyEvents(&self, delays_key_events: bool)

Setter for delaysKeyEvents.

Source

pub unsafe fn delaysMagnificationEvents(&self) -> bool

Source

pub unsafe fn setDelaysMagnificationEvents( &self, delays_magnification_events: bool, )

Source

pub unsafe fn delaysRotationEvents(&self) -> bool

Source

pub unsafe fn setDelaysRotationEvents(&self, delays_rotation_events: bool)

Source

pub unsafe fn locationInView(&self, view: Option<&NSView>) -> NSPoint

Available on crate features NSResponder and NSView only.
Source§

impl NSGestureRecognizer

Methods declared on superclass NSObject.

Source

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

Source

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

Source§

impl NSGestureRecognizer

NSTouchBar.

Source

pub unsafe fn allowedTouchTypes(&self) -> NSTouchTypeMask

Available on crate feature NSTouch only.
Source

pub unsafe fn setAllowedTouchTypes(&self, allowed_touch_types: NSTouchTypeMask)

Available on crate feature NSTouch only.

Setter for allowedTouchTypes.

Source§

impl NSGestureRecognizer

NSSubclassUse.

Source

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

Setter for [state][Self::state].

Source

pub unsafe fn reset(&self)

Source

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

Source

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

Source

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

Source

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

Source

pub unsafe fn mouseDown(&self, event: &NSEvent)

Available on crate feature NSEvent only.
Source

pub unsafe fn rightMouseDown(&self, event: &NSEvent)

Available on crate feature NSEvent only.
Source

pub unsafe fn otherMouseDown(&self, event: &NSEvent)

Available on crate feature NSEvent only.
Source

pub unsafe fn mouseUp(&self, event: &NSEvent)

Available on crate feature NSEvent only.
Source

pub unsafe fn rightMouseUp(&self, event: &NSEvent)

Available on crate feature NSEvent only.
Source

pub unsafe fn otherMouseUp(&self, event: &NSEvent)

Available on crate feature NSEvent only.
Source

pub unsafe fn mouseDragged(&self, event: &NSEvent)

Available on crate feature NSEvent only.
Source

pub unsafe fn rightMouseDragged(&self, event: &NSEvent)

Available on crate feature NSEvent only.
Source

pub unsafe fn otherMouseDragged(&self, event: &NSEvent)

Available on crate feature NSEvent only.
Source

pub unsafe fn keyDown(&self, event: &NSEvent)

Available on crate feature NSEvent only.
Source

pub unsafe fn keyUp(&self, event: &NSEvent)

Available on crate feature NSEvent only.
Source

pub unsafe fn flagsChanged(&self, event: &NSEvent)

Available on crate feature NSEvent only.
Source

pub unsafe fn tabletPoint(&self, event: &NSEvent)

Available on crate feature NSEvent only.
Source

pub unsafe fn magnifyWithEvent(&self, event: &NSEvent)

Available on crate feature NSEvent only.
Source

pub unsafe fn rotateWithEvent(&self, event: &NSEvent)

Available on crate feature NSEvent only.
Source

pub unsafe fn pressureChangeWithEvent(&self, event: &NSEvent)

Available on crate feature NSEvent only.
Source

pub unsafe fn touchesBeganWithEvent(&self, event: &NSEvent)

Available on crate feature NSEvent only.
Source

pub unsafe fn touchesMovedWithEvent(&self, event: &NSEvent)

Available on crate feature NSEvent only.
Source

pub unsafe fn touchesEndedWithEvent(&self, event: &NSEvent)

Available on crate feature NSEvent only.
Source

pub unsafe fn touchesCancelledWithEvent(&self, event: &NSEvent)

Available on crate feature NSEvent only.

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 NSAccessibilityConstants 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 NSAccessibilityConstants 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 NSAccessibilityConstants 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§

Source§

impl AsRef<AnyObject> for NSGestureRecognizer

Source§

fn as_ref(&self) -> &AnyObject

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

impl AsRef<NSGestureRecognizer> for NSClickGestureRecognizer

Available on crate feature NSClickGestureRecognizer only.
Source§

fn as_ref(&self) -> &NSGestureRecognizer

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

impl AsRef<NSGestureRecognizer> for NSGestureRecognizer

Source§

fn as_ref(&self) -> &Self

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

impl AsRef<NSGestureRecognizer> for NSMagnificationGestureRecognizer

Available on crate feature NSMagnificationGestureRecognizer only.
Source§

fn as_ref(&self) -> &NSGestureRecognizer

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

impl AsRef<NSGestureRecognizer> for NSPanGestureRecognizer

Available on crate feature NSPanGestureRecognizer only.
Source§

fn as_ref(&self) -> &NSGestureRecognizer

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

impl AsRef<NSGestureRecognizer> for NSPressGestureRecognizer

Available on crate feature NSPressGestureRecognizer only.
Source§

fn as_ref(&self) -> &NSGestureRecognizer

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

impl AsRef<NSGestureRecognizer> for NSRotationGestureRecognizer

Available on crate feature NSRotationGestureRecognizer only.
Source§

fn as_ref(&self) -> &NSGestureRecognizer

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

impl AsRef<NSObject> for NSGestureRecognizer

Source§

fn as_ref(&self) -> &NSObject

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

impl Borrow<AnyObject> for NSGestureRecognizer

Source§

fn borrow(&self) -> &AnyObject

Immutably borrows from an owned value. Read more
Source§

impl Borrow<NSGestureRecognizer> for NSClickGestureRecognizer

Available on crate feature NSClickGestureRecognizer only.
Source§

fn borrow(&self) -> &NSGestureRecognizer

Immutably borrows from an owned value. Read more
Source§

impl Borrow<NSGestureRecognizer> for NSMagnificationGestureRecognizer

Available on crate feature NSMagnificationGestureRecognizer only.
Source§

fn borrow(&self) -> &NSGestureRecognizer

Immutably borrows from an owned value. Read more
Source§

impl Borrow<NSGestureRecognizer> for NSPanGestureRecognizer

Available on crate feature NSPanGestureRecognizer only.
Source§

fn borrow(&self) -> &NSGestureRecognizer

Immutably borrows from an owned value. Read more
Source§

impl Borrow<NSGestureRecognizer> for NSPressGestureRecognizer

Available on crate feature NSPressGestureRecognizer only.
Source§

fn borrow(&self) -> &NSGestureRecognizer

Immutably borrows from an owned value. Read more
Source§

impl Borrow<NSGestureRecognizer> for NSRotationGestureRecognizer

Available on crate feature NSRotationGestureRecognizer only.
Source§

fn borrow(&self) -> &NSGestureRecognizer

Immutably borrows from an owned value. Read more
Source§

impl Borrow<NSObject> for NSGestureRecognizer

Source§

fn borrow(&self) -> &NSObject

Immutably borrows from an owned value. Read more
Source§

impl ClassType for NSGestureRecognizer

Source§

const NAME: &'static str = "NSGestureRecognizer"

The name of the Objective-C class that this type represents. Read more
Source§

type Super = NSObject

The superclass of this class. Read more
Source§

type ThreadKind = dyn MainThreadOnly

Whether the type can be used from any thread, or from only the main thread. Read more
Source§

fn class() -> &'static AnyClass

Get a reference to the Objective-C class that this type represents. Read more
Source§

fn as_super(&self) -> &Self::Super

Get an immutable reference to the superclass.
Source§

impl Debug for NSGestureRecognizer

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Deref for NSGestureRecognizer

Source§

type Target = NSObject

The resulting type after dereferencing.
Source§

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

Dereferences the value.
Source§

impl Hash for NSGestureRecognizer

Source§

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
Source§

impl Message for NSGestureRecognizer

Source§

fn retain(&self) -> Retained<Self>
where Self: Sized,

Increment the reference count of the receiver. Read more
Source§

impl NSCoding for NSGestureRecognizer

Source§

unsafe fn encodeWithCoder(&self, coder: &NSCoder)
where Self: Sized + Message,

Source§

unsafe fn initWithCoder( this: Allocated<Self>, coder: &NSCoder, ) -> Option<Retained<Self>>
where Self: Sized + Message,

Source§

impl NSObjectProtocol for NSGestureRecognizer

Source§

fn isEqual(&self, other: Option<&AnyObject>) -> bool
where Self: Sized + Message,

Check whether the object is equal to an arbitrary other object. Read more
Source§

fn hash(&self) -> usize
where Self: Sized + Message,

An integer that can be used as a table address in a hash table structure. Read more
Source§

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. Read more
Source§

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. Read more
Source§

fn isMemberOfClass(&self, cls: &AnyClass) -> bool
where Self: Sized + Message,

Check if the object is an instance of a specific class, without checking subclasses. Read more
Source§

fn respondsToSelector(&self, aSelector: Sel) -> bool
where Self: Sized + Message,

Check whether the object implements or inherits a method with the given selector. Read more
Source§

fn conformsToProtocol(&self, aProtocol: &AnyProtocol) -> bool
where Self: Sized + Message,

Check whether the object conforms to a given protocol. Read more
Source§

fn description(&self) -> Retained<NSObject>
where Self: Sized + Message,

A textual representation of the object. Read more
Source§

fn debugDescription(&self) -> Retained<NSObject>
where Self: Sized + Message,

A textual representation of the object to use when debugging. Read more
Source§

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. Read more
Source§

fn retainCount(&self) -> usize
where Self: Sized + Message,

The reference count of the object. Read more
Source§

impl PartialEq for NSGestureRecognizer

Source§

fn eq(&self, other: &Self) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl RefEncode for NSGestureRecognizer

Source§

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

The Objective-C type-encoding for a reference of this type. Read more
Source§

impl DowncastTarget for NSGestureRecognizer

Source§

impl Eq for NSGestureRecognizer

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<'a, T> MainThreadOnly for T
where T: ClassType<ThreadKind = dyn MainThreadOnly + 'a> + ?Sized,

Source§

fn mtm(&self) -> MainThreadMarker

Get a MainThreadMarker from the main-thread-only object. Read more
Source§

fn alloc(mtm: MainThreadMarker) -> Allocated<Self>
where Self: Sized + ClassType,

Allocate a new instance of the class on the main thread. Read more
Source§

impl<P, T> Receiver for P
where P: Deref<Target = T> + ?Sized, T: ?Sized,

Source§

type Target = T

🔬This is a nightly-only experimental API. (arbitrary_self_types)
The target type on which the method may be called.
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> AutoreleaseSafe for T
where T: ?Sized,