Struct IOBluetoothObjectPushUIController 

pub struct IOBluetoothObjectPushUIController { /* private fields */ }

Available on crate feature IOBluetoothObjectPushUIController only.

An NSWindowController subclass that supports the creation of an IOBluetoothObjectPushUIController object.

See also Apple’s documentation

Implementations

impl IOBluetoothObjectPushUIController

pub unsafe fn initObjectPushWithBluetoothDevice_withFiles_delegate( this: Allocated<Self>, in_device: Option<&IOBluetoothDevice>, in_files: Option<&NSArray>, in_delegate: Option<&AnyObject>, ) -> Option<Retained<IOBluetoothObjectPushUIController>>

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

Creates and returns a new IOBluetoothObjectPush object

The event delegate should implement a single delegate method:

• (void) objectPushComplete: (IOBluetoothObjectPushUIController*) inPusher

The method will be called when the transaction is complete and should be used to release the push object by the delegate. If no delegate is set the object will release itself when the transfer is finished.

Parameter inDevice: The remote device to send the files to

Parameter inFiles: An array of file paths to send

Parameter inDelegate: A delegate object that implements the single method above. If no delegate is specified this object will release itself when the transaction is complete.

Returns: An IOBluetoothObjectPushUIController object on success, nil on fail.

Safety

• in_device might not allow None.
• in_files generic should be of the correct type.
• in_files might not allow None.
• in_delegate should be of the correct type.
• in_delegate might not allow None.

pub unsafe fn runModal(&self)

Available on crate feature objc2 only.

Runs the transfer UI panel in a modal session

Returns when the modal session has ended. This object will call back over the delegate method (above) when the transfer is complete. Users should release the object then. If no delegate is set the object will release itself.

Returns: The call will stall in this method until the modal session is complete.

pub unsafe fn runPanel(&self)

Available on crate feature objc2 only.

Runs the transfer UI as a panel with no modal session

Returns immediately. The object will callback over the delegate method (above) when the transfer is completed. If no delegate is set the object will release itself.

Returns: The method will return immediately.

pub unsafe fn beginSheetModalForWindow_modalDelegate_didEndSelector_contextInfo( &self, sheet_window: Option<&NSWindow>, modal_delegate: Option<&AnyObject>, did_end_selector: Option<Sel>, context_info: *mut c_void, ) -> c_int

Available on crate feature objc2 only.

Runs the transfer UI as a sheet on the target window.

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.

Parameter sheetWindow: NSWindow to attach the device selector panel to as a sheet.

Parameter modalDelegate: Delegate object that gets sent the didEndSelector when the sheet modal session is finished.

Parameter didEndSelector: Selector sent to the modalDelegate when the sheet modal session is finished.

Parameter contextInfo: User-definied value passed to the modalDelegate in the didEndSelector.

Returns: Returns kIOReturnSuccess if the sheet modal session was started.

Safety

• sheet_window might not allow None.
• modal_delegate should be of the correct type.
• modal_delegate might not allow None.
• did_end_selector must be a valid selector.
• context_info must be a valid pointer.

pub unsafe fn stop(&self)

Available on crate feature objc2 only.

Stops the transfer UI

Returns immediately. The object will callback over the delegate method (above) when the transfer is completed, or will release itself if no delegate is set.

Returns: The method will return immediately.

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.

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 transfer panel (i.e. what was set in -setTitle:).

Returns: Returns the title of the transfer panel.

pub unsafe fn setIconImage(&self, image: Option<&NSImage>)

Available on crate feature objc2 only.

Manually sets the icon used in the panel.

The panel icon should be set to the icon of the calling application. If not set, the panel will try to load up the correct icon for the target device, and will default to the icon of the running application on fail.

Parameter image: Image to use as the icon.

Safety

image might not allow None.

pub unsafe fn getDevice(&self) -> Option<Retained<IOBluetoothDevice>>

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

Gets the object representing the remote target device in the transfer.

Returns: The remote device of the transfer.

pub unsafe fn isTransferInProgress(&self) -> bool

Available on crate feature objc2 only.

Gets state of the transfer

Returns: The state of the transfer

impl IOBluetoothObjectPushUIController

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 IOBluetoothObjectPushUIController

Methods declared on superclass NSResponder.

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

Available on crate feature objc2 only.

impl IOBluetoothObjectPushUIController

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 IOBluetoothObjectPushUIController

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<IOBluetoothObjectPushUIController> for IOBluetoothObjectPushUIController

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 IOBluetoothObjectPushUIController

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 IOBluetoothObjectPushUIController

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 IOBluetoothObjectPushUIController

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 IOBluetoothObjectPushUIController

Available on crate feature objc2 only.

fn borrow(&self) -> &AnyObject

Immutably borrows from an owned value.

impl Borrow<NSObject> for IOBluetoothObjectPushUIController

Available on crate feature objc2 only.

fn borrow(&self) -> &NSObject

Immutably borrows from an owned value.

impl Borrow<NSResponder> for IOBluetoothObjectPushUIController

Available on crate feature objc2 only.

fn borrow(&self) -> &NSResponder

Immutably borrows from an owned value.

impl Borrow<NSWindowController> for IOBluetoothObjectPushUIController

Available on crate feature objc2 only.

fn borrow(&self) -> &NSWindowController

Immutably borrows from an owned value.

impl ClassType for IOBluetoothObjectPushUIController

Available on crate feature objc2 only.

const NAME: &'static str = "IOBluetoothObjectPushUIController"

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

type Super = NSWindowController

The superclass of this class.

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

Available on crate feature objc2 only.

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

Formats the value using the given formatter.

impl Deref for IOBluetoothObjectPushUIController

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 IOBluetoothObjectPushUIController

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 IOBluetoothObjectPushUIController

Available on crate feature objc2 only.

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

where Self: Sized,

Increment the reference count of the receiver.

impl NSCoding for IOBluetoothObjectPushUIController

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 IOBluetoothObjectPushUIController

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 IOBluetoothObjectPushUIController

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 IOBluetoothObjectPushUIController

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 IOBluetoothObjectPushUIController

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 IOBluetoothObjectPushUIController

Available on crate feature objc2 only.

impl Eq for IOBluetoothObjectPushUIController

Available on crate feature objc2 only.