Struct IOBluetoothPairingController 

pub struct IOBluetoothPairingController { /* private fields */ }

Available on crate feature IOBluetoothPairingController only.

A NSWindowController subclass to display a window to initiate pairing to other bluetooth devices.

Implementation of a window controller to handle pairing with a bluetooth device. This class will handle connecting to the Bluetooth Daemon for the purposes of searches, and displaying the results. When necessary this class will display a sheet asking the user for a PIN code. This window will not return anything to the caller if it is canceled or if pairing occurs.

See also Apple’s documentation

Implementations

impl IOBluetoothPairingController

pub unsafe fn pairingController( mtm: MainThreadMarker, ) -> Option<Retained<IOBluetoothPairingController>>

Available on crate feature objc2 only.

Method call to instantiate a new IOBluetoothPairingController object.

Returns: An IOBluetoothPairingController instance. Call runPanelWithAttributes

Success - a new instance of the Pairing Controller Failure - nil

pub unsafe fn runModal(&self) -> c_int

Available on crate feature objc2 only.

Runs the pairing panel in a modal session to allow the user to select a Bluetooth device.

The controller will use the panel attributes to filter what devices the user sees. The allowed UUIDs will be used to validate the selection the user makes. Only when a selection has been validated (or the panel cancelled) and the device paired, will this method return.

NOTE: This method is only available in Mac OS X 10.2.4 (Bluetooth v1.1) or later.

Returns: Returns kIOBluetoothUISuccess if a successful, validated device selection was made by the user and that device successfully paired. Returns kIOBluetoothUIUserCanceledErr if the user cancelled the panel. These return values are the same as NSRunStoppedResponse and NSRunAbortedResponse respectively. They are the standard values used in a modal session.

pub unsafe fn getResults(&self) -> Option<Retained<NSArray>>

Available on crate feature objc2 only.

Returns an NSArray of the devices that were paired.

There will only be results if the panel has been run, the user has successfully made a selection, that selection has been validated and the selected device paired. If kIOBluetoothUISuccess was returned for the session, there should be valid results. Currently only a single device is allowed to be selected, so the results array will only contain one object. However in the future multiple selection may be supported.

NOTE: This method is only available in Mac OS X 10.2.4 (Bluetooth v1.1) or later.

Returns: Returns an NSArray of IOBluetoothDevice objects of devices that were paired. If the user cancelled the panel, nil will be returned.

pub unsafe fn setOptions( &self, options: IOBluetoothServiceBrowserControllerOptions, )

Available on crate features objc2 and IOBluetoothUIUserLib only.

Sets the option bits that control the panel’s behavior.

The pairing controller options control the behavior of the panel. Currently kIOBluetoothServiceBrowserControllerOptionsAutoStartInquiry is the only supported option. In the future more options will be added to control things like whether the connection to the device is closed when the controller is finished or if multiple selection is allowed.

NOTE: This method is only available in Mac OS X 10.2.4 (Bluetooth v1.1) or later.

Parameter options: Options to control the panel’s behavior.

pub unsafe fn getOptions(&self) -> IOBluetoothServiceBrowserControllerOptions

Available on crate features objc2 and IOBluetoothUIUserLib only.

Returns the option bits that control the panel’s behavior.

NOTE: This method is only available in Mac OS X 10.2.4 (Bluetooth v1.1) or later.

Returns: Returns the option bits set by setOptions:

pub unsafe fn setSearchAttributes( &self, search_attributes: *const IOBluetoothDeviceSearchAttributes, )

Available on crate features objc2 and objc2-io-bluetooth only.

Sets the search attributes that control the panel’s search/inquiry behavior.

The device search attributes control the inquiry behavior of the panel. They allow only devices that match the specified attributes (i.e. class of device) to be displayed to the user. Note that this only covers attributes returned in an inquiry result and not actual SDP services on the device.

NOTE: This method is only available in Mac OS X 10.2.4 (Bluetooth v1.1) or later.

Parameter searchAttributes: Attributes to control the panel’s inquiry behavior.

