Struct LAAuthenticationView

Source

pub struct LAAuthenticationView { /* private fields */ }

Available on crate feature LAAuthenticationView and crate feature objc2-app-kit and macOS only.

Expand description

Compact authentication view providing authentication similar to LAContextevaluatePolicy API.

This view is non-textual, it displays only a compact icon hinting users to use Touch ID or Watch to authenticate. The reason for the authentication must be apparent from the surrounding UI to avoid confusion and security risks.

The authentication is controlled using the provided authentication context. When evaluatePolicy or evaluateAccessControl is called on this context, the UI will be presented using this view rather than using the standard authentication alert. Since the view is designed for authentication with Touch ID or Watch the only supported policies for calling evaluatePolicy on the context are

LAPolicyDeviceOwnerAuthenticationWithBiometrics
LAPolicyDeviceOwnerAuthenticationWithCompanion
LAPolicyDeviceOwnerAuthenticationWitchBiometricsOrCompanion
LAPolicyDeviceOwnerAuthentication (This one is supported just for convenience. If neither biometric nor watch authentication is available, the evaluation of the policy fails)

Parameter context: LAContextinstance to control the authentication.

Source

pub unsafe fn initWithContext_controlSize( this: Allocated<Self>, context: &LAContext, control_size: NSControlSize, ) -> Retained<Self>

Creates a new view and pairs it with the specified authentication context.

The authentication is controlled using the provided authentication context. When evaluatePolicy or evaluateAccessControl is called on this context, the UI will be presented using this view rather than using the standard authentication alert. Since the view is designed for authentication with Touch ID or Watch the only supported policies for calling evaluatePolicy on the context are

LAPolicyDeviceOwnerAuthenticationWithBiometrics
LAPolicyDeviceOwnerAuthenticationWithCompanion
LAPolicyDeviceOwnerAuthenticationWitchBiometricsOrCompanion
LAPolicyDeviceOwnerAuthentication (This one is supported just for convenience. If neither biometric nor watch authentication is available, the evaluation of the policy fails)

Parameter context: LAContextinstance to control the authentication.

Parameter controlSize: Preferred size of LAAuthenticationViewprovided using NSControlSize

Source

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

LAContextinstance passed to the initializer.

Source

pub unsafe fn controlSize(&self) -> NSControlSize

NSControlSizeinstance passed to the initializer.

Source §

impl LAAuthenticationView

Methods declared on superclass NSResponder.

Source

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

Source §

impl LAAuthenticationView

Methods declared on superclass NSObject.

Source

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

Methods from Deref<Target = NSView>§

Source

pub fn window(&self) -> Option<Retained<NSWindow>>

Source

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

§Safety

This is not retained internally, you must ensure the object is still alive.

§Safety

This is not retained internally, you must ensure the object is still alive.

Source

pub fn isHidden(&self) -> bool

Source

pub fn setHidden(&self, hidden: bool)

Setter for isHidden.

Source

pub fn isHiddenOrHasHiddenAncestor(&self) -> bool

Source

pub unsafe fn getRectsBeingDrawn_count( &self, rects: mut const CGRect, count: *mut isize, )

§Safety

rects must be a valid pointer or null.
count must be a valid pointer or null.

Source

pub unsafe fn sortSubviewsUsingFunction_context( &self, compare: unsafe extern "C-unwind" fn(NonNull<NSView>, NonNull<NSView>, mut c_void) -> NSComparisonResult, context: mut c_void, )

§Safety

compare must be implemented correctly.
context must be a valid pointer or null.

Setter for postsFrameChangedNotifications.

Source

pub fn resizeSubviewsWithOldSize(&self, old_size: CGSize)

Source

Source

pub fn frame(&self) -> CGRect

Source

pub fn setFrame(&self, frame: CGRect)

Setter for frame.

Setter for bounds.

Setter for canDrawConcurrently.

Source

pub fn canDraw(&self) -> bool

👎Deprecated: If a view needs display, -drawRect: or -updateLayer will be called automatically when the view is able to draw. To check whether a view is in a window, call -window. To check whether a view is hidden, call -isHiddenOrHasHiddenAncestor.

Source

pub fn setNeedsDisplayInRect(&self, invalid_rect: CGRect)

