Struct EXHostViewController

#[repr(C)]
pub struct EXHostViewController { /* private fields */ }

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

A view controller that hosts remote views provided by an extension.

See also Apple’s documentation

Implementations

impl EXHostViewController

pub unsafe fn delegate( &self, ) -> Option<Retained<ProtocolObject<dyn EXHostViewControllerDelegate>>>

The connection delegate.

pub unsafe fn setDelegate( &self, delegate: Option<&ProtocolObject<dyn EXHostViewControllerDelegate>>, )

This is a weak property. Setter for delegate.

pub unsafe fn placeholderView(&self) -> Retained<NSView>

A view that’s used when the view controller has no content to display.

pub unsafe fn setPlaceholderView(&self, placeholder_view: &NSView)

Setter for placeholderView.

pub unsafe fn makeXPCConnectionWithError( &self, ) -> Result<Retained<NSXPCConnection>, Retained<NSError>>

Attempts to connect to the extension over XPC.

• Returns: An object representing the connection.

impl EXHostViewController

Methods declared on superclass NSViewController.

pub unsafe fn initWithNibName_bundle( this: Allocated<Self>, nib_name_or_nil: Option<&NSNibName>, nib_bundle_or_nil: Option<&NSBundle>, ) -> Retained<Self>

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

impl EXHostViewController

Methods declared on superclass NSResponder.

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

impl EXHostViewController

Methods declared on superclass NSObject.

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

Methods from Deref<Target = NSViewController>

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

Available on crate features NSResponder and NSNib only.

pub unsafe fn nibBundle(&self) -> Option<Retained<NSBundle>>

Available on crate feature NSResponder only.

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

Available on crate feature NSResponder only.

pub unsafe fn setRepresentedObject( &self, represented_object: Option<&AnyObject>, )

Available on crate feature NSResponder only.

Setter for representedObject.

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

Available on crate feature NSResponder only.

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

Available on crate feature NSResponder only.

Setter for title.

pub unsafe fn view(&self) -> Retained<NSView>

Available on crate features NSResponder and NSView only.

pub unsafe fn setView(&self, view: &NSView)

Available on crate features NSResponder and NSView only.

Setter for view.

pub unsafe fn viewIfLoaded(&self) -> Option<Retained<NSView>>

Available on crate features NSResponder and NSView only.

pub unsafe fn loadView(&self)

Available on crate feature NSResponder only.

pub unsafe fn loadViewIfNeeded(&self)

Available on crate feature NSResponder only.

pub unsafe fn commitEditingWithDelegate_didCommitSelector_contextInfo( &self, delegate: Option<&AnyObject>, did_commit_selector: Option<Sel>, context_info: *mut c_void, )

Available on crate feature NSResponder only.

pub unsafe fn commitEditing(&self) -> bool

Available on crate feature NSResponder only.

pub unsafe fn discardEditing(&self)

Available on crate feature NSResponder only.

pub unsafe fn viewDidLoad(&self)

Available on crate feature NSResponder only.

pub unsafe fn isViewLoaded(&self) -> bool

Available on crate feature NSResponder only.

pub unsafe fn viewWillAppear(&self)

Available on crate feature NSResponder only.

pub unsafe fn viewDidAppear(&self)

Available on crate feature NSResponder only.

pub unsafe fn viewWillDisappear(&self)

Available on crate feature NSResponder only.

pub unsafe fn viewDidDisappear(&self)

Available on crate feature NSResponder only.

pub unsafe fn preferredContentSize(&self) -> CGSize

Available on crate feature NSResponder only.

pub unsafe fn setPreferredContentSize(&self, preferred_content_size: CGSize)

Available on crate feature NSResponder only.

Setter for preferredContentSize.

pub unsafe fn updateViewConstraints(&self)

Available on crate feature NSResponder only.

pub unsafe fn viewWillLayout(&self)

Available on crate feature NSResponder only.

pub unsafe fn viewDidLayout(&self)

Available on crate feature NSResponder only.

pub unsafe fn presentViewController_animator( &self, view_controller: &NSViewController, animator: &ProtocolObject<dyn NSViewControllerPresentationAnimator>, )

Available on crate feature NSResponder only.

pub unsafe fn dismissViewController(&self, view_controller: &NSViewController)

Available on crate feature NSResponder only.

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

Available on crate feature NSResponder only.

pub unsafe fn presentedViewControllers( &self, ) -> Option<Retained<NSArray<NSViewController>>>

Available on crate feature NSResponder only.

pub unsafe fn presentingViewController( &self, ) -> Option<Retained<NSViewController>>

Available on crate feature NSResponder only.

pub unsafe fn presentViewControllerAsSheet( &self, view_controller: &NSViewController, )

Available on crate feature NSResponder only.

pub unsafe fn presentViewControllerAsModalWindow( &self, view_controller: &NSViewController, )

Available on crate feature NSResponder only.

pub unsafe fn parentViewController(&self) -> Option<Retained<NSViewController>>

Available on crate feature NSResponder only.

pub unsafe fn childViewControllers(&self) -> Retained<NSArray<NSViewController>>

Available on crate feature NSResponder only.

