Struct NSClickGestureRecognizer 

pub struct NSClickGestureRecognizer { /* private fields */ }

Available on crate features NSClickGestureRecognizer and NSGestureRecognizer only.

Apple’s documentation

Implementations

impl NSClickGestureRecognizer

pub fn buttonMask(&self) -> NSUInteger

pub fn setButtonMask(&self, button_mask: NSUInteger)

Setter for buttonMask.

pub fn numberOfClicksRequired(&self) -> NSInteger

pub fn setNumberOfClicksRequired(&self, number_of_clicks_required: NSInteger)

Setter for numberOfClicksRequired.

pub fn numberOfTouchesRequired(&self) -> NSInteger

pub fn setNumberOfTouchesRequired(&self, number_of_touches_required: NSInteger)

Setter for numberOfTouchesRequired.

impl NSClickGestureRecognizer

Methods declared on superclass NSGestureRecognizer.

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

Safety

• target should be of the correct type.
• action must be a valid selector.

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

Safety

coder possibly has further requirements.

impl NSClickGestureRecognizer

Methods declared on superclass NSObject.

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

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

Methods from Deref<Target = NSGestureRecognizer>

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

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

Setter for target.

This is a weak property.

Safety

target should be of the correct type.

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

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

Setter for action.

Safety

action must be a valid selector.

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

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

Setter for delegate.

This is a weak property.

pub fn isEnabled(&self) -> bool

pub fn setEnabled(&self, enabled: bool)

Setter for isEnabled.

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

Available on crate features NSResponder and NSView only.

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

Available on crate feature NSPressureConfiguration only.

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

Available on crate feature NSPressureConfiguration only.

Setter for pressureConfiguration.

pub fn delaysPrimaryMouseButtonEvents(&self) -> bool

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

Setter for delaysPrimaryMouseButtonEvents.

pub fn delaysSecondaryMouseButtonEvents(&self) -> bool

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

Setter for delaysSecondaryMouseButtonEvents.

pub fn delaysOtherMouseButtonEvents(&self) -> bool

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

Setter for delaysOtherMouseButtonEvents.

pub fn delaysKeyEvents(&self) -> bool

pub fn setDelaysKeyEvents(&self, delays_key_events: bool)

Setter for delaysKeyEvents.

pub fn delaysMagnificationEvents(&self) -> bool

pub fn setDelaysMagnificationEvents(&self, delays_magnification_events: bool)

Setter for delaysMagnificationEvents.

pub fn delaysRotationEvents(&self) -> bool

pub fn setDelaysRotationEvents(&self, delays_rotation_events: bool)

Setter for delaysRotationEvents.

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

Available on crate features NSResponder and NSView only.

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

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

Setter for name.

This is copied when set.

pub fn modifierFlags(&self) -> NSEventModifierFlags

Available on crate feature NSEvent only.

pub fn allowedTouchTypes(&self) -> NSTouchTypeMask

Available on crate feature NSTouch only.

pub fn setAllowedTouchTypes(&self, allowed_touch_types: NSTouchTypeMask)

Available on crate feature NSTouch only.

Setter for allowedTouchTypes.

pub fn setState(&self, state: NSGestureRecognizerState)

Setter for state.

pub fn reset(&self)

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

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

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

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

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

Available on crate feature NSEvent only.

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

Available on crate feature NSEvent only.

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

Available on crate feature NSEvent only.

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

Available on crate feature NSEvent only.

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

Available on crate feature NSEvent only.

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

Available on crate feature NSEvent only.

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

Available on crate feature NSEvent only.

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

Available on crate feature NSEvent only.

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

Available on crate feature NSEvent only.

pub fn mouseCancelled(&self, event: &NSEvent)

Available on crate feature NSEvent only.

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

Available on crate feature NSEvent only.

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

Available on crate feature NSEvent only.

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

Available on crate feature NSEvent only.

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

Available on crate feature NSEvent only.

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

Available on crate feature NSEvent only.

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

Available on crate feature NSEvent only.

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

Available on crate feature NSEvent only.

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

Available on crate feature NSEvent only.

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

Available on crate feature NSEvent only.

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

Available on crate feature NSEvent only.

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

Available on crate feature NSEvent only.

pub fn state(&self) -> NSGestureRecognizerState

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 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());

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.

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

impl AsRef<AnyObject> for NSClickGestureRecognizer

fn as_ref(&self) -> &AnyObject

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

impl AsRef<NSClickGestureRecognizer> for NSClickGestureRecognizer

fn as_ref(&self) -> &Self

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

impl AsRef<NSGestureRecognizer> for NSClickGestureRecognizer

fn as_ref(&self) -> &NSGestureRecognizer

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

impl AsRef<NSObject> for NSClickGestureRecognizer

fn as_ref(&self) -> &NSObject

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

impl Borrow<AnyObject> for NSClickGestureRecognizer

fn borrow(&self) -> &AnyObject

Immutably borrows from an owned value.

impl Borrow<NSGestureRecognizer> for NSClickGestureRecognizer

fn borrow(&self) -> &NSGestureRecognizer

Immutably borrows from an owned value.

impl Borrow<NSObject> for NSClickGestureRecognizer

fn borrow(&self) -> &NSObject

Immutably borrows from an owned value.

impl ClassType for NSClickGestureRecognizer

const NAME: &'static str = "NSClickGestureRecognizer"

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

type Super = NSGestureRecognizer

The superclass of this class.

type ThreadKind = <<NSClickGestureRecognizer 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 NSClickGestureRecognizer

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

Formats the value using the given formatter.

impl Deref for NSClickGestureRecognizer

type Target = NSGestureRecognizer

The resulting type after dereferencing.

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

Dereferences the value.

impl Hash for NSClickGestureRecognizer

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 NSClickGestureRecognizer

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

where Self: Sized,

Increment the reference count of the receiver.

impl NSCoding for NSClickGestureRecognizer

unsafe fn encodeWithCoder(&self, coder: &NSCoder)

where Self: Sized + Message,

Safety

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

where Self: Sized + Message,

Safety

impl NSObjectProtocol for NSClickGestureRecognizer

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 NSClickGestureRecognizer

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 NSClickGestureRecognizer

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

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

impl DowncastTarget for NSClickGestureRecognizer

impl Eq for NSClickGestureRecognizer