Struct AXObserver 

pub struct AXObserver { /* private fields */ }

Available on crate feature AXUIElement only.

An AXObserverRef is a CFType. Like all CFTypes, they are reference counted (

 //apple_ref/c/func/CFRetain CFRetain

,

 //apple_ref/c/func/CFRelease CFRelease

).

See also Apple’s documentation

Implementations

impl AXObserver

pub unsafe fn create( application: pid_t, callback: AXObserverCallback, out_observer: NonNull<*mut AXObserver>, ) -> AXError

Available on crate features HIServices and AXError and libc only.

Creates a new observer that can receive notifications from the specified application.

When an observed notification is received, it is passed to

 AXObserverCallback AXObserverCallback

.

Parameter application: The process ID of the application.

Parameter callback: The callback function.

Parameter outObserver: On return, an AXObserverRef representing the observer object.

Returns: If unsuccessful, AXObserverCreate may return one of the following error codes, among others:

kAXErrorIllegalArgument

One or more of the arguments is an illegal value.

kAXErrorFailure

There is some sort of system memory failure.

Safety

• callback must be implemented correctly.
• out_observer must be a valid pointer.

pub unsafe fn create_with_info_callback( application: pid_t, callback: AXObserverCallbackWithInfo, out_observer: NonNull<*mut AXObserver>, ) -> AXError

Available on crate features HIServices and AXError and libc only.

Creates a new observer that can receive notifications with an information dictionary from the specified application.

When an observed notification is received, it is passed to

 AXObserverCallbackWithInfo AXObserverCallbackWithInfo

.

Parameter application: The process ID of the application.

Parameter callback: The callback function.

Parameter outObserver: On return, an AXObserverRef representing the observer object.

Returns: If unsuccessful, AXObserverCreateWithInfoCallback may return one of the following error codes, among others:

kAXErrorIllegalArgument

One or more of the arguments is an illegal value.

kAXErrorFailure

There is some sort of system memory failure.

Safety

• callback must be implemented correctly.
• out_observer must be a valid pointer.

pub unsafe fn add_notification( &self, element: &AXUIElement, notification: &CFString, refcon: *mut c_void, ) -> AXError

Available on crate features HIServices and AXError only.

Registers the specified observer to receive notifications from the specified accessibility object.

Parameter observer: The observer object created from a call to

 AXObserverCreate AXObserverCreate

.

Parameter element: The accessibility object for which to observe notifications.

Parameter notification: The name of the notification to observe.

Parameter refcon: Application-defined data passed to the callback when it is called.

Returns: If unsuccessful, AXObserverAddNotification may return one of the following error codes, among others:

kAXErrorInvalidUIElementObserver

The observer is not a valid AXObserverRef type.

kAXErrorIllegalArgument

One or more of the arguments is an illegal value or the length of the notification name is greater than 1024.

kAXErrorNotificationUnsupported

The accessibility object does not support notifications (note that the system-wide accessibility object does not support notifications).

kAXErrorNotificationAlreadyRegistered

The notification has already been registered.

kAXErrorCannotComplete

The function cannot complete because messaging has failed in some way.

kAXErrorFailure

There is some sort of system memory failure.

Safety

refcon must be a valid pointer or null.

pub unsafe fn remove_notification( &self, element: &AXUIElement, notification: &CFString, ) -> AXError

Available on crate features HIServices and AXError only.

Removes the specified notification from the list of notifications the observer wants to receive from the accessibility object.

Parameter observer: The observer object created from a call to

 AXObserverCreate AXObserverCreate

.

Parameter element: The accessibility object for which this observer observes notifications.

Parameter notification: The name of the notification to remove from the list of observed notifications.

Returns: If unsuccessful, AXObserverRemoveNotification may return one of the following error codes, among others:

kAXErrorInvalidUIElementObserver

The observer is not a valid AXObserverRef type.

kAXErrorIllegalArgument

One or more of the arguments is an illegal value or the length of the notification name is greater than 1024.

kAXErrorNotificationUnsupported

The accessibility object does not support notifications (note that the system-wide accessibility object does not support notifications).

kAXErrorNotificationNotRegistered

This observer has not registered for any notifications.

kAXErrorCannotComplete

The function cannot complete because messaging has failed in some way.

kAXErrorFailure

There is some sort of system memory failure.

pub unsafe fn run_loop_source(&self) -> CFRetained<CFRunLoopSource>

Available on crate feature HIServices only.

Returns the observer’s run loop source.

The observer must be added to a run loop before it can receive notifications. Note that releasing the AXObserverRef automatically removes the run loop source from the run loop (you can also do this explicitly by calling

 //apple_ref/c/func/CFRunLoopRemoveSource CFRunLoopRemoveSource

).

AXObserverGetRunLoopSource might be used in code in this way:

CFRunLoopAddSource(CFRunLoopGetCurrent(), AXObserverGetRunLoopSource(observer), kCFRunLoopDefaultMode);

Parameter observer: The observer object (created from a call to

 AXObserverCreate AXObserverCreate

) for which to get the run loop source.

Returns: Returns the CFRunLoopSourceRef of the observer; NIL if you pass NIL in observer .

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<AXObserver> for AXObserver

Available on crate feature HIServices only.

fn as_ref(&self) -> &Self

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

impl AsRef<AnyObject> for AXObserver

Available on crate feature HIServices only.

fn as_ref(&self) -> &AnyObject

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

impl AsRef<CFType> for AXObserver

Available on crate feature HIServices only.

fn as_ref(&self) -> &CFType

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

impl Borrow<AnyObject> for AXObserver

Available on crate feature HIServices only.

fn borrow(&self) -> &AnyObject

Immutably borrows from an owned value.

impl Borrow<CFType> for AXObserver

Available on crate feature HIServices only.

fn borrow(&self) -> &CFType

Immutably borrows from an owned value.

impl ConcreteType for AXObserver

Available on crate feature HIServices only.

fn type_id() -> CFTypeID

Returns the unique type identifier for the AXObserverRef type.

Returns: Returns the CFTypeID of the AXObserverRef type.

impl Debug for AXObserver

Available on crate feature HIServices only.

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

Formats the value using the given formatter.

impl Deref for AXObserver

Available on crate feature HIServices only.

type Target = CFType

The resulting type after dereferencing.

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

Dereferences the value.

impl Hash for AXObserver

Available on crate feature HIServices only.

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 AXObserver

Available on crate feature HIServices only.

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

where Self: Sized,

Increment the reference count of the receiver.

impl PartialEq for AXObserver

Available on crate feature HIServices only.

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 AXObserver

Available on crate feature HIServices only.

const ENCODING_REF: Encoding

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

impl Type for AXObserver

Available on crate feature HIServices only.

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 AXObserver

Available on crate feature HIServices only.