Safety

search_attributes must be a valid pointer.

pub unsafe fn getSearchAttributes( &self, ) -> *const IOBluetoothDeviceSearchAttributes

Available on crate features objc2 and objc2-io-bluetooth only.

Returns the search attributes that control the panel’s search/inquiry behavior.

NOTE: This method is only available in Mac OS X 10.2.4 (Bluetooth v1.1) or later.

Returns: Returns the search attributes set by setSearchAttributes:

Safety

The returned struct field 4 struct field 2 Array TODO.

pub unsafe fn addAllowedUUID(&self, allowed_uuid: Option<&IOBluetoothSDPUUID>)

Available on crate features objc2 and objc2-io-bluetooth only.

Adds a UUID to the list of UUIDs that are used to validate the user’s selection.

The user’s device selection gets validated against the UUIDs passed to -addAllowedUUID: addAllowedUUIDArray:. Each call to those methods essentially adds a filter that the selected device gets validated with. If any of the filters match, the device is considered valid. If they all fail, the device is not valid and the user is presented with an error code that the device does not support the required services. The UUID passed to -addAllowedUUID: is the only UUID that must be present in the device’s SDP service records. Alternatively, all of the UUIDs in the UUID array passed to -addAllowedUUIDArray must be present.

NOTE: This method is only available in Mac OS X 10.2.4 (Bluetooth v1.1) or later.

Parameter allowedUUID: UUID that a device may contain to be selected

Safety

allowed_uuid might not allow None.

pub unsafe fn addAllowedUUIDArray(&self, allowed_uuid_array: Option<&NSArray>)

Available on crate feature objc2 only.

Adds an array of UUIDs to the list of UUIDs that are used to validate the user’s selection.

The user’s device selection gets validated against the UUIDs passed to -addAllowedUUID: addAllowedUUIDArray:. Each call to those methods essentially adds a filter that the selected device gets validated with. If any of the filters match, the device is considered valid. If they all fail, the device is not valid and the user is presented with an error code that the device does not support the required services. The UUID passed to -addAllowedUUID: is the only UUID that must be present in the device’s SDP service records. Alternatively, all of the UUIDs in the UUID array passed to -addAllowedUUIDArray must be present.

NOTE: This method is only available in Mac OS X 10.2.4 (Bluetooth v1.1) or later.

Parameter allowedUUIDArray: An NSArray of UUIDs that all must be present in a device for it to be selectable.

Safety

• allowed_uuid_array generic should be of the correct type.
• allowed_uuid_array might not allow None.

pub unsafe fn clearAllowedUUIDs(&self)

Available on crate feature objc2 only.

Resets the controller back to the default state where it will accept any device the user selects.

NOTE: This method is only available in Mac OS X 10.2.4 (Bluetooth v1.1) or later.

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

Available on crate feature objc2 only.

Sets the title of the panel when not run as a sheet.

The panel title should be localized for best user experience.

NOTE: This method is only available in Mac OS X 10.2.4 (Bluetooth v1.1) or later.

Parameter windowTitle: Title of the device selector panel.

Safety

window_title might not allow None.

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

Available on crate feature objc2 only.

Returns the title of the device selector panel (i.e. what was set in -setTitle:).

NOTE: This method is only available in Mac OS X 10.2.4 (Bluetooth v1.1) or later.

Returns: Returns the title of the device selector panel.

pub unsafe fn setDescriptionText(&self, description_text: Option<&NSString>)

Available on crate feature objc2 only.

Sets the description text that appears in the device selector panel.

The description text should be localized for best user experience.

NOTE: This method is only available in Mac OS X 10.2.4 (Bluetooth v1.1) or later.

Parameter descriptionText: String that appears in the description section of the device selector panel.

Safety

description_text might not allow None.

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

Available on crate feature objc2 only.

Returns the description text that appears in the device selector panel (i.e. what was set in -setDescriptionText:).

NOTE: This method is only available in Mac OS X 10.2.4 (Bluetooth v1.1) or later.

