Struct WindowDelegate 

#[repr(C)]
pub(crate) struct WindowDelegate {
    __superclass: ManuallyDrop<<NSObject as ClassType>::__SubclassingType>,
    __phantom: PhantomData<(<Self as DefinedClass>::Ivars, ThreadKindAutoTraits<<Self as ClassType>::ThreadKind>)>,
}

Fields

__superclass: ManuallyDrop<<NSObject as ClassType>::__SubclassingType>

__phantom: PhantomData<(<Self as DefinedClass>::Ivars, ThreadKindAutoTraits<<Self as ClassType>::ThreadKind>)>

Implementations

impl WindowDelegate

extern "C-unwind" fn window_did_resize( &self, _: Sel, _notification: <&NSNotification as ConvertArgument>::__Inner, )

extern "C-unwind" fn window_should_close( &self, _: Sel, _sender: <&NSWindow as ConvertArgument>::__Inner, ) -> <bool as ConvertReturn<()>>::Inner

The user asked to close the window; the app closes it, once it has taken its content down.

impl WindowDelegate

extern "C-unwind" fn preferred_scroller_style_did_change( &self, _: Sel, _notification: <&NSNotification as ConvertArgument>::__Inner, )

Scroll bars that float over the content became ones that take a strip beside it, or the other way round, so the content is laid out again.

impl WindowDelegate

pub(crate) fn new( mtm: MainThreadMarker, content: Retained<FlippedView>, on_resize: ResizeHandler, on_close: CloseHandler, ) -> Retained<Self>

fn report_size(&self)

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 WindowDelegate

fn as_ref(&self) -> &AnyObject

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

impl AsRef<NSObject> for WindowDelegate

fn as_ref(&self) -> &NSObject

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

impl AsRef<WindowDelegate> for WindowDelegate

fn as_ref(&self) -> &Self

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

impl Borrow<AnyObject> for WindowDelegate

fn borrow(&self) -> &AnyObject

Immutably borrows from an owned value.

impl Borrow<NSObject> for WindowDelegate

fn borrow(&self) -> &NSObject

Immutably borrows from an owned value.

impl ClassType for WindowDelegate

const NAME: &'static str = "NiftyWindowDelegate"

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

type Super = NSObject

The superclass of this class.

type ThreadKind = dyn MainThreadOnly

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 WindowDelegate

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

Formats the value using the given formatter.

impl DefinedClass for WindowDelegate

type Ivars = WindowDelegateIvars

A type representing the instance variables that this class carries.

fn ivars(&self) -> &Self::Ivars

where Self: Sized,

Get a reference to the instance variable data that this object carries.

impl Deref for WindowDelegate

type Target = NSObject

The resulting type after dereferencing.

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

Dereferences the value.

impl DowncastTarget for WindowDelegate

impl Message for WindowDelegate

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

where Self: Sized,

Increment the reference count of the receiver.

impl NSObjectProtocol for WindowDelegate

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 NSWindowDelegate for WindowDelegate

fn windowShouldClose(&self, sender: &NSWindow) -> bool

where Self: Sized + Message,

unsafe fn windowWillReturnFieldEditor_toObject( &self, sender: &NSWindow, client: Option<&AnyObject>, ) -> Option<Retained<AnyObject>>

where Self: Sized + Message,

Safety

fn windowWillResize_toSize( &self, sender: &NSWindow, frame_size: CGSize, ) -> CGSize

where Self: Sized + Message,

fn windowWillUseStandardFrame_defaultFrame( &self, window: &NSWindow, new_frame: CGRect, ) -> CGRect

where Self: Sized + Message,

fn windowShouldZoom_toFrame(&self, window: &NSWindow, new_frame: CGRect) -> bool

where Self: Sized + Message,

fn windowWillReturnUndoManager( &self, window: &NSWindow, ) -> Option<Retained<NSUndoManager>>

where Self: Sized + Message,

fn window_willPositionSheet_usingRect( &self, window: &NSWindow, sheet: &NSWindow, rect: CGRect, ) -> CGRect

where Self: Sized + Message,

Tells the delegate that the window is about to show a sheet, and gives the delegate a chance to customize the location of the sheet.

fn window_shouldPopUpDocumentPathMenu( &self, window: &NSWindow, menu: &NSMenu, ) -> bool

where Self: Sized + Message,

If a window has a representedURL,the window will by default show a path popup menu for a command-click on a rectangle containing the window document icon button and the window title. The window delegate may implement -window:shouldPopupDocumentPathMenu: to override NSWindow’s default behavior for path popup menu. A return of NOwill prevent the menu from being shown. A return of YESwill cause the window to show the menu passed to this method, which by default will contain a menuItem for each path component of the representedURL.If the representedURLhas no path components, the menu will have no menu items. Before returning YES,the window delegate may customize the menu by changing the menuItems. menuItems may be added or deleted, and each menuItem title, action, or target may be modified.

