Struct CGEvent 

pub struct CGEvent { /* private fields */ }

Available on crate feature CGEventTypes only.

Apple’s documentation

Implementations

impl CGEvent

pub fn new(source: Option<&CGEventSource>) -> Option<CFRetained<CGEvent>>

Available on crate feature CGEvent only.

pub fn new_data( allocator: Option<&CFAllocator>, event: Option<&CGEvent>, ) -> Option<CFRetained<CFData>>

Available on crate feature CGEvent only.

pub fn from_data( allocator: Option<&CFAllocator>, data: Option<&CFData>, ) -> Option<CFRetained<CGEvent>>

Available on crate feature CGEvent only.

pub fn new_mouse_event( source: Option<&CGEventSource>, mouse_type: CGEventType, mouse_cursor_position: CGPoint, mouse_button: CGMouseButton, ) -> Option<CFRetained<CGEvent>>

Available on crate feature CGEvent only.

pub fn new_keyboard_event( source: Option<&CGEventSource>, virtual_key: CGKeyCode, key_down: bool, ) -> Option<CFRetained<CGEvent>>

Available on crate features CGEvent and CGRemoteOperation only.

pub fn new_scroll_wheel_event2( source: Option<&CGEventSource>, units: CGScrollEventUnit, wheel_count: u32, wheel1: i32, wheel2: i32, wheel3: i32, ) -> Option<CFRetained<CGEvent>>

Available on crate feature CGEvent only.

pub fn new_copy(event: Option<&CGEvent>) -> Option<CFRetained<CGEvent>>

Available on crate feature CGEvent only.

pub fn new_source_from_event( event: Option<&CGEvent>, ) -> Option<CFRetained<CGEventSource>>

Available on crate feature CGEvent only.

pub fn set_source(event: Option<&CGEvent>, source: Option<&CGEventSource>)

Available on crate feature CGEvent only.

pub fn type(event: Option<&CGEvent>) -> CGEventType

Available on crate feature CGEvent only.

pub fn set_type(event: Option<&CGEvent>, type: CGEventType)

Available on crate feature CGEvent only.

pub fn timestamp(event: Option<&CGEvent>) -> CGEventTimestamp

Available on crate feature CGEvent only.

pub fn set_timestamp(event: Option<&CGEvent>, timestamp: CGEventTimestamp)

Available on crate feature CGEvent only.

pub fn location(event: Option<&CGEvent>) -> CGPoint

Available on crate feature CGEvent only.

pub fn unflipped_location(event: Option<&CGEvent>) -> CGPoint

Available on crate feature CGEvent only.

pub fn set_location(event: Option<&CGEvent>, location: CGPoint)

Available on crate feature CGEvent only.

pub fn flags(event: Option<&CGEvent>) -> CGEventFlags

Available on crate feature CGEvent only.

pub fn set_flags(event: Option<&CGEvent>, flags: CGEventFlags)

Available on crate feature CGEvent only.

pub unsafe fn keyboard_get_unicode_string( event: Option<&CGEvent>, max_string_length: c_ulong, actual_string_length: *mut c_ulong, unicode_string: *mut u16, )

Available on crate feature CGEvent only.

Safety

• actual_string_length must be a valid pointer or null.
• unicode_string must be a valid pointer or null.

pub unsafe fn keyboard_set_unicode_string( event: Option<&CGEvent>, string_length: c_ulong, unicode_string: *const u16, )

Available on crate feature CGEvent only.

Safety

unicode_string must be a valid pointer or null.

pub fn integer_value_field(event: Option<&CGEvent>, field: CGEventField) -> i64

Available on crate feature CGEvent only.

pub fn set_integer_value_field( event: Option<&CGEvent>, field: CGEventField, value: i64, )

Available on crate feature CGEvent only.

pub fn double_value_field( event: Option<&CGEvent>, field: CGEventField, ) -> c_double

Available on crate feature CGEvent only.

pub fn set_double_value_field( event: Option<&CGEvent>, field: CGEventField, value: c_double, )

Available on crate feature CGEvent only.

pub unsafe fn tap_create( tap: CGEventTapLocation, place: CGEventTapPlacement, options: CGEventTapOptions, events_of_interest: CGEventMask, callback: CGEventTapCallBack, user_info: *mut c_void, ) -> Option<CFRetained<CFMachPort>>

Available on crate feature CGEvent only.

Safety

