Struct NSWindowController

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

Available on crate features NSResponder and NSWindowController only.

Apple’s documentation

Implementations

impl NSWindowController

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

Available on crate feature NSWindow only.

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

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

Available on crate feature NSNib only.

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

Available on crate feature NSNib only.

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

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

Available on crate feature NSNib only.

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

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

pub unsafe fn windowFrameAutosaveName( &self, ) -> Retained<NSWindowFrameAutosaveName>

Available on crate feature NSWindow only.

pub unsafe fn setWindowFrameAutosaveName( &self, window_frame_autosave_name: &NSWindowFrameAutosaveName, )

Available on crate feature NSWindow only.

Setter for windowFrameAutosaveName.

pub unsafe fn shouldCascadeWindows(&self) -> bool

pub unsafe fn setShouldCascadeWindows(&self, should_cascade_windows: bool)

Setter for shouldCascadeWindows.

pub unsafe fn previewRepresentableActivityItems( &self, ) -> Option<Retained<NSArray<ProtocolObject<dyn NSPreviewRepresentableActivityItem>>>>

Available on crate feature NSPreviewRepresentingActivityItem only.

pub unsafe fn setPreviewRepresentableActivityItems( &self, preview_representable_activity_items: Option<&NSArray<ProtocolObject<dyn NSPreviewRepresentableActivityItem>>>, )

Available on crate feature NSPreviewRepresentingActivityItem only.

Setter for previewRepresentableActivityItems.

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

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

Setter for document.

pub unsafe fn setDocumentEdited(&self, dirty_flag: bool)

pub unsafe fn shouldCloseDocument(&self) -> bool

pub unsafe fn setShouldCloseDocument(&self, should_close_document: bool)

Setter for shouldCloseDocument.

pub unsafe fn synchronizeWindowTitleWithDocumentName(&self)

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

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

Available on crate feature NSViewController only.

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

Available on crate feature NSViewController only.

Setter for contentViewController.

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

Available on crate feature NSWindow only.

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

Available on crate feature NSWindow only.

Setter for window.

pub unsafe fn isWindowLoaded(&self) -> bool

pub unsafe fn windowWillLoad(&self)

pub unsafe fn windowDidLoad(&self)

pub unsafe fn loadWindow(&self)

pub unsafe fn close(&self)

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

impl NSWindowController

Methods declared on superclass NSResponder.

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

impl NSWindowController

Methods declared on superclass NSObject.

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

impl NSWindowController

NSWindowControllerStoryboardingMethods. These methods are used to support using Storyboards with your app.

pub unsafe fn storyboard(&self) -> Option<Retained<NSStoryboard>>

Available on crate feature NSStoryboard only.

impl NSWindowController

NSWindowControllerDismissing.

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

Methods from Deref<Target = NSResponder>

pub unsafe fn interfaceStyle(&self) -> NSInterfaceStyle

👎Deprecated

Available on crate feature NSInterfaceStyle only.

pub unsafe fn setInterfaceStyle(&self, interface_style: NSInterfaceStyle)

👎Deprecated

Available on crate feature NSInterfaceStyle only.

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 performKeyEquivalent(&self, event: &NSEvent) -> bool

Available on crate feature NSEvent only.

pub unsafe fn validRequestorForSendType_returnType( &self, send_type: Option<&NSPasteboardType>, return_type: Option<&NSPasteboardType>, ) -> Option<Retained<AnyObject>>

Available on crate feature NSPasteboard only.

pub unsafe fn mouseDown(&self, event: &NSEvent)

Available on crate feature NSEvent only.

pub unsafe fn rightMouseDown(&self, event: &NSEvent)

Available on crate feature NSEvent only.

pub unsafe fn otherMouseDown(&self, event: &NSEvent)

Available on crate feature NSEvent only.

pub unsafe fn mouseUp(&self, event: &NSEvent)

Available on crate feature NSEvent only.

pub unsafe fn rightMouseUp(&self, event: &NSEvent)

Available on crate feature NSEvent only.

pub unsafe fn otherMouseUp(&self, event: &NSEvent)

Available on crate feature NSEvent only.

pub unsafe fn mouseMoved(&self, event: &NSEvent)

Available on crate feature NSEvent only.

pub unsafe fn mouseDragged(&self, event: &NSEvent)

Available on crate feature NSEvent only.

pub unsafe fn scrollWheel(&self, event: &NSEvent)

