Struct SFAuthorizationPluginView

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

Available on crate feature SFAuthorizationPluginView only.

SFAuthorizationPluginView is a class that you can use to insert an NSView into AuthorizationPlugin interfaces.

SFAuthorizationPluginView provides AuthorizationPlugin writers with an easy way to provide a user interface for their AuthorizationPlugin without having to duplicate the standard authentication dialog or the login window dialog. This class was designed to be subclassed by the AuthorizationPlugin writer. The following methods were designed to be overridden: buttonPressed:, didActivate, willActivateWithUser:, didDeactivate, firstKeyView, firstResponder, lastKeyView, setEnabled:, and viewForType:. In order to display the user interface, the AuthorizationPlugin should create an instance of your subclass and then call displayView. That will cause the appropriate dialog to be displayed and when credentials are needed, the overridden methods will be called in order to display the NSView provided by the subclass.

See also Apple’s documentation

Implementations

impl SFAuthorizationPluginView

pub unsafe fn initWithCallbacks_andEngineRef( this: Allocated<Self>, callbacks: *const AuthorizationCallbacks, engine_ref: AuthorizationEngineRef, ) -> Option<Retained<Self>>

Available on crate feature objc2-security only.

The initialization method of this class. You must provide the callbacks and engineRef that were provided to the AuthorizationPlugin and AuthorizationMechanismRef.

Parameter callbacks: The AuthorizationCallbacks provided to the AuthorizationPlugin.

Parameter engineRef: The AuthorizationEngineRef provided to the AuthorizationMechanismRef.

pub unsafe fn engineRef(&self) -> AuthorizationEngineRef

Available on crate feature objc2-security only.

An accessor method to the AuthorizationEngineRef provided to the init method. Use this value when calling the functions of the AuthorizationCallbacks when you need to set the result or set a context value.

pub unsafe fn callbacks(&self) -> *const AuthorizationCallbacks

Available on crate feature objc2-security only.

An accessor method to the AuthorizationEngineRef provided to the init method. Use this to get the function pointers to SetResult, SetContextValue, etc. See the AuthorizationCallbacks documentation for more details.

pub unsafe fn buttonPressed(&self, in_button_type: SFButtonType)

When a user presses a button, this method will be called to inform the SFAuthorizationPluginView of the user’s action. By default buttonPressed: will set a result of Deny when the OK or Login buttons are pressed.

If a user has pressed Login or OK button was pressed, the subclass needs to set the context values for the short name of the user so that user attributes can be looked up. Use kAuthorizationEnvironmentUsername as the key. The subclass should also set any additional context values that are needed by the authentication plugin to verify the user’s credentials.

Parameter inButtonType: the type of button that was pressed.

pub unsafe fn lastError(&self) -> Option<Retained<NSError>>

Called by the Apple provided SecurityAgent plugin to get a description of the error that occurred during evaluation. If no error occurred, the method should return nil.

A downstream mechanism that works in cooperation with the SFAuthorizationPluginView can set a context value using the kAuthorizationContextFlagSticky flag to make it available to the SFAuthorizationPluginView in case of an error.

pub unsafe fn didActivate(&self)

Called when the user interface was made active by the AuthorizationPlugin.

pub unsafe fn willActivateWithUser( &self, in_user_information: Option<&NSDictionary>, )

Called by the Apple provided SecurityAgent plugin before the UI is made active.

Parameter inUserInformation: is a dictionary contains the following information: kSFAuthorizationPluginViewUserNameKey - an NSString with the selected user’s name kSFAuthorizationPluginViewUserShortNameKey - an NSString with the selected user’s short name

The user name can be used to pre-populate a Text Field. NOTE: inUserInformation may be nil.

pub unsafe fn didDeactivate(&self)

Called when the user interface is deactivated by the AuthorizationPlugin.

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

When called by the AuthorizationPlugin, the subclass should return the first view in the keyboard loop of the NSView. The default value returned is nil.

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

When called by the AuthorizationPlugin, the subclass should return the view that should get the focus for keyboard events. The default value returned is nil.

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

When called by the AuthorizationPlugin, the subclass should return the last view in the keyboard loop for the view. The default value returned is nil.

pub unsafe fn setEnabled(&self, in_enabled: bool)

When called by the AuthorizationPlugin, the subclass should call setEnabled: on the controls that are in its view.

Parameter inEnabled: the state the controls should be in.

pub unsafe fn viewForType( &self, in_type: SFViewType, mtm: MainThreadMarker, ) -> Option<Retained<NSView>>

When called by the AuthorizationPlugin, the subclass should return the appropriate NSView for the requested SFViewType. The NSView and its contents should have the autoresize flags set as appropriate to allow for the view to be resized.

Parameter inType: is the type of view being requested by the AuthorizationPlugin.

NOTE: Currently a maximum width of 394 points is supported, but Apple reserves the right to change that in the future. Do not assume that the width of the NSView won’t change.

impl SFAuthorizationPluginView

Methods declared on superclass NSObject.

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

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

impl SFAuthorizationPluginView

SFHostControl. Methods called by the AuthorizationPlugin that instantiated the subclass or by the subclass.

pub unsafe fn displayView(&self)

displayView is called in order to display the user interface provided by the subclass. If you subclass this method, be sure to call [super displayView]. displayView will raise an SFDisplayViewException exception if an error occurs displaying the authorization dialog.

pub unsafe fn setButton_enabled( &self, in_button_type: SFButtonType, in_enabled: bool, )

The SFAuthorizationPluginView calls this when it would like to disable a button in the UI.

Parameter inButtonType: the type of the button

Parameter inEnabled: YES to enabled the button, NO to disable the button

pub unsafe fn updateView(&self)

updateView is called in order to have a new or modified NSView loaded by the AuthorizationPlugin.

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

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

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.

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

Trait Implementations

impl AsRef<AnyObject> for SFAuthorizationPluginView

fn as_ref(&self) -> &AnyObject

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

impl AsRef<NSObject> for SFAuthorizationPluginView

fn as_ref(&self) -> &NSObject

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

impl AsRef<SFAuthorizationPluginView> for SFAuthorizationPluginView

fn as_ref(&self) -> &Self

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

impl Borrow<AnyObject> for SFAuthorizationPluginView

fn borrow(&self) -> &AnyObject

Immutably borrows from an owned value.

impl Borrow<NSObject> for SFAuthorizationPluginView

fn borrow(&self) -> &NSObject

Immutably borrows from an owned value.

impl ClassType for SFAuthorizationPluginView

const NAME: &'static str = "SFAuthorizationPluginView"

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

type Super = NSObject

The superclass of this class.

type ThreadKind = <<SFAuthorizationPluginView as ClassType>::Super as ClassType>::ThreadKind

Whether the type can be used from any thread, or from only the main thread.

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.

impl Debug for SFAuthorizationPluginView

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

Formats the value using the given formatter.

impl Deref for SFAuthorizationPluginView

type Target = NSObject

The resulting type after dereferencing.

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

Dereferences the value.

impl Hash for SFAuthorizationPluginView

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 SFAuthorizationPluginView

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

where Self: Sized,

Increment the reference count of the receiver.

impl NSObjectProtocol for SFAuthorizationPluginView

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

👎Deprecated: use isKindOfClass directly, or cast your objects with AnyObject::downcast_ref

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 SFAuthorizationPluginView

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 SFAuthorizationPluginView

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

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

impl DowncastTarget for SFAuthorizationPluginView

impl Eq for SFAuthorizationPluginView