• callback must be implemented correctly.
• user_info must be a valid pointer or null.

pub unsafe fn tap_create_for_psn( process_serial_number: NonNull<c_void>, place: CGEventTapPlacement, options: CGEventTapOptions, events_of_interest: CGEventMask, callback: CGEventTapCallBack, user_info: *mut c_void, ) -> Option<CFRetained<CFMachPort>>

Available on crate feature CGEvent only.

Safety

• process_serial_number must be a valid pointer.
• callback must be implemented correctly.
• user_info must be a valid pointer or null.

pub unsafe fn tap_create_for_pid( pid: pid_t, place: CGEventTapPlacement, options: CGEventTapOptions, events_of_interest: CGEventMask, callback: CGEventTapCallBack, user_info: *mut c_void, ) -> Option<CFRetained<CFMachPort>>

Available on crate features CGEvent and libc only.

Safety

• callback must be implemented correctly.
• user_info must be a valid pointer or null.

pub fn tap_enable(tap: &CFMachPort, enable: bool)

Available on crate feature CGEvent only.

pub fn tap_is_enabled(tap: &CFMachPort) -> bool

Available on crate feature CGEvent only.

pub unsafe fn tap_post_event(proxy: CGEventTapProxy, event: Option<&CGEvent>)

Available on crate feature CGEvent only.

Safety

proxy must be a valid pointer or null.

pub fn post(tap: CGEventTapLocation, event: Option<&CGEvent>)

Available on crate feature CGEvent only.

pub unsafe fn post_to_psn( process_serial_number: *mut c_void, event: Option<&CGEvent>, )

Available on crate feature CGEvent only.

Safety

process_serial_number must be a valid pointer or null.

pub fn post_to_pid(pid: pid_t, event: Option<&CGEvent>)

Available on crate features CGEvent and libc only.

Methods from Deref<Target = CFType>

pub fn downcast_ref<T>(&self) -> Option<&T>

where T: ConcreteType,

Attempt to downcast the type to that of type T.

This is the reference-variant. Use CFRetained::downcast if you want to convert a retained type. See also ConcreteType for more details on which types support being converted to.

pub fn retain_count(&self) -> usize

Get the reference count of the object.

This function may be useful for debugging. You normally do not use this function otherwise.

Beware that some things (like CFNumbers, small CFStrings etc.) may not have a normal retain count for optimization purposes, and can return usize::MAX in that case.

Trait Implementations

impl AsRef<AnyObject> for CGEvent

fn as_ref(&self) -> &AnyObject

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

impl AsRef<CFType> for CGEvent

fn as_ref(&self) -> &CFType

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

impl AsRef<CGEvent> for CGEvent

fn as_ref(&self) -> &Self

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

impl Borrow<AnyObject> for CGEvent

fn borrow(&self) -> &AnyObject

Immutably borrows from an owned value.

impl Borrow<CFType> for CGEvent

fn borrow(&self) -> &CFType

Immutably borrows from an owned value.

impl ConcreteType for CGEvent

Available on crate feature CGEvent only.

fn type_id() -> CFTypeID

Get the unique CFTypeID identifier for the type.

impl Debug for CGEvent

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

Formats the value using the given formatter.

impl Deref for CGEvent

type Target = CFType

The resulting type after dereferencing.

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

Dereferences the value.

impl Hash for CGEvent

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 CGEvent

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

where Self: Sized,

Increment the reference count of the receiver.

impl PartialEq for CGEvent

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 CGEvent

const ENCODING_REF: Encoding

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

impl Type for CGEvent

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

where Self: Sized,

Increment the reference count of the receiver.

fn as_concrete_TypeRef(&self) -> &Self

👎Deprecated:

this is redundant

Helper for easier transition from the core-foundation crate.

unsafe fn wrap_under_get_rule(ptr: *const Self) -> CFRetained<Self>

where Self: Sized,

👎Deprecated:

use CFRetained::retain

Helper for easier transition from the core-foundation crate.

fn as_CFTypeRef(&self) -> &CFType

where Self: AsRef<CFType>,

👎Deprecated:

this is redundant (CF types deref to CFType)

Helper for easier transition from the core-foundation crate.

unsafe fn wrap_under_create_rule(ptr: *const Self) -> CFRetained<Self>

where Self: Sized,

👎Deprecated:

use CFRetained::from_raw

Helper for easier transition from the core-foundation crate.

impl Eq for CGEvent