#[repr(C)]pub struct NSGestureRecognizer { /* private fields */ }
NSGestureRecognizer
only.Expand description
Implementations§
Source§impl NSGestureRecognizer
impl NSGestureRecognizer
pub unsafe fn initWithTarget_action( this: Allocated<Self>, target: Option<&AnyObject>, action: Option<Sel>, ) -> Retained<Self>
pub unsafe fn initWithCoder( this: Allocated<Self>, coder: &NSCoder, ) -> Option<Retained<Self>>
pub unsafe fn target(&self) -> Option<Retained<AnyObject>>
Sourcepub unsafe fn setTarget(&self, target: Option<&AnyObject>)
pub unsafe fn setTarget(&self, target: Option<&AnyObject>)
This is a weak property.
Setter for target
.
pub unsafe fn action(&self) -> Option<Sel>
pub unsafe fn delegate( &self, ) -> Option<Retained<ProtocolObject<dyn NSGestureRecognizerDelegate>>>
Sourcepub unsafe fn setDelegate(
&self,
delegate: Option<&ProtocolObject<dyn NSGestureRecognizerDelegate>>,
)
pub unsafe fn setDelegate( &self, delegate: Option<&ProtocolObject<dyn NSGestureRecognizerDelegate>>, )
This is a weak property.
Setter for delegate
.
pub unsafe fn isEnabled(&self) -> bool
Sourcepub unsafe fn setEnabled(&self, enabled: bool)
pub unsafe fn setEnabled(&self, enabled: bool)
Setter for isEnabled
.
pub unsafe fn view(&self) -> Option<Retained<NSView>>
NSResponder
and NSView
only.pub unsafe fn pressureConfiguration(&self) -> Retained<NSPressureConfiguration>
NSPressureConfiguration
only.Sourcepub unsafe fn setPressureConfiguration(
&self,
pressure_configuration: &NSPressureConfiguration,
)
Available on crate feature NSPressureConfiguration
only.
pub unsafe fn setPressureConfiguration( &self, pressure_configuration: &NSPressureConfiguration, )
NSPressureConfiguration
only.Setter for pressureConfiguration
.
pub unsafe fn delaysPrimaryMouseButtonEvents(&self) -> bool
Sourcepub unsafe fn setDelaysPrimaryMouseButtonEvents(
&self,
delays_primary_mouse_button_events: bool,
)
pub unsafe fn setDelaysPrimaryMouseButtonEvents( &self, delays_primary_mouse_button_events: bool, )
Setter for delaysPrimaryMouseButtonEvents
.
pub unsafe fn delaysSecondaryMouseButtonEvents(&self) -> bool
Sourcepub unsafe fn setDelaysSecondaryMouseButtonEvents(
&self,
delays_secondary_mouse_button_events: bool,
)
pub unsafe fn setDelaysSecondaryMouseButtonEvents( &self, delays_secondary_mouse_button_events: bool, )
Setter for delaysSecondaryMouseButtonEvents
.
pub unsafe fn delaysOtherMouseButtonEvents(&self) -> bool
Sourcepub unsafe fn setDelaysOtherMouseButtonEvents(
&self,
delays_other_mouse_button_events: bool,
)
pub unsafe fn setDelaysOtherMouseButtonEvents( &self, delays_other_mouse_button_events: bool, )
Setter for delaysOtherMouseButtonEvents
.
pub unsafe fn delaysKeyEvents(&self) -> bool
Sourcepub unsafe fn setDelaysKeyEvents(&self, delays_key_events: bool)
pub unsafe fn setDelaysKeyEvents(&self, delays_key_events: bool)
Setter for delaysKeyEvents
.
pub unsafe fn delaysMagnificationEvents(&self) -> bool
Sourcepub unsafe fn setDelaysMagnificationEvents(
&self,
delays_magnification_events: bool,
)
pub unsafe fn setDelaysMagnificationEvents( &self, delays_magnification_events: bool, )
Setter for delaysMagnificationEvents
.
pub unsafe fn delaysRotationEvents(&self) -> bool
Sourcepub unsafe fn setDelaysRotationEvents(&self, delays_rotation_events: bool)
pub unsafe fn setDelaysRotationEvents(&self, delays_rotation_events: bool)
Setter for delaysRotationEvents
.
pub unsafe fn locationInView(&self, view: Option<&NSView>) -> NSPoint
NSResponder
and NSView
only.Source§impl NSGestureRecognizer
Methods declared on superclass NSObject
.
impl NSGestureRecognizer
Methods declared on superclass NSObject
.
Source§impl NSGestureRecognizer
NSTouchBar.
impl NSGestureRecognizer
NSTouchBar.
pub unsafe fn allowedTouchTypes(&self) -> NSTouchTypeMask
NSTouch
only.Sourcepub unsafe fn setAllowedTouchTypes(&self, allowed_touch_types: NSTouchTypeMask)
Available on crate feature NSTouch
only.
pub unsafe fn setAllowedTouchTypes(&self, allowed_touch_types: NSTouchTypeMask)
NSTouch
only.Setter for allowedTouchTypes
.
Source§impl NSGestureRecognizer
NSSubclassUse.
impl NSGestureRecognizer
NSSubclassUse.
Sourcepub unsafe fn setState(&self, state: NSGestureRecognizerState)
pub unsafe fn setState(&self, state: NSGestureRecognizerState)
Setter for [state
][Self::state].
pub unsafe fn reset(&self)
pub unsafe fn canPreventGestureRecognizer( &self, prevented_gesture_recognizer: &NSGestureRecognizer, ) -> bool
pub unsafe fn canBePreventedByGestureRecognizer( &self, preventing_gesture_recognizer: &NSGestureRecognizer, ) -> bool
pub unsafe fn shouldRequireFailureOfGestureRecognizer( &self, other_gesture_recognizer: &NSGestureRecognizer, ) -> bool
pub unsafe fn shouldBeRequiredToFailByGestureRecognizer( &self, other_gesture_recognizer: &NSGestureRecognizer, ) -> bool
pub unsafe fn mouseDown(&self, event: &NSEvent)
NSEvent
only.pub unsafe fn rightMouseDown(&self, event: &NSEvent)
NSEvent
only.pub unsafe fn otherMouseDown(&self, event: &NSEvent)
NSEvent
only.pub unsafe fn mouseUp(&self, event: &NSEvent)
NSEvent
only.pub unsafe fn rightMouseUp(&self, event: &NSEvent)
NSEvent
only.pub unsafe fn otherMouseUp(&self, event: &NSEvent)
NSEvent
only.pub unsafe fn mouseDragged(&self, event: &NSEvent)
NSEvent
only.pub unsafe fn rightMouseDragged(&self, event: &NSEvent)
NSEvent
only.pub unsafe fn otherMouseDragged(&self, event: &NSEvent)
NSEvent
only.pub unsafe fn keyDown(&self, event: &NSEvent)
NSEvent
only.pub unsafe fn keyUp(&self, event: &NSEvent)
NSEvent
only.pub unsafe fn flagsChanged(&self, event: &NSEvent)
NSEvent
only.pub unsafe fn tabletPoint(&self, event: &NSEvent)
NSEvent
only.pub unsafe fn magnifyWithEvent(&self, event: &NSEvent)
NSEvent
only.pub unsafe fn rotateWithEvent(&self, event: &NSEvent)
NSEvent
only.pub unsafe fn pressureChangeWithEvent(&self, event: &NSEvent)
NSEvent
only.pub unsafe fn touchesBeganWithEvent(&self, event: &NSEvent)
NSEvent
only.pub unsafe fn touchesMovedWithEvent(&self, event: &NSEvent)
NSEvent
only.pub unsafe fn touchesEndedWithEvent(&self, event: &NSEvent)
NSEvent
only.pub unsafe fn touchesCancelledWithEvent(&self, event: &NSEvent)
NSEvent
only.Methods from Deref<Target = NSObject>§
Sourcepub fn doesNotRecognizeSelector(&self, sel: Sel) -> !
pub fn doesNotRecognizeSelector(&self, sel: Sel) -> !
Handle messages the object doesn’t recognize.
See Apple’s documentation for details.
Methods from Deref<Target = AnyObject>§
Sourcepub fn class(&self) -> &'static AnyClass
Available on crate feature NSAccessibilityConstants
only.
pub fn class(&self) -> &'static AnyClass
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());
Sourcepub unsafe fn get_ivar<T>(&self, name: &str) -> &Twhere
T: Encode,
👎Deprecated: this is difficult to use correctly, use Ivar::load
instead.Available on crate feature NSAccessibilityConstants
only.
pub unsafe fn get_ivar<T>(&self, name: &str) -> &Twhere
T: Encode,
Ivar::load
instead.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.
Sourcepub fn downcast_ref<T>(&self) -> Option<&T>where
T: DowncastTarget,
Available on crate feature NSAccessibilityConstants
only.
pub fn downcast_ref<T>(&self) -> Option<&T>where
T: DowncastTarget,
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
impl AsRef<AnyObject> for NSGestureRecognizer
Source§impl AsRef<NSGestureRecognizer> for NSClickGestureRecognizer
Available on crate feature NSClickGestureRecognizer
only.
impl AsRef<NSGestureRecognizer> for NSClickGestureRecognizer
NSClickGestureRecognizer
only.Source§fn as_ref(&self) -> &NSGestureRecognizer
fn as_ref(&self) -> &NSGestureRecognizer
Source§impl AsRef<NSGestureRecognizer> for NSMagnificationGestureRecognizer
Available on crate feature NSMagnificationGestureRecognizer
only.
impl AsRef<NSGestureRecognizer> for NSMagnificationGestureRecognizer
NSMagnificationGestureRecognizer
only.Source§fn as_ref(&self) -> &NSGestureRecognizer
fn as_ref(&self) -> &NSGestureRecognizer
Source§impl AsRef<NSGestureRecognizer> for NSPanGestureRecognizer
Available on crate feature NSPanGestureRecognizer
only.
impl AsRef<NSGestureRecognizer> for NSPanGestureRecognizer
NSPanGestureRecognizer
only.Source§fn as_ref(&self) -> &NSGestureRecognizer
fn as_ref(&self) -> &NSGestureRecognizer
Source§impl AsRef<NSGestureRecognizer> for NSPressGestureRecognizer
Available on crate feature NSPressGestureRecognizer
only.
impl AsRef<NSGestureRecognizer> for NSPressGestureRecognizer
NSPressGestureRecognizer
only.Source§fn as_ref(&self) -> &NSGestureRecognizer
fn as_ref(&self) -> &NSGestureRecognizer
Source§impl AsRef<NSGestureRecognizer> for NSRotationGestureRecognizer
Available on crate feature NSRotationGestureRecognizer
only.
impl AsRef<NSGestureRecognizer> for NSRotationGestureRecognizer
NSRotationGestureRecognizer
only.Source§fn as_ref(&self) -> &NSGestureRecognizer
fn as_ref(&self) -> &NSGestureRecognizer
Source§impl AsRef<NSObject> for NSGestureRecognizer
impl AsRef<NSObject> for NSGestureRecognizer
Source§impl Borrow<AnyObject> for NSGestureRecognizer
impl Borrow<AnyObject> for NSGestureRecognizer
Source§impl Borrow<NSGestureRecognizer> for NSClickGestureRecognizer
Available on crate feature NSClickGestureRecognizer
only.
impl Borrow<NSGestureRecognizer> for NSClickGestureRecognizer
NSClickGestureRecognizer
only.Source§fn borrow(&self) -> &NSGestureRecognizer
fn borrow(&self) -> &NSGestureRecognizer
Source§impl Borrow<NSGestureRecognizer> for NSMagnificationGestureRecognizer
Available on crate feature NSMagnificationGestureRecognizer
only.
impl Borrow<NSGestureRecognizer> for NSMagnificationGestureRecognizer
NSMagnificationGestureRecognizer
only.Source§fn borrow(&self) -> &NSGestureRecognizer
fn borrow(&self) -> &NSGestureRecognizer
Source§impl Borrow<NSGestureRecognizer> for NSPanGestureRecognizer
Available on crate feature NSPanGestureRecognizer
only.
impl Borrow<NSGestureRecognizer> for NSPanGestureRecognizer
NSPanGestureRecognizer
only.Source§fn borrow(&self) -> &NSGestureRecognizer
fn borrow(&self) -> &NSGestureRecognizer
Source§impl Borrow<NSGestureRecognizer> for NSPressGestureRecognizer
Available on crate feature NSPressGestureRecognizer
only.
impl Borrow<NSGestureRecognizer> for NSPressGestureRecognizer
NSPressGestureRecognizer
only.Source§fn borrow(&self) -> &NSGestureRecognizer
fn borrow(&self) -> &NSGestureRecognizer
Source§impl Borrow<NSGestureRecognizer> for NSRotationGestureRecognizer
Available on crate feature NSRotationGestureRecognizer
only.
impl Borrow<NSGestureRecognizer> for NSRotationGestureRecognizer
NSRotationGestureRecognizer
only.Source§fn borrow(&self) -> &NSGestureRecognizer
fn borrow(&self) -> &NSGestureRecognizer
Source§impl Borrow<NSObject> for NSGestureRecognizer
impl Borrow<NSObject> for NSGestureRecognizer
Source§impl ClassType for NSGestureRecognizer
impl ClassType for NSGestureRecognizer
Source§const NAME: &'static str = "NSGestureRecognizer"
const NAME: &'static str = "NSGestureRecognizer"
Source§type ThreadKind = dyn MainThreadOnly
type ThreadKind = dyn MainThreadOnly
Source§impl Debug for NSGestureRecognizer
impl Debug for NSGestureRecognizer
Source§impl Deref for NSGestureRecognizer
impl Deref for NSGestureRecognizer
Source§impl Hash for NSGestureRecognizer
impl Hash for NSGestureRecognizer
Source§impl Message for NSGestureRecognizer
impl Message for NSGestureRecognizer
Source§impl NSCoding for NSGestureRecognizer
impl NSCoding for NSGestureRecognizer
Source§impl NSObjectProtocol for NSGestureRecognizer
impl NSObjectProtocol for NSGestureRecognizer
Source§fn isEqual(&self, other: Option<&AnyObject>) -> bool
fn isEqual(&self, other: Option<&AnyObject>) -> bool
Source§fn hash(&self) -> usize
fn hash(&self) -> usize
Source§fn isKindOfClass(&self, cls: &AnyClass) -> bool
fn isKindOfClass(&self, cls: &AnyClass) -> bool
Source§fn is_kind_of<T>(&self) -> bool
fn is_kind_of<T>(&self) -> bool
isKindOfClass
directly, or cast your objects with AnyObject::downcast_ref
Source§fn isMemberOfClass(&self, cls: &AnyClass) -> bool
fn isMemberOfClass(&self, cls: &AnyClass) -> bool
Source§fn respondsToSelector(&self, aSelector: Sel) -> bool
fn respondsToSelector(&self, aSelector: Sel) -> bool
Source§fn conformsToProtocol(&self, aProtocol: &AnyProtocol) -> bool
fn conformsToProtocol(&self, aProtocol: &AnyProtocol) -> bool
Source§fn debugDescription(&self) -> Retained<NSObject>
fn debugDescription(&self) -> Retained<NSObject>
Source§impl PartialEq for NSGestureRecognizer
impl PartialEq for NSGestureRecognizer
Source§impl RefEncode for NSGestureRecognizer
impl RefEncode for NSGestureRecognizer
Source§const ENCODING_REF: Encoding = <NSObject as ::objc2::RefEncode>::ENCODING_REF
const ENCODING_REF: Encoding = <NSObject as ::objc2::RefEncode>::ENCODING_REF
impl DowncastTarget for NSGestureRecognizer
impl Eq for NSGestureRecognizer
Auto Trait Implementations§
impl !Freeze for NSGestureRecognizer
impl !RefUnwindSafe for NSGestureRecognizer
impl !Send for NSGestureRecognizer
impl !Sync for NSGestureRecognizer
impl !Unpin for NSGestureRecognizer
impl !UnwindSafe for NSGestureRecognizer
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<'a, T> MainThreadOnly for T
impl<'a, T> MainThreadOnly for T
Source§fn mtm(&self) -> MainThreadMarker
fn mtm(&self) -> MainThreadMarker
MainThreadMarker
from the main-thread-only object. Read more