Source

pub fn needsDisplay(&self) -> bool

Source

pub fn setAcceptsTouchEvents(&self, accepts_touch_events: bool)

👎Deprecated: Use allowedTouchTypes instead

Source

pub fn canDrawSubviewsIntoLayer(&self) -> bool

Source

pub fn setCanDrawSubviewsIntoLayer(&self, can_draw_subviews_into_layer: bool)

Setter for canDrawSubviewsIntoLayer.

Source

pub fn layoutSubtreeIfNeeded(&self)

Source

Setter for toolTip.

This is copied when set.

Source

pub unsafe fn addToolTipRect_owner_userData( &self, rect: CGRect, owner: &AnyObject, data: *mut c_void, ) -> isize

§Safety

owner should be of the correct type.
data must be a valid pointer or null.

Setter for preparedContentRect.

Source

pub fn allowsVibrancy(&self) -> bool

Source

pub fn viewDidChangeEffectiveAppearance(&self)

Override point for reacting to the effective appearance of the receiver changing. At this point effectiveAppearance property reflects the new appearance.

Source

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

§Safety

This is not retained internally, you must ensure the object is still alive.

Source

pub unsafe fn setNextKeyView(&self, next_key_view: Option<&NSView>)

Setter for nextKeyView.

Source

pub unsafe fn print(&self, sender: Option<&AnyObject>)

§Safety

sender should be of the correct type.

Source

pub unsafe fn knowsPageRange(&self, range: *mut NSRange) -> bool

§Safety

range must be a valid pointer.

§Safety

options generic should be of the correct type.

Setter for additionalSafeAreaInsets.

Source

pub fn safeAreaRect(&self) -> CGRect

Source

pub fn prefersCompactControlSizeMetrics(&self) -> bool

When this property is true, any NSControls in the view or its descendants will be sized with compact metrics compatible with macOS 15 and earlier. Defaults to false

Source

pub fn setPrefersCompactControlSizeMetrics( &self, prefers_compact_control_size_metrics: bool, )

Setter for prefersCompactControlSizeMetrics.

Source

👎Deprecated

Methods from Deref<Target = NSResponder>§

Source

pub unsafe fn nextResponder(&self) -> Option<Retained<NSResponder>>

§Safety

This is not retained internally, you must ensure the object is still alive.

Source

pub unsafe fn setNextResponder(&self, next_responder: Option<&NSResponder>)

Setter for nextResponder.

Source

pub fn becomeFirstResponder(&self) -> bool

Source

pub fn resignFirstResponder(&self) -> bool

Source

pub fn flushBufferedKeyEvents(&self)

Source

pub unsafe fn showContextHelp(&self, sender: Option<&AnyObject>)

§Safety

sender should be of the correct type.

Source

pub unsafe fn supplementalTargetForAction_sender( &self, action: Sel, sender: Option<&AnyObject>, ) -> Option<Retained<AnyObject>>

§Safety

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

Source

pub fn undoManager(&self) -> Option<Retained<NSUndoManager>>

Source

pub unsafe fn presentError_modalForWindow_delegate_didPresentSelector_contextInfo( &self, error: &NSError, window: &NSWindow, delegate: Option<&AnyObject>, did_present_selector: Option<Sel>, context_info: *mut c_void, )

§Safety

delegate should be of the correct type.
did_present_selector must be a valid selector.
context_info must be a valid pointer or null.

Source

pub fn presentError(&self, error: &NSError) -> bool

Source

pub fn willPresentError(&self, error: &NSError) -> Retained<NSError>

Source

pub fn performMnemonic(&self, string: &NSString) -> bool

👎Deprecated: This has always returned NO and had no effect on macOS

Methods from Deref<Target = NSObject>§

Source

pub fn doesNotRecognizeSelector(&self, sel: Sel) -> !

Handle messages the object doesn’t recognize.

See Apple’s documentation for details.

Methods from Deref<Target = AnyObject>§

Source

pub fn class(&self) -> &'static AnyClass

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

Source

pub unsafe fn get_ivar<T>(&self, name: &str) -> &T
where T: Encode,

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

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.

Source

pub fn downcast_ref<T>(&self) -> Option<&T>
where T: DowncastTarget,

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`
    }
}