Struct CBIdentityPicker 

pub struct CBIdentityPicker { /* private fields */ }

Available on crate feature CBIdentityPicker only.

A CBIdentityPicker object allows a user to select identities—for example, user or group objects—that it wants one or more services or shared resources to have access to. An identity picker can be displayed either as an application-modal dialog or as a sheet attached to a document window. An identity picker returns the selected records to be added to access control lists using Collaboration. If a selected record is not a user or group identity, then an identity picker prompts the user for additional information—such as a password—to promote that record to a sharing account.

See also Apple’s documentation

Implementations

impl CBIdentityPicker

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

The title of the identity picker.

The value of this property is the title text that appears at the top of the panel. By default, the title is “Select a person to share with:”.

pub unsafe fn setTitle(&self, title: Option<&NSString>)

Setter for title.

This is copied when set.

pub unsafe fn allowsMultipleSelection(&self) -> bool

A Boolean value indicating whether the user is allowed to select multiple identities.

The value of this property is <doc ://com.apple.documentation/documentation/objectivec/yes> if the user can select multiple records; otherwise, <doc ://com.apple.documentation/documentation/objectivec/no>. The default value is <doc ://com.apple.documentation/documentation/objectivec/no>.

pub unsafe fn setAllowsMultipleSelection(&self, allows_multiple_selection: bool)

Setter for allowsMultipleSelection.

pub unsafe fn runModal(&self) -> NSInteger

Runs the receiver as an application-modal dialog.

The receiver may create identities for selected records if necessary.

• Returns: NSOKButton if the user selected OK; otherwise, NSCancelButton.

pub unsafe fn runModalForWindow_modalDelegate_didEndSelector_contextInfo( &self, window: &NSWindow, delegate: Option<&AnyObject>, did_end_selector: Option<Sel>, context_info: *mut c_void, )

👎Deprecated: Use runModalForWindow:completionHandler: instead.

Available on crate feature objc2-app-kit only.

Runs the receiver modally as a sheet attached to a specified window.

The didEndSelector parameter is a selector that takes three arguments. The corresponding method should have a declaration modeled on the following example:

- (void)identityPickerDidEnd:(CBIdentityPicker *)identityPicker returnCode:(NSInteger)returnCode contextInfo:(void *)contextInfo;

where the identityPicker argument is the identity picker object, the returnCode argument is the button the user clicked, and contextInfo is the same contextInfo argument that was passed in the original message.

• Parameters:

• window: The parent window for the sheet.

• delegate: The delegate for the modal session.

• didEndSelector: A message sent to the delegate after the user responds but before the sheet is dismissed.

• contextInfo: Contextual data passed to the delegate in the didEndSelector message.

Safety

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

pub unsafe fn runModalForWindow_completionHandler( &self, window: &NSWindow, completion_handler: Option<&DynBlock<dyn Fn(NSModalResponse)>>, )

Available on crate features block2 and objc2-app-kit only.

Runs the identity picker modally as a sheet attached to a specified window.

• Parameters:

• window: The parent window for the sheet.

• completionHandler: The handler to run after the return value is known, but before the sheet is dismissed.

pub unsafe fn identities(&self) -> Retained<NSArray<CBIdentity>>

Available on crate feature CBIdentity only.

The array of identities (represented by CBIdentity objects) selected using the identity picker.

impl CBIdentityPicker

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

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 CBIdentityPicker

fn as_ref(&self) -> &AnyObject

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

impl AsRef<CBIdentityPicker> for CBIdentityPicker

fn as_ref(&self) -> &Self

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

impl AsRef<NSObject> for CBIdentityPicker

fn as_ref(&self) -> &NSObject

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

impl Borrow<AnyObject> for CBIdentityPicker

fn borrow(&self) -> &AnyObject

Immutably borrows from an owned value.

impl Borrow<NSObject> for CBIdentityPicker

fn borrow(&self) -> &NSObject

Immutably borrows from an owned value.

impl ClassType for CBIdentityPicker

const NAME: &'static str = "CBIdentityPicker"

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

type Super = NSObject

The superclass of this class.

type ThreadKind = <<CBIdentityPicker 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 CBIdentityPicker

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

Formats the value using the given formatter.

impl Deref for CBIdentityPicker

type Target = NSObject

The resulting type after dereferencing.

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

Dereferences the value.

impl Hash for CBIdentityPicker

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 CBIdentityPicker

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

where Self: Sized,

Increment the reference count of the receiver.

impl NSObjectProtocol for CBIdentityPicker

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 CBIdentityPicker

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 CBIdentityPicker

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

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

impl DowncastTarget for CBIdentityPicker

impl Eq for CBIdentityPicker