Struct objc2_app_kit::NSEvent

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

Available on crate feature NSEvent only.

Implementations

impl NSEvent

pub unsafe fn type(&self) -> NSEventType

pub unsafe fn modifierFlags(&self) -> NSEventModifierFlags

pub unsafe fn timestamp(&self) -> NSTimeInterval

pub unsafe fn window(&self, mtm: MainThreadMarker) -> Option<Retained<NSWindow>>

Available on crate features NSResponder and NSWindow only.

pub unsafe fn windowNumber(&self) -> NSInteger

pub unsafe fn context(&self) -> Option<Retained<NSGraphicsContext>>

👎Deprecated: This method always returns nil. If you need access to the current drawing context, use [NSGraphicsContext currentContext] inside of a draw operation.

Available on crate feature NSGraphicsContext only.

pub unsafe fn clickCount(&self) -> NSInteger

pub unsafe fn buttonNumber(&self) -> NSInteger

pub unsafe fn eventNumber(&self) -> NSInteger

pub unsafe fn pressure(&self) -> c_float

pub unsafe fn locationInWindow(&self) -> NSPoint

pub unsafe fn deltaX(&self) -> CGFloat

pub unsafe fn deltaY(&self) -> CGFloat

pub unsafe fn deltaZ(&self) -> CGFloat

pub unsafe fn hasPreciseScrollingDeltas(&self) -> bool

pub unsafe fn scrollingDeltaX(&self) -> CGFloat

pub unsafe fn scrollingDeltaY(&self) -> CGFloat

pub unsafe fn momentumPhase(&self) -> NSEventPhase

pub unsafe fn isDirectionInvertedFromDevice(&self) -> bool

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

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

pub unsafe fn charactersByApplyingModifiers( &self, modifiers: NSEventModifierFlags ) -> Option<Retained<NSString>>

pub unsafe fn isARepeat(&self) -> bool

pub unsafe fn keyCode(&self) -> c_ushort

pub unsafe fn trackingNumber(&self) -> NSInteger

pub unsafe fn userData(&self) -> *mut c_void

pub unsafe fn trackingArea(&self) -> Option<Retained<NSTrackingArea>>

Available on crate feature NSTrackingArea only.

pub unsafe fn subtype(&self) -> NSEventSubtype

pub unsafe fn data1(&self) -> NSInteger

pub unsafe fn data2(&self) -> NSInteger

pub unsafe fn eventRef(&self) -> *mut c_void

pub unsafe fn eventWithEventRef( event_ref: NonNull<c_void> ) -> Option<Retained<NSEvent>>

pub unsafe fn isMouseCoalescingEnabled() -> bool

pub unsafe fn setMouseCoalescingEnabled(mouse_coalescing_enabled: bool)

pub unsafe fn magnification(&self) -> CGFloat

pub unsafe fn deviceID(&self) -> NSUInteger

pub unsafe fn rotation(&self) -> c_float

pub unsafe fn absoluteX(&self) -> NSInteger

pub unsafe fn absoluteY(&self) -> NSInteger

pub unsafe fn absoluteZ(&self) -> NSInteger

pub unsafe fn buttonMask(&self) -> NSEventButtonMask

pub unsafe fn tilt(&self) -> NSPoint

pub unsafe fn tangentialPressure(&self) -> c_float

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

pub unsafe fn vendorID(&self) -> NSUInteger

pub unsafe fn tabletID(&self) -> NSUInteger

pub unsafe fn pointingDeviceID(&self) -> NSUInteger

pub unsafe fn systemTabletID(&self) -> NSUInteger

pub unsafe fn vendorPointingDeviceType(&self) -> NSUInteger

pub unsafe fn pointingDeviceSerialNumber(&self) -> NSUInteger

pub unsafe fn uniqueID(&self) -> c_ulonglong

pub unsafe fn capabilityMask(&self) -> NSUInteger

pub unsafe fn pointingDeviceType(&self) -> NSPointingDeviceType