fn window_shouldDragDocumentWithEvent_from_withPasteboard( &self, window: &NSWindow, event: &NSEvent, drag_image_location: CGPoint, pasteboard: &NSPasteboard, ) -> bool

where Self: Sized + Message,

The window delegate may implement -window:shouldDragDocumentWithEvent:from:withPasteboard: to override NSWindowdocument icon’s default drag behavior. The delegate can prohibit the drag by returning NO.Before returning NO,the delegate may implement its own dragging behavior using -[NSWindow dragImage:at:offset:event:pasteboard:source:slideBack:]. Alternatively, the delegate can enable a drag by returning YES,for example to override NSWindow’s default behavior of prohibiting the drag of an edited document. Lastly, the delegate can customize the pasteboard contents before returning YES.

fn window_willUseFullScreenContentSize( &self, window: &NSWindow, proposed_size: CGSize, ) -> CGSize

where Self: Sized + Message,

fn window_willUseFullScreenPresentationOptions( &self, window: &NSWindow, proposed_options: NSApplicationPresentationOptions, ) -> NSApplicationPresentationOptions

where Self: Sized + Message,

fn customWindowsToEnterFullScreenForWindow( &self, window: &NSWindow, ) -> Option<Retained<NSArray<NSWindow>>>

where Self: Sized + Message,

The default animation between a window and its fullscreen representation is a crossfade. With knowledge of the layout of a window before and after it enters fullscreen, an application can do a much better job on the animation. The following API allows a window delegate to customize the animation by providing a custom window or windows containing layers or other effects. In order to manage windows on spaces, we need the window delegate to provide a list of windows involved in the animation. If an application does not do a custom animation, this method can be unimplemented or can return nil. -window:startCustomAnimationToEnterFullScreenWithDuration: will be called only if -customWindowsToEnterFullScreenForWindow: returns non-nil.

fn window_startCustomAnimationToEnterFullScreenWithDuration( &self, window: &NSWindow, duration: f64, )

where Self: Sized + Message,

The system has started its animation into fullscreen, including transitioning to a new space. Start the window fullscreen animation immediately, and perform the animation with the given duration to be in sync with the system animation. This method is called only if -customWindowToEnterFullScreenForWindow: returned non-nil.

fn windowDidFailToEnterFullScreen(&self, window: &NSWindow)

where Self: Sized + Message,

In some cases, the transition to enter fullscreen will fail, due to being in the midst of handling some other animation or user gesture. We will attempt to minimize these cases, but believe there is a need for failure handling. This method indicates that there was an error, and the application should clean up any work it may have done to prepare to enter fullscreen. This message will be sent whether or not the delegate indicated a custom animation by returning non-nil from -customWindowsToEnterFullScreenForWindow:.

fn customWindowsToExitFullScreenForWindow( &self, window: &NSWindow, ) -> Option<Retained<NSArray<NSWindow>>>

where Self: Sized + Message,

The window is about to exit fullscreen mode.  The following API allows a window delegate to customize the animation when the window is about to exit fullscreen. In order to manage windows on spaces, we need the window delegate to provide a list of windows involved in the animation. If an application does not do a custom animation, this method can be unimplemented or can return nil. -window:startCustomAnimationToExitFullScreenWithDuration: will be called only if -customWindowsToExitFullScreenForWindow: returns non-nil.

fn window_startCustomAnimationToExitFullScreenWithDuration( &self, window: &NSWindow, duration: f64, )

where Self: Sized + Message,

The system has started its animation out of fullscreen, including transitioning back to the desktop space. Start the window animation immediately, and perform the animation with the given duration to be in sync with the system animation. This method is called only if -customWindowsToExitFullScreenForWindow: returned non-nil.

fn customWindowsToEnterFullScreenForWindow_onScreen( &self, window: &NSWindow, screen: &NSScreen, ) -> Option<Retained<NSArray<NSWindow>>>

where Self: Sized + Message,

-customWindowsToEnterFullScreenForWindow:onScreen: will be called in place of -customWindowsToEnterFullScreenForWindow: if both are implemented.

fn window_startCustomAnimationToEnterFullScreenOnScreen_withDuration( &self, window: &NSWindow, screen: &NSScreen, duration: f64, )

where Self: Sized + Message,

-window:startCustomAnimationToEnterFullScreenOnScreen:withDuration: will be called in place of -window:startCustomAnimationToEnterFullScreenWithDuration: if both are implemented.

fn windowDidFailToExitFullScreen(&self, window: &NSWindow)

where Self: Sized + Message,

In some cases, the transition to exit fullscreen will fail, due to being in the midst of handling some other animation or user gesture. We will attempt to minimize these cases, but believe there is a need for failure handling. This method indicates that there was an error, and the application should clean up any work it may have done to prepare to exit fullscreen. This message will be sent whether or not the delegate indicated a custom animation by returning non-nil from -customWindowsToExitFullScreenForWindow:.