Available on crate feature NSEvent only.

pub unsafe fn rightMouseDragged(&self, event: &NSEvent)

Available on crate feature NSEvent only.

pub unsafe fn otherMouseDragged(&self, event: &NSEvent)

Available on crate feature NSEvent only.

pub unsafe fn mouseEntered(&self, event: &NSEvent)

Available on crate feature NSEvent only.

pub unsafe fn mouseExited(&self, event: &NSEvent)

Available on crate feature NSEvent only.

pub unsafe fn keyDown(&self, event: &NSEvent)

Available on crate feature NSEvent only.

pub unsafe fn keyUp(&self, event: &NSEvent)

Available on crate feature NSEvent only.

pub unsafe fn flagsChanged(&self, event: &NSEvent)

Available on crate feature NSEvent only.

pub unsafe fn tabletPoint(&self, event: &NSEvent)

Available on crate feature NSEvent only.

pub unsafe fn tabletProximity(&self, event: &NSEvent)

Available on crate feature NSEvent only.

pub unsafe fn cursorUpdate(&self, event: &NSEvent)

Available on crate feature NSEvent only.

pub unsafe fn magnifyWithEvent(&self, event: &NSEvent)

Available on crate feature NSEvent only.

pub unsafe fn rotateWithEvent(&self, event: &NSEvent)

Available on crate feature NSEvent only.

pub unsafe fn swipeWithEvent(&self, event: &NSEvent)

Available on crate feature NSEvent only.

pub unsafe fn beginGestureWithEvent(&self, event: &NSEvent)

Available on crate feature NSEvent only.

pub unsafe fn endGestureWithEvent(&self, event: &NSEvent)

Available on crate feature NSEvent only.

pub unsafe fn smartMagnifyWithEvent(&self, event: &NSEvent)

Available on crate feature NSEvent only.

pub unsafe fn changeModeWithEvent(&self, event: &NSEvent)

Available on crate feature NSEvent only.

pub unsafe fn touchesBeganWithEvent(&self, event: &NSEvent)

Available on crate feature NSEvent only.

pub unsafe fn touchesMovedWithEvent(&self, event: &NSEvent)

Available on crate feature NSEvent only.

pub unsafe fn touchesEndedWithEvent(&self, event: &NSEvent)

Available on crate feature NSEvent only.

pub unsafe fn touchesCancelledWithEvent(&self, event: &NSEvent)

Available on crate feature NSEvent only.

pub unsafe fn quickLookWithEvent(&self, event: &NSEvent)

Available on crate feature NSEvent only.

pub unsafe fn pressureChangeWithEvent(&self, event: &NSEvent)

Available on crate feature NSEvent only.

pub unsafe fn contextMenuKeyDown(&self, event: &NSEvent)

Available on crate feature NSEvent only.

Handle a key event that should present a context menu at the user focus.

Most applications should not override this method. Instead, you should customize the context menu displayed from a keyboard event by implementing menuForEvent: and selectionAnchorRect, or showContextMenuForSelection:, rather than this method.

You should only override this method when you do not want the system-provided default behavior for the context menu hotkey, either for a specific key combination, or for the hotkey in general. For example, if your application already provides a different behavior for control-Return (the default context menu hotkey definition), and you want to preserve that behavior, you should override this method to handle that specific key combination, and then return without calling super. Note that the user may customize the hotkey to a different key combination, so in this example, if any other key combination is passed to your method, you would call super.

An implementation of this method should call [super contextMenuKeyDown:event] to pass the request up the responder chain. If the message reaches the application object, NSApplication’s implementation of this method will send showContextMenuForSelection: to the responder chain. If you do not call super, then no further handling of the key event will be performed.

Note: In some cases, showContextMenuForSelection: will be called without a prior call to contextMenuKeyDown:. This occurs when a view receives an Accessibility ShowMenu action, or when the user has created a Cocoa Text key binding to map a different key combination to the showContextMenuForSelection: action.

Parameter event: The key down event that matches the system-wide context menu hotkey combination.

See also: showContextMenuForSelection:

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 interpretKeyEvents(&self, event_array: &NSArray<NSEvent>)

Available on crate feature NSEvent only.

pub unsafe fn flushBufferedKeyEvents(&self)

pub unsafe fn menu(&self) -> Option<Retained<NSMenu>>

Available on crate feature NSMenu only.

