Struct CABTLEMIDIWindowController 

pub struct CABTLEMIDIWindowController { /* private fields */ }

Available on crate feature CABTLEMIDIWindowController and crate feature objc2-app-kit and macOS only.

A window controller object that can present a window that displays nearby Bluetooth-based MIDI peripherals. The user can select one of those peripherals and pair it with their mac. Additionally, the user can advertise the mac as a Bluetooth-based MIDI peripheral.

To use this class, create an instance of the CABTLEMIDIWindowController, initialize it, and call showWindow: to display the UI.

See also Apple’s documentation

Implementations

impl CABTLEMIDIWindowController

Methods declared on superclass NSWindowController.

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

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

Safety

coder possibly has further requirements.

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

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

Safety

owner should be of the correct type.

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

Safety

owner should be of the correct type.

impl CABTLEMIDIWindowController

Methods declared on superclass NSResponder.

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

impl CABTLEMIDIWindowController

Methods declared on superclass NSObject.

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

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 contentViewController(&self) -> Option<Retained<NSViewController>>

pub fn setContentViewController( &self, content_view_controller: Option<&NSViewController>, )

Setter for contentViewController.

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 CABTLEMIDIWindowController

fn as_ref(&self) -> &AnyObject

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

impl AsRef<CABTLEMIDIWindowController> for CABTLEMIDIWindowController

fn as_ref(&self) -> &Self

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

impl AsRef<NSObject> for CABTLEMIDIWindowController

fn as_ref(&self) -> &NSObject

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

impl AsRef<NSResponder> for CABTLEMIDIWindowController

fn as_ref(&self) -> &NSResponder

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

impl AsRef<NSWindowController> for CABTLEMIDIWindowController

fn as_ref(&self) -> &NSWindowController

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

impl Borrow<AnyObject> for CABTLEMIDIWindowController

fn borrow(&self) -> &AnyObject

Immutably borrows from an owned value.

impl Borrow<NSObject> for CABTLEMIDIWindowController

fn borrow(&self) -> &NSObject

Immutably borrows from an owned value.

impl Borrow<NSResponder> for CABTLEMIDIWindowController

fn borrow(&self) -> &NSResponder

Immutably borrows from an owned value.

impl Borrow<NSWindowController> for CABTLEMIDIWindowController

fn borrow(&self) -> &NSWindowController

Immutably borrows from an owned value.

impl ClassType for CABTLEMIDIWindowController

const NAME: &'static str = "CABTLEMIDIWindowController"

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

type Super = NSWindowController

The superclass of this class.

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

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

Formats the value using the given formatter.

impl Deref for CABTLEMIDIWindowController

type Target = NSWindowController

The resulting type after dereferencing.

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

Dereferences the value.

impl Hash for CABTLEMIDIWindowController

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 CABTLEMIDIWindowController

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

where Self: Sized,

Increment the reference count of the receiver.

impl NSCoding for CABTLEMIDIWindowController

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 CABTLEMIDIWindowController

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 CABTLEMIDIWindowController

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 CABTLEMIDIWindowController

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 CABTLEMIDIWindowController

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

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

impl DowncastTarget for CABTLEMIDIWindowController

impl Eq for CABTLEMIDIWindowController