pub unsafe fn isEnteringProximity(&self) -> bool

pub unsafe fn touchesMatchingPhase_inView( &self, phase: NSTouchPhase, view: Option<&NSView> ) -> Retained<NSSet<NSTouch>>

Available on crate features NSResponder and NSTouch and NSView only.

pub unsafe fn allTouches(&self) -> Retained<NSSet<NSTouch>>

Available on crate feature NSTouch only.

pub unsafe fn touchesForView(&self, view: &NSView) -> Retained<NSSet<NSTouch>>

Available on crate features NSResponder and NSTouch and NSView only.

pub unsafe fn coalescedTouchesForTouch( &self, touch: &NSTouch ) -> Retained<NSArray<NSTouch>>

Available on crate feature NSTouch only.

pub unsafe fn phase(&self) -> NSEventPhase

pub unsafe fn stage(&self) -> NSInteger

pub unsafe fn stageTransition(&self) -> CGFloat

pub unsafe fn associatedEventsMask(&self) -> NSEventMask

pub unsafe fn pressureBehavior(&self) -> NSPressureBehavior

pub unsafe fn isSwipeTrackingFromScrollEventsEnabled() -> bool

pub unsafe fn trackSwipeEventWithOptions_dampenAmountThresholdMin_max_usingHandler( &self, options: NSEventSwipeTrackingOptions, min_dampen_threshold: CGFloat, max_dampen_threshold: CGFloat, tracking_handler: &Block<dyn Fn(CGFloat, NSEventPhase, Bool, NonNull<Bool>)> )

Available on crate feature block2 only.

pub unsafe fn startPeriodicEventsAfterDelay_withPeriod( delay: NSTimeInterval, period: NSTimeInterval )

pub unsafe fn stopPeriodicEvents()

pub unsafe fn mouseEventWithType_location_modifierFlags_timestamp_windowNumber_context_eventNumber_clickCount_pressure( type: NSEventType, location: NSPoint, flags: NSEventModifierFlags, time: NSTimeInterval, w_num: NSInteger, unused_pass_nil: Option<&NSGraphicsContext>, e_num: NSInteger, c_num: NSInteger, pressure: c_float ) -> Option<Retained<NSEvent>>

Available on crate feature NSGraphicsContext only.

pub unsafe fn keyEventWithType_location_modifierFlags_timestamp_windowNumber_context_characters_charactersIgnoringModifiers_isARepeat_keyCode( type: NSEventType, location: NSPoint, flags: NSEventModifierFlags, time: NSTimeInterval, w_num: NSInteger, unused_pass_nil: Option<&NSGraphicsContext>, keys: &NSString, ukeys: &NSString, flag: bool, code: c_ushort ) -> Option<Retained<NSEvent>>

Available on crate feature NSGraphicsContext only.

pub unsafe fn enterExitEventWithType_location_modifierFlags_timestamp_windowNumber_context_eventNumber_trackingNumber_userData( type: NSEventType, location: NSPoint, flags: NSEventModifierFlags, time: NSTimeInterval, w_num: NSInteger, unused_pass_nil: Option<&NSGraphicsContext>, e_num: NSInteger, t_num: NSInteger, data: *mut c_void ) -> Option<Retained<NSEvent>>

Available on crate feature NSGraphicsContext only.

pub unsafe fn otherEventWithType_location_modifierFlags_timestamp_windowNumber_context_subtype_data1_data2( type: NSEventType, location: NSPoint, flags: NSEventModifierFlags, time: NSTimeInterval, w_num: NSInteger, unused_pass_nil: Option<&NSGraphicsContext>, subtype: c_short, d1: NSInteger, d2: NSInteger ) -> Option<Retained<NSEvent>>

Available on crate feature NSGraphicsContext only.

pub unsafe fn mouseLocation() -> NSPoint

pub unsafe fn modifierFlags_class() -> NSEventModifierFlags

pub unsafe fn pressedMouseButtons() -> NSUInteger