fn window_willResizeForVersionBrowserWithMaxPreferredSize_maxAllowedSize( &self, window: &NSWindow, max_preferred_frame_size: CGSize, max_allowed_frame_size: CGSize, ) -> CGSize

where Self: Sized + Message,

Windows entering the version browser will be resized to the size returned by this method. If either dimension of the returned size is larger than the maxPreferredFrameSize,the window will also be scaled down to ensure it fits properly in the version browser. Returned sizes larger than maxAllowedSizewill be constrained to that size. If this method is not implemented, the version browser will use -window:willUseStandardFrame: to determine the resulting window frame size.

unsafe fn window_willEncodeRestorableState( &self, window: &NSWindow, state: &NSCoder, )

where Self: Sized + Message,

Method called by -[NSWindow encodeRestorableStateWithCoder:] to give the delegate a chance to encode any additional state into the NSCoder. This state is available in the NSCoder passed to -restoreWindowWithIdentifier:state:handler:. See the header NSWindowRestoration.h for more information.

unsafe fn window_didDecodeRestorableState( &self, window: &NSWindow, state: &NSCoder, )

where Self: Sized + Message,

Method called by -[NSWindow restoreStateWithCoder:] to give the delegate a chance to restore its own state, which it may decode from the NSCoder.See the header NSWindowRestoration.h for more information.

fn previewRepresentableActivityItemsForWindow( &self, window: &NSWindow, ) -> Option<Retained<NSArray<ProtocolObject<dyn NSPreviewRepresentableActivityItem>>>>

where Self: Sized + Message,

Preview representable activity items, used for sharing and collaboration.

fn windowForSharingRequestFromWindow( &self, window: &NSWindow, ) -> Option<Retained<NSWindow>>

where Self: Sized + Message,

Method called to get the window to share once sharing is confirmed, after a request is initiated by requestSharingOfWindowUsingPreview:title:completionHandler:. Implement this on the delegate of the requesting window

fn windowDidResize(&self, notification: &NSNotification)

where Self: Sized + Message,

fn windowDidExpose(&self, notification: &NSNotification)

where Self: Sized + Message,

fn windowWillMove(&self, notification: &NSNotification)

where Self: Sized + Message,

fn windowDidMove(&self, notification: &NSNotification)

where Self: Sized + Message,

fn windowDidBecomeKey(&self, notification: &NSNotification)

where Self: Sized + Message,

fn windowDidResignKey(&self, notification: &NSNotification)

where Self: Sized + Message,

fn windowDidBecomeMain(&self, notification: &NSNotification)

where Self: Sized + Message,

fn windowDidResignMain(&self, notification: &NSNotification)

where Self: Sized + Message,

fn windowWillClose(&self, notification: &NSNotification)

where Self: Sized + Message,

fn windowWillMiniaturize(&self, notification: &NSNotification)

where Self: Sized + Message,

fn windowDidMiniaturize(&self, notification: &NSNotification)

where Self: Sized + Message,

fn windowDidDeminiaturize(&self, notification: &NSNotification)

where Self: Sized + Message,

fn windowDidUpdate(&self, notification: &NSNotification)

where Self: Sized + Message,

fn windowDidChangeScreen(&self, notification: &NSNotification)

where Self: Sized + Message,

fn windowDidChangeScreenProfile(&self, notification: &NSNotification)

where Self: Sized + Message,

fn windowDidChangeBackingProperties(&self, notification: &NSNotification)

where Self: Sized + Message,

fn windowWillBeginSheet(&self, notification: &NSNotification)

where Self: Sized + Message,

fn windowDidEndSheet(&self, notification: &NSNotification)

where Self: Sized + Message,

fn windowWillStartLiveResize(&self, notification: &NSNotification)

where Self: Sized + Message,

fn windowDidEndLiveResize(&self, notification: &NSNotification)

where Self: Sized + Message,

fn windowWillEnterFullScreen(&self, notification: &NSNotification)

where Self: Sized + Message,

fn windowDidEnterFullScreen(&self, notification: &NSNotification)

where Self: Sized + Message,

fn windowWillExitFullScreen(&self, notification: &NSNotification)

where Self: Sized + Message,

fn windowDidExitFullScreen(&self, notification: &NSNotification)

where Self: Sized + Message,

fn windowWillEnterVersionBrowser(&self, notification: &NSNotification)

where Self: Sized + Message,

fn windowDidEnterVersionBrowser(&self, notification: &NSNotification)

where Self: Sized + Message,

fn windowWillExitVersionBrowser(&self, notification: &NSNotification)

where Self: Sized + Message,

fn windowDidExitVersionBrowser(&self, notification: &NSNotification)

where Self: Sized + Message,

fn windowDidChangeOcclusionState(&self, notification: &NSNotification)

where Self: Sized + Message,

impl RefEncode for WindowDelegate

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

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