pub unsafe fn setChildViewControllers( &self, child_view_controllers: &NSArray<NSViewController>, )

Available on crate feature NSResponder only.

Setter for childViewControllers.

pub unsafe fn addChildViewController( &self, child_view_controller: &NSViewController, )

Available on crate feature NSResponder only.

pub unsafe fn removeFromParentViewController(&self)

Available on crate feature NSResponder only.

pub unsafe fn insertChildViewController_atIndex( &self, child_view_controller: &NSViewController, index: isize, )

Available on crate feature NSResponder only.

pub unsafe fn removeChildViewControllerAtIndex(&self, index: isize)

Available on crate feature NSResponder only.

pub unsafe fn preferredContentSizeDidChangeForViewController( &self, view_controller: &NSViewController, )

Available on crate feature NSResponder only.

pub unsafe fn viewWillTransitionToSize(&self, new_size: CGSize)

Available on crate feature NSResponder only.

pub unsafe fn extensionContext(&self) -> Option<Retained<NSExtensionContext>>

Available on crate feature NSResponder only.

pub unsafe fn sourceItemView(&self) -> Option<Retained<NSView>>

Available on crate features NSResponder and NSView only.

pub unsafe fn setSourceItemView(&self, source_item_view: Option<&NSView>)

Available on crate features NSResponder and NSView only.

Setter for sourceItemView.

pub unsafe fn preferredScreenOrigin(&self) -> CGPoint

Available on crate feature NSResponder only.

pub unsafe fn setPreferredScreenOrigin(&self, preferred_screen_origin: CGPoint)

Available on crate feature NSResponder only.

Setter for preferredScreenOrigin.

pub unsafe fn preferredMinimumSize(&self) -> CGSize

Available on crate feature NSResponder only.

pub unsafe fn preferredMaximumSize(&self) -> CGSize

Available on crate feature NSResponder only.

Methods from Deref<Target = NSResponder>

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

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

Setter for nextResponder.

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

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

pub unsafe fn acceptsFirstResponder(&self) -> bool

pub unsafe fn becomeFirstResponder(&self) -> bool

pub unsafe fn resignFirstResponder(&self) -> bool

pub unsafe fn flushBufferedKeyEvents(&self)

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

pub unsafe fn supplementalTargetForAction_sender( &self, action: Sel, sender: Option<&AnyObject>, ) -> Option<Retained<AnyObject>>

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

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

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

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

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

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

pub unsafe 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.

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 EXHostViewController

fn as_ref(&self) -> &AnyObject

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

impl AsRef<EXHostViewController> for EXHostViewController

fn as_ref(&self) -> &Self

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

impl AsRef<NSObject> for EXHostViewController

fn as_ref(&self) -> &NSObject

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

impl AsRef<NSResponder> for EXHostViewController

fn as_ref(&self) -> &NSResponder

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

impl AsRef<NSViewController> for EXHostViewController

fn as_ref(&self) -> &NSViewController

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

impl Borrow<AnyObject> for EXHostViewController

fn borrow(&self) -> &AnyObject

Immutably borrows from an owned value.

impl Borrow<NSObject> for EXHostViewController

fn borrow(&self) -> &NSObject

Immutably borrows from an owned value.

impl Borrow<NSResponder> for EXHostViewController

fn borrow(&self) -> &NSResponder

Immutably borrows from an owned value.

impl Borrow<NSViewController> for EXHostViewController

fn borrow(&self) -> &NSViewController

Immutably borrows from an owned value.

impl ClassType for EXHostViewController

const NAME: &'static str = "EXHostViewController"

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

type Super = NSViewController

The superclass of this class.

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

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

Formats the value using the given formatter.

impl Deref for EXHostViewController

type Target = NSViewController

The resulting type after dereferencing.

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

Dereferences the value.

impl Hash for EXHostViewController

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 EXHostViewController

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

where Self: Sized,

Increment the reference count of the receiver.

impl NSCoding for EXHostViewController

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

where Self: Sized + Message,

Available on crate feature NSCoder only.

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

where Self: Sized + Message,

Available on crate feature NSCoder only.

impl NSEditor for EXHostViewController

unsafe fn discardEditing(&self)

where Self: Sized + Message,

unsafe fn commitEditing(&self) -> bool

where Self: Sized + Message,

unsafe fn commitEditingWithDelegate_didCommitSelector_contextInfo( &self, delegate: Option<&AnyObject>, did_commit_selector: Option<Sel>, context_info: *mut c_void, )

where Self: Sized + Message,

unsafe fn commitEditingAndReturnError(&self) -> Result<(), Retained<NSError>>

where Self: Sized + Message,

impl NSObjectProtocol for EXHostViewController

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 EXHostViewController

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

where Self: Sized + Message,

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

where Self: Sized + Message,

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

where Self: Sized + Message,

impl NSUserInterfaceItemIdentification for EXHostViewController

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

where Self: Sized + Message,

unsafe fn setIdentifier(&self, identifier: Option<&NSString>)

where Self: Sized + Message,

Setter for identifier.

impl PartialEq for EXHostViewController

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 EXHostViewController

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

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

impl DowncastTarget for EXHostViewController

impl Eq for EXHostViewController