pub unsafe fn doubleClickInterval() -> NSTimeInterval

pub unsafe fn keyRepeatDelay() -> NSTimeInterval

pub unsafe fn keyRepeatInterval() -> NSTimeInterval

pub unsafe fn addGlobalMonitorForEventsMatchingMask_handler( mask: NSEventMask, block: &Block<dyn Fn(NonNull<NSEvent>)> ) -> Option<Retained<AnyObject>>

Available on crate feature block2 only.

pub unsafe fn addLocalMonitorForEventsMatchingMask_handler( mask: NSEventMask, block: &Block<dyn Fn(NonNull<NSEvent>) -> *mut NSEvent> ) -> Option<Retained<AnyObject>>

Available on crate feature block2 only.

pub unsafe fn removeMonitor(event_monitor: &AnyObject)

impl NSEvent

Methods declared on superclass NSObject

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

pub unsafe fn new() -> Retained<Self>

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.

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 unsafe fn get_mut_ivar<T>(&mut self, name: &str) -> &mut T

where T: Encode,

👎Deprecated: this is difficult to use correctly, use Ivar::load_mut instead.

Available on crate feature NSAccessibilityConstants only.

Use Ivar::load_mut 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.

Trait Implementations

impl AsMut<AnyObject> for NSEvent

fn as_mut(&mut self) -> &mut AnyObject

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

impl AsMut<NSEvent> for NSEvent

fn as_mut(&mut self) -> &mut Self

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

impl AsMut<NSObject> for NSEvent

fn as_mut(&mut self) -> &mut NSObject

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

impl AsRef<AnyObject> for NSEvent

fn as_ref(&self) -> &AnyObject

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

impl AsRef<NSEvent> for NSEvent

fn as_ref(&self) -> &Self

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

impl AsRef<NSObject> for NSEvent

fn as_ref(&self) -> &NSObject

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

impl Borrow<AnyObject> for NSEvent

fn borrow(&self) -> &AnyObject

Immutably borrows from an owned value.

impl Borrow<NSObject> for NSEvent

fn borrow(&self) -> &NSObject

Immutably borrows from an owned value.

impl BorrowMut<AnyObject> for NSEvent

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

Mutably borrows from an owned value.

impl BorrowMut<NSObject> for NSEvent

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

Mutably borrows from an owned value.

impl ClassType for NSEvent

type Super = NSObject

The superclass of this class.

type Mutability = Immutable

Whether the type is mutable or immutable.

const NAME: &'static str = "NSEvent"

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

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.

fn as_super_mut(&mut self) -> &mut Self::Super

Get a mutable reference to the superclass.

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

where Self: IsRetainable + Sized,

Increment the reference count of the receiver.

fn alloc() -> Allocated<Self>

where Self: Sized + IsAllocableAnyThread,

Allocate a new instance of the class.

impl Debug for NSEvent

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

Formats the value using the given formatter.

impl Deref for NSEvent

type Target = NSObject

The resulting type after dereferencing.

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

Dereferences the value.

impl DerefMut for NSEvent

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl Hash for NSEvent

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 NSCoding for NSEvent

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

where Self: Sized + Message,

Available on crate feature NSCoder only.

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

where Self: Sized + Message,

Available on crate feature NSCoder only.

impl NSCopying for NSEvent

fn copy(&self) -> Retained<Self::Immutable>

where Self: Sized + Message + CounterpartOrSelf,

Returns a new instance that’s a copy of the receiver.

unsafe fn copyWithZone(&self, zone: *mut NSZone) -> Retained<Self::Immutable>

where Self: Sized + Message + CounterpartOrSelf,

Available on crate feature NSZone only.

Returns a new instance that’s a copy of the receiver.

impl NSObjectProtocol for NSEvent

fn isEqual(&self, other: &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,

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 NSEvent

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl RefEncode for NSEvent

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

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

impl Eq for NSEvent

impl Message for NSEvent

impl StructuralPartialEq for NSEvent