Returns: Returns the description text of the device selector panel.

pub unsafe fn setPrompt(&self, prompt: Option<&NSString>)

Available on crate feature objc2 only.

Sets the title of the default/select button in the device selector panel.

The prompt text should be localized for best user experience.

NOTE: This method is only available in Mac OS X 10.2.4 (Bluetooth v1.1) or later.

Parameter prompt: String that appears in the default/select button in the device selector panel.

Safety

prompt might not allow None.

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

Available on crate feature objc2 only.

Returns the title of the default/select button in the device selector panel (i.e. what was set in -setPrompt:).

NOTE: This method is only available in Mac OS X 10.2.4 (Bluetooth v1.1) or later.

Returns: Returns the default button title of the device selector panel.

impl IOBluetoothPairingController

Methods declared on superclass NSWindowController.

pub unsafe fn initWithWindow( this: Allocated<Self>, window: Option<&NSWindow>, ) -> Retained<Self>

Available on crate feature objc2 only.

pub unsafe fn initWithCoder( this: Allocated<Self>, coder: &NSCoder, ) -> Option<Retained<Self>>

Available on crate feature objc2 only.

Safety

coder possibly has further requirements.

pub unsafe fn initWithWindowNibName( this: Allocated<Self>, window_nib_name: &NSNibName, ) -> Retained<Self>

Available on crate feature objc2 only.

pub unsafe fn initWithWindowNibName_owner( this: Allocated<Self>, window_nib_name: &NSNibName, owner: &AnyObject, ) -> Retained<Self>

Available on crate feature objc2 only.

Safety

owner should be of the correct type.

pub unsafe fn initWithWindowNibPath_owner( this: Allocated<Self>, window_nib_path: &NSString, owner: &AnyObject, ) -> Retained<Self>

Available on crate feature objc2 only.

Safety

owner should be of the correct type.

impl IOBluetoothPairingController

Methods declared on superclass NSResponder.

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

Available on crate feature objc2 only.

impl IOBluetoothPairingController

Methods declared on superclass NSObject.

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

Available on crate feature objc2 only.

Methods from Deref<Target = NSWindowController>

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

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

pub fn owner(&self) -> Option<Retained<AnyObject>>

pub fn windowFrameAutosaveName(&self) -> Retained<NSString>

pub fn setWindowFrameAutosaveName(&self, window_frame_autosave_name: &NSString)

Setter for windowFrameAutosaveName.

This is copied when set.

pub fn shouldCascadeWindows(&self) -> bool

pub fn setShouldCascadeWindows(&self, should_cascade_windows: bool)

Setter for shouldCascadeWindows.

pub unsafe fn document(&self) -> Option<Retained<AnyObject>>

Safety

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

pub unsafe fn setDocument(&self, document: Option<&AnyObject>)

Setter for document.

Safety

• document should be of the correct type.
• This is unretained, you must ensure the object is kept alive while in use.

pub fn setDocumentEdited(&self, dirty_flag: bool)

pub fn shouldCloseDocument(&self) -> bool

pub fn setShouldCloseDocument(&self, should_close_document: bool)

Setter for shouldCloseDocument.

pub fn synchronizeWindowTitleWithDocumentName(&self)

pub fn windowTitleForDocumentDisplayName( &self, display_name: &NSString, ) -> Retained<NSString>

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

pub fn setWindow(&self, window: Option<&NSWindow>)

Setter for window.

pub fn isWindowLoaded(&self) -> bool

pub fn windowWillLoad(&self)

pub fn windowDidLoad(&self)

pub fn loadWindow(&self)

pub fn close(&self)

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

Safety

sender should be of the correct type.

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

Safety

sender should be of the correct type.

Methods from Deref<Target = NSResponder>

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

Safety

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

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

Setter for nextResponder.

Safety

This is unretained, you must ensure the object is kept alive while in use.

pub unsafe fn tryToPerform_with( &self, action: Sel, object: Option<&AnyObject>, ) -> bool

Safety

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

pub unsafe fn noResponderFor(&self, event_selector: Sel)