pub unsafe fn setMenu(&self, menu: Option<&NSMenu>)

Available on crate feature NSMenu only.

Setter for menu.

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

pub unsafe fn helpRequested(&self, event_ptr: &NSEvent)

Available on crate feature NSEvent only.

pub unsafe fn shouldBeTreatedAsInkEvent(&self, event: &NSEvent) -> bool

Available on crate feature NSEvent only.

pub unsafe fn wantsScrollEventsForSwipeTrackingOnAxis( &self, axis: NSEventGestureAxis, ) -> bool

Available on crate feature NSEvent only.

pub unsafe fn wantsForwardedScrollEventsForAxis( &self, axis: NSEventGestureAxis, ) -> bool

Available on crate feature NSEvent only.

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 validateProposedFirstResponder_forEvent( &self, responder: &NSResponder, event: Option<&NSEvent>, ) -> bool

Available on crate feature NSEvent only.

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, )

Available on crate feature NSWindow only.

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

pub unsafe fn touchBar(&self) -> Option<Retained<NSTouchBar>>

Available on crate feature NSTouchBar only.

pub unsafe fn setTouchBar(&self, touch_bar: Option<&NSTouchBar>)

Available on crate feature NSTouchBar only.

Setter for touchBar.

pub unsafe fn makeTouchBar(&self) -> Option<Retained<NSTouchBar>>

Available on crate feature NSTouchBar only.

pub unsafe fn userActivity(&self) -> Option<Retained<NSUserActivity>>

Available on crate feature NSUserActivity only.

pub unsafe fn setUserActivity(&self, user_activity: Option<&NSUserActivity>)

Available on crate feature NSUserActivity only.

Setter for userActivity.

pub unsafe fn updateUserActivityState(&self, user_activity: &NSUserActivity)

Available on crate feature NSUserActivity only.

pub unsafe fn encodeRestorableStateWithCoder(&self, coder: &NSCoder)

Available on crate feature NSWindowRestoration only.

pub unsafe fn encodeRestorableStateWithCoder_backgroundQueue( &self, coder: &NSCoder, queue: &NSOperationQueue, )

Available on crate feature NSWindowRestoration only.

pub unsafe fn restoreStateWithCoder(&self, coder: &NSCoder)

Available on crate feature NSWindowRestoration only.

pub unsafe fn invalidateRestorableState(&self)

Available on crate feature NSWindowRestoration only.

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

Available on crate feature NSAccessibilityConstants only.

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.

Available on crate feature NSAccessibilityConstants only.

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,

Available on crate feature NSAccessibilityConstants only.

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 NSWindowController

fn as_ref(&self) -> &AnyObject

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

impl AsRef<NSObject> for NSWindowController

fn as_ref(&self) -> &NSObject

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

impl AsRef<NSResponder> for NSWindowController

fn as_ref(&self) -> &NSResponder

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

impl AsRef<NSWindowController> for NSWindowController

fn as_ref(&self) -> &Self

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

impl Borrow<AnyObject> for NSWindowController

fn borrow(&self) -> &AnyObject

Immutably borrows from an owned value.

impl Borrow<NSObject> for NSWindowController

fn borrow(&self) -> &NSObject

Immutably borrows from an owned value.

impl Borrow<NSResponder> for NSWindowController

fn borrow(&self) -> &NSResponder

Immutably borrows from an owned value.

impl ClassType for NSWindowController

const NAME: &'static str = "NSWindowController"

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

type Super = NSResponder

The superclass of this class.

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

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

Formats the value using the given formatter.

impl Deref for NSWindowController

type Target = NSResponder

The resulting type after dereferencing.

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

Dereferences the value.

impl Hash for NSWindowController

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 NSWindowController

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

where Self: Sized,

Increment the reference count of the receiver.

impl NSCoding for NSWindowController

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

where Self: Sized + Message,

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

where Self: Sized + Message,

impl NSObjectProtocol for NSWindowController

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 NSWindowController

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

where Self: Sized + Message,

Available on crate feature NSStoryboardSegue only.

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

where Self: Sized + Message,

Available on crate feature NSStoryboardSegue only.

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

where Self: Sized + Message,

Available on crate feature NSStoryboardSegue only.

impl PartialEq for NSWindowController

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 NSWindowController

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

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

impl DowncastTarget for NSWindowController

impl Eq for NSWindowController