|
Log In | Not a Member? |
Contact ADC
|
|
ADC Home > Reference Library > Reference > Hardware & Drivers > Bluetooth > Bluetooth User Interface Framework Reference
|
IOBluetoothDeviceSelectorController |
| Inherits from: | |
| Declared In: |
A NSWindowController subclass to display a window to initiate pairing to other Bluetooth devices.
Implementation of a window controller to return a NSArray of selected bluetooth devices. This
class will handle connecting to the Bluetooth Daemon for the purposes of searches, and displaying
the results. This controller will return a NSArray of IOBluetoothDevice objects to the user.
addAllowedUUID: |
Adds a UUID to the list of UUIDs that are used to validate the user's selection.
- (void)addAllowedUUID:(IOBluetoothSDPUUID *)allowedUUID;
allowedUUIDThe 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.
addAllowedUUIDArray: |
Adds an array of UUIDs to the list of UUIDs that are used to validate the user's selection.
- (void)addAllowedUUIDArray:(NSArray *)allowedUUIDArray;
allowedUUIDArrayThe 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.
beginSheetModalForWindow:modalDelegate:didEndSelector:contextInfo: |
Runs the device selector panel as a sheet on the target window.
- (IOReturn)beginSheetModalForWindow:(NSWindow *)sheetWindow modalDelegate:(id)modalDelegate didEndSelector:(SEL)didEndSelector contextInfo:(void *)contextInfo;
sheetWindowmodalDelegatedidEndSelectorcontextInfoReturns kIOReturnSuccess if the sheet modal session was started.
This function works the same way as -[NSApplication beginSheet:modalForWindow:modalDelegate:didEndSelector:contextInfo:].
The didEndSelector has a similar prototype as in NSApplication except that the first argument is the
IOBluetoothDeviceSelectorController object instead of the window:
-(void)sheetDidEnd:(IOBluetoothDeviceSelectorController *)controller returnCode:(int)returnCode contextInfo:(void *)contextInfo.
The returnCode parameter will either be kIOBluetoothUISuccess or kIOBluetoothUIUserCancelledErr as described in
-runModal.
NOTE: This method is only available in Mac OS X 10.2.4 (Bluetooth v1.1) or later.
clearAllowedUUIDs |
Resets the controller back to the default state where it will accept any device the user selects.
- (void)clearAllowedUUIDs;
NOTE: This method is only available in Mac OS X 10.2.4 (Bluetooth v1.1) or later.
deviceSelector |
+ (IOBluetoothDeviceSelectorController *)deviceSelector;
A new instance of the device selector controller on success, nil on failure.
Method call to instantiate a new IOBluetoothDeviceSelectorController object.
getDescriptionText |
Returns the description text that appears in the device selector panel (i.e. what was set in -setDescriptionText:).
- (NSString *)getDescriptionText;
Returns the description text of the device selector panel.
NOTE: This method is only available in Mac OS X 10.2.4 (Bluetooth v1.1) or later.
getDeviceSelectorControllerRef |
Returns an IOBluetoothDeviceSelectorControllerRef representation of the target IOBluetoothDeviceSelectorController object.
- (IOBluetoothDeviceSelectorControllerRef)getDeviceSelectorControllerRef;
Returns an IOBluetoothDeviceSelectorControllerRef representation of the target IOBluetoothDeviceSelectorController object.
getOptions |
Returns the option bits that control the panel's behavior.
- (IOBluetoothServiceBrowserControllerOptions)getOptions;
Returns the option bits set by setOptions:
NOTE: This method is only available in Mac OS X 10.2.4 (Bluetooth v1.1) or later.
getPrompt |
Returns the title of the default/select button in the device selector panel (i.e. what was set in -setPrompt:).
- (NSString *)getPrompt;
Returns the default button title of the device selector panel.
NOTE: This method is only available in Mac OS X 10.2.4 (Bluetooth v1.1) or later.
getResults |
Returns the result of the user's selection.
- (NSArray *)getResults;
Returns an NSArray of IOBluetoothDevice objects corresponding to the user's selection. If the user cancelled the panel, nil will be returned.
There will only be results if the panel has been run, the user has successfully made a selection and that
selection has been validated. 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 will be supported.
NOTE: This method is only available in Mac OS X 10.2.4 (Bluetooth v1.1) or later.
getSearchAttributes |
Returns the search attributes that control the panel's search/inquiry behavior.
- (const IOBluetoothDeviceSearchAttributes *)getSearchAttributes;
Returns the search attributes set by setSearchAttributes:
NOTE: This method is only available in Mac OS X 10.2.4 (Bluetooth v1.1) or later.
getTitle |
Returns the title of the device selector panel (i.e. what was set in -setTitle:).
- (NSString *)getTitle;
Returns the title of the device selector panel.
NOTE: This method is only available in Mac OS X 10.2.4 (Bluetooth v1.1) or later.
runModal |
Runs the device selector panel in a modal session to allow the user to select a Bluetooth device.
- (int)runModal;
Returns kIOBluetoothUISuccess if a successful, validated device selection was made by the user. 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.
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), will this method return.
NOTE: This method is only available in Mac OS X 10.2.4 (Bluetooth v1.1) or later.
runPanelWithAttributes: |
-(NSArray *)runPanelWithAttributes:(IOBluetoothDeviceSearchAttributes *)attributes DEPRECATED_IN_BLUETOOTH_VERSION_2_0_AND_LATER;
attributesNSArray * of the selected IOBluetoothDevice objects.
***WARNING*** This method has been deprecated in favor of -setSearchAttributes:, -runModal and -getResults.
setDescriptionText: |
Sets the description text that appears in the device selector panel.
- (void)setDescriptionText:(NSString *)descriptionText;
descriptionTextThe 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.
setOptions: |
Sets the option bits that control the panel's behavior.
- (void)setOptions:(IOBluetoothServiceBrowserControllerOptions)options;
optionsThe service browser 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.
setPrompt: |
Sets the title of the default/select button in the device selector panel.
- (void)setPrompt:(NSString *)prompt;
promptThe 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.
setSearchAttributes: |
Sets the search attributes that control the panel's search/inquiry behavior.
- (void)setSearchAttributes:(const IOBluetoothDeviceSearchAttributes *)searchAttributes;
searchAttributesThe 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.
setTitle: |
Sets the title of the panel when not run as a sheet.
- (void)setTitle:(NSString *)windowTitle;
windowTitleThe 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.
withDeviceSelectorControllerRef: |
Method call to convert an IOBluetoothDeviceSelectorControllerRef into an IOBluetoothDeviceSelectorController *.
+ (IOBluetoothDeviceSelectorController *) withDeviceSelectorControllerRef:(IOBluetoothDeviceSelectorControllerRef)deviceSelectorControllerRef;
deviceSelectorControllerRefReturns the IOBluetoothDeviceSelectorController * for the given IOBluetoothDeviceSelectorControllerRef.
 |
||
|