Safety

event_selector must be a valid selector.

pub fn acceptsFirstResponder(&self) -> bool

pub fn becomeFirstResponder(&self) -> bool

pub fn resignFirstResponder(&self) -> bool

pub fn flushBufferedKeyEvents(&self)

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

Safety

sender should be of the correct type.

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.

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

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.

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

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

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

Safety

sender should be of the correct type.

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

Safety

sender should be of the correct type.

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

Safety

sender should be of the correct type.

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

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

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 IOBluetoothPairingController

Available on crate feature objc2 only.

fn as_ref(&self) -> &AnyObject

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

impl AsRef<IOBluetoothPairingController> for IOBluetoothPairingController

Available on crate feature objc2 only.

fn as_ref(&self) -> &Self

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

impl AsRef<NSObject> for IOBluetoothPairingController

Available on crate feature objc2 only.

fn as_ref(&self) -> &NSObject

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

impl AsRef<NSResponder> for IOBluetoothPairingController

Available on crate feature objc2 only.

fn as_ref(&self) -> &NSResponder

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

impl AsRef<NSWindowController> for IOBluetoothPairingController

Available on crate feature objc2 only.

fn as_ref(&self) -> &NSWindowController

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

impl Borrow<AnyObject> for IOBluetoothPairingController

Available on crate feature objc2 only.

fn borrow(&self) -> &AnyObject

Immutably borrows from an owned value.

impl Borrow<NSObject> for IOBluetoothPairingController

Available on crate feature objc2 only.

fn borrow(&self) -> &NSObject

Immutably borrows from an owned value.

impl Borrow<NSResponder> for IOBluetoothPairingController

Available on crate feature objc2 only.

fn borrow(&self) -> &NSResponder

Immutably borrows from an owned value.

impl Borrow<NSWindowController> for IOBluetoothPairingController

Available on crate feature objc2 only.

fn borrow(&self) -> &NSWindowController

Immutably borrows from an owned value.

impl ClassType for IOBluetoothPairingController

Available on crate feature objc2 only.

const NAME: &'static str = "IOBluetoothPairingController"

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

type Super = NSWindowController

The superclass of this class.

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

Available on crate feature objc2 only.

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

Formats the value using the given formatter.

impl Deref for IOBluetoothPairingController

Available on crate feature objc2 only.

type Target = NSWindowController

The resulting type after dereferencing.

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

Dereferences the value.

impl Hash for IOBluetoothPairingController

Available on crate feature objc2 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 IOBluetoothPairingController

Available on crate feature objc2 only.

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

where Self: Sized,

Increment the reference count of the receiver.

impl NSCoding for IOBluetoothPairingController

Available on crate feature objc2 only.

unsafe fn encodeWithCoder(&self, coder: &NSCoder)

where Self: Sized + Message,

Safety

unsafe fn initWithCoder( this: Allocated<Self>, coder: &NSCoder, ) -> Option<Retained<Self>>

where Self: Sized + Message,

Safety

impl NSObjectProtocol for IOBluetoothPairingController

Available on crate feature objc2 only.

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 NSSeguePerforming for IOBluetoothPairingController

Available on crate feature objc2 only.

unsafe fn prepareForSegue_sender( &self, segue: &NSStoryboardSegue, sender: Option<&AnyObject>, )

where Self: Sized + Message,

Safety

unsafe fn performSegueWithIdentifier_sender( &self, identifier: &NSString, sender: Option<&AnyObject>, )

where Self: Sized + Message,

Safety

unsafe fn shouldPerformSegueWithIdentifier_sender( &self, identifier: &NSString, sender: Option<&AnyObject>, ) -> bool

where Self: Sized + Message,

Safety

impl PartialEq for IOBluetoothPairingController

Available on crate feature objc2 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 IOBluetoothPairingController

Available on crate feature objc2 only.

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

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

impl DowncastTarget for IOBluetoothPairingController

Available on crate feature objc2 only.

impl Eq for IOBluetoothPairingController

Available on crate feature objc2 only.