Struct SFKeychainSavePanel

Source

pub struct SFKeychainSavePanel { /* private fields */ }

Available on crate feature SFKeychainSavePanel only.

Expand description

SFKeychainSavePanel is a panel and sheet interface used to create a keychain using the NSSavePanel UI.

Implementations§

Source §

impl SFKeychainSavePanel

Source

pub unsafe fn sharedKeychainSavePanel( mtm: MainThreadMarker, ) -> Option<Retained<SFKeychainSavePanel>>

Returns a global instance of SFKeychainSavePanel object.

Source

pub unsafe fn runModalForDirectory_file( &self, path: Option<&NSString>, name: Option<&NSString>, ) -> NSInteger

Displays a keychain save panel.

Parameter path: The path to where the keychain is created (nil for ~/Library/Keychains).

Parameter name: The keychain name to be automatically filled out in the NSSave panel.

Returns: a result code returned by NSSavePanel’s runModalForDirectory method.

§Safety

path might not allow None.
name might not allow None.

Source

pub unsafe fn setPassword(&self, password: Option<&NSString>)

Specifies the password for the keychain that will be created.

Parameter The: password string object.

§Safety

password might not allow None.

Source

pub unsafe fn keychain(&self) -> Option<Retained<SecKeychain>>

Available on crate feature objc2-security only.

Returns the keychain created by the SFKeychainSavePanel.

Returns: The keychain object.

Source

pub unsafe fn error(&self) -> Option<Retained<NSError>>

Returns the last error encountered by SFKeychainSavePanel.

Returns: The error object.

Source

pub unsafe fn beginSheetForDirectory_file_modalForWindow_modalDelegate_didEndSelector_contextInfo( &self, path: Option<&NSString>, name: Option<&NSString>, doc_window: Option<&NSWindow>, delegate: Option<&AnyObject>, did_end_selector: Option<Sel>, context_info: *mut c_void, )

Displays a keychain save panel as a sheet.

Parameter path: The path to where the keychain is created (nil for ~/Library/Keychains).

Parameter name: The keychain name to be automatically filled out in the NSSave panel.

Parameter docWindow: The panel in which the save sheet slides down; acting as a document modal window. If docWindow is nil, the behavior defaults to a standalone modal window.

Parameter delegate: Delegate object in which didEndSelector is a method.

Parameter didEndSelector: The didEndSelector method is optional. If implemented by the delegate, this method is invoked after the modal session has ended, but before dismissing the same panel. didEndSelector may dismiss the keychain panel itself; otherwise it will be dismissed on return from the method. didEndSelector should have the following signature:

(void)createPanelDidEnd:(NSWindow *)sheet returnCode:(NSInteger)returnCode contextInfo:(void *)contextInfo;

Parameter contextInfo: Client-defined context pointer.

§Safety

path might not allow None.
name might not allow None.
doc_window might not allow None.
delegate should be of the correct type.
delegate might not allow None.
did_end_selector must be a valid selector.
context_info must be a valid pointer.

Source §

impl SFKeychainSavePanel

Methods declared on superclass NSWindow.

Source

pub unsafe fn initWithContentRect_styleMask_backing_defer( this: Allocated<Self>, content_rect: NSRect, style: NSWindowStyleMask, backing_store_type: NSBackingStoreType, flag: bool, ) -> Retained<Self>

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

Methods from Deref<Target = NSSavePanel>§

Source

pub fn URL(&self) -> Option<Retained<NSURL>>

Available on crate features NSPanel and NSResponder and NSWindow only.

NSSavePanel: Returns the URL to save the file at. A file may already exist at url if the user choose to overwrite it. NSOpenPanel: Returns the single filename selected by the user. Note: if -allowsMultipleSelection is set, you should use the -URLs on NSOpenPanel instead.

Source

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

Available on crate features NSPanel and NSResponder and NSUserInterfaceItemIdentification and NSWindow only.

Sets and returns the identifier.

The panel’s current state such as the root directory and the current directory are saved and restored relative to the identifier.

Note: When the identifier is changed, the properties that depend on the identifier are updated from user defaults. Properties that have a null value in user defaults are not changed (and keep their existing value).
Note: Can only be set during the configuration phase.

Source

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

Available on crate features NSPanel and NSResponder and NSUserInterfaceItemIdentification and NSWindow only.

Setter for identifier.

This is copied when set.

Source

pub fn directoryURL(&self) -> Option<Retained<NSURL>>

Available on crate features NSPanel and NSResponder and NSWindow only.

NSSavePanel/NSOpenPanel: Sets and returns the directory that is displayed. Set to nil to display the default directory. This method will not block to resolve the URL, and the directory will asynchronously be set, if required.

Note: Can only be set during the configuration phase.

Source

pub fn setDirectoryURL(&self, directory_url: Option<&NSURL>)

Available on crate features NSPanel and NSResponder and NSWindow only.

Setter for directoryURL.

This is copied when set.

Source

pub fn allowsOtherFileTypes(&self) -> bool

Available on crate features NSPanel and NSResponder and NSWindow only.

NSSavePanel: Returns a BOOL value that indicates whether the panel allows the user to save files with an extension that is not in the list of allowedFileTypes. NSOpenPanel: Not used.

Source

pub fn setAllowsOtherFileTypes(&self, allows_other_file_types: bool)

Available on crate features NSPanel and NSResponder and NSWindow only.

Setter for allowsOtherFileTypes.

Source

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

Available on crate features NSPanel and NSResponder and NSView and NSWindow only.

Sets and returns the accessory view shown in the panel.

For applications that link on 10.6 and later, the accessoryView’s frame will be observed, and any changes the programmer makes to the frame will automatically be reflected in the panel (including animated changes to the frame height).

For applications that link on 26.0 and later and use the Liquid Glass design, the accessoryView’s control metrics will be the larger Liquid Glass metrics.

Source

pub fn setAccessoryView(&self, accessory_view: Option<&NSView>)

Available on crate features NSPanel and NSResponder and NSView and NSWindow only.

Setter for accessoryView.

Source

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

Available on crate features NSPanel and NSResponder and NSWindow only.

NSSavePanel/NSOpenPanel: Sets and returns the delegate.

Source

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

Available on crate features NSPanel and NSResponder and NSWindow only.

Setter for delegate.

This is a weak property.

Source

pub fn isExpanded(&self) -> bool

Available on crate features NSPanel and NSResponder and NSWindow only.

NSSavePanel: Returns YES if the panel is expanded. Defaults to NO. Persists in the user defaults.

Note: Can only be set during the configuration phase. NSOpenPanel: Not used.

Source

pub fn canCreateDirectories(&self) -> bool

Available on crate features NSPanel and NSResponder and NSWindow only.

NSSavePanel/NSOpenPanel: Set to YES to show the “New Folder” button. Default is YES.

Source

pub fn setCanCreateDirectories(&self, can_create_directories: bool)

Available on crate features NSPanel and NSResponder and NSWindow only.

Setter for canCreateDirectories.

Source

pub fn canSelectHiddenExtension(&self) -> bool

Available on crate features NSPanel and NSResponder and NSWindow only.

NSSavePanel: Set to YES to show the “Hide Extension” menu item. NSOpenPanel: Not used.

Source

pub fn setCanSelectHiddenExtension(&self, can_select_hidden_extension: bool)

Available on crate features NSPanel and NSResponder and NSWindow only.

Setter for canSelectHiddenExtension.

Source

pub fn isExtensionHidden(&self) -> bool

Available on crate features NSPanel and NSResponder and NSWindow only.

NSSavePanel: Set to YES if the filename extension should be hidden. Otherwise, NO if the filename extension should be shown. Default is YES.

Note: Can only be set during the configuration phase. NSOpenPanel: Not used.

Source

pub fn setExtensionHidden(&self, extension_hidden: bool)

Available on crate features NSPanel and NSResponder and NSWindow only.

Setter for isExtensionHidden.

Source

pub fn treatsFilePackagesAsDirectories(&self) -> bool

Available on crate features NSPanel and NSResponder and NSWindow only.

NSSavePanel/NSOpenPanel: If set to YES, the user can navigate into file packages as if they were directories. Default is NO.

Source

pub fn setTreatsFilePackagesAsDirectories( &self, treats_file_packages_as_directories: bool, )

Available on crate features NSPanel and NSResponder and NSWindow only.

Setter for treatsFilePackagesAsDirectories.

Source

pub fn prompt(&self) -> Retained<NSString>

Available on crate features NSPanel and NSResponder and NSWindow only.

NSSavePanel/NSOpenPanel: Sets the text shown on the Open or Save button. If set to an empty string, it will show a localized “Open” for the NSOpenPanel and “Save” for the NSSavePanel. The default value will be the correct localized prompt for the open or save panel, as appropriate.

Source

pub fn setPrompt(&self, prompt: Option<&NSString>)

Available on crate features NSPanel and NSResponder and NSWindow only.

Setter for prompt.

This is copied when set.

Source

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

Available on crate features NSPanel and NSResponder and NSWindow only.

NSSavePanel/NSOpenPanel: Sets and returns the title for the panel shown at the top of the window.

Note: The open and save panel does not currently have a titlebar. So the title is not displayed.

Source

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

Available on crate features NSPanel and NSResponder and NSWindow only.

Setter for title.

This is copied when set.

Source

pub fn nameFieldLabel(&self) -> Retained<NSString>

Available on crate features NSPanel and NSResponder and NSWindow only.

NSSavePanel: Sets and returns the text shown to the left of the “name field”. Default value is a localized “Save As:” string. NSOpenPanel: Not used.

Source

pub fn setNameFieldLabel(&self, name_field_label: Option<&NSString>)

Available on crate features NSPanel and NSResponder and NSWindow only.

Setter for nameFieldLabel.

This is copied when set.

Source

pub fn nameFieldStringValue(&self) -> Retained<NSString>

Available on crate features NSPanel and NSResponder and NSWindow only.

NSSavePanel: Sets and returns the user-editable file name shown in the name field.

Note: Calling the deprecated methods that take a “name:” parameter will overwrite any values set before the panel is shown.
Note: If [panel isExtensionHidden] is set to YES, the extension will be hidden.
Note: Can only be set during the configuration phase. NSOpenPanel: Not used.

Source

pub fn setNameFieldStringValue(&self, name_field_string_value: &NSString)

Available on crate features NSPanel and NSResponder and NSWindow only.

Setter for nameFieldStringValue.

This is copied when set.

Source

pub fn message(&self) -> Retained<NSString>

Available on crate features NSPanel and NSResponder and NSWindow only.

NSSavePanel/NSOpenPanel: Sets and returns the message shown under title of the panel.

Source

pub fn setMessage(&self, message: Option<&NSString>)

Available on crate features NSPanel and NSResponder and NSWindow only.

Available on crate features NSPanel and NSResponder and NSWindow only.

Setter for tagNames.

This is copied when set.

Source

pub fn showsContentTypes(&self) -> bool

Available on crate features NSPanel and NSResponder and NSWindow only.

NSSavePanel: Whether or not to show a control for selecting the type of the saved file. The control shows the types in allowedContentTypes. Default is NO. NSOpenPanel: Not used.

Note: If allowedContentTypes is empty, the control is not displayed.

Source

pub fn setShowsContentTypes(&self, shows_content_types: bool)

Available on crate features NSPanel and NSResponder and NSWindow only.

Setter for showsContentTypes.

Source

pub fn validateVisibleColumns(&self)

Available on crate features NSPanel and NSResponder and NSWindow only.

Available on crate features NSPanel and NSResponder and NSWindow only.

§Safety

delegate should be of the correct type.
did_end_selector must be a valid selector.
context_info must be a valid pointer or null.

Source

pub fn runModalForDirectory_file( &self, path: Option<&NSString>, name: Option<&NSString>, ) -> isize

👎Deprecated:

Use -runModal instead. The following parameters are replaced by properties: ‘path’ is replaced by ‘directoryURL’ and ‘name’ by ‘nameFieldStringValue’.

Available on crate features NSPanel and NSResponder and NSWindow only.

Source

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

👎Deprecated:

Default implementation does nothing.

Available on crate features NSPanel and NSResponder and NSWindow only.

§Safety

sender should be of the correct type.

Source

pub fn allowedFileTypes(&self) -> Option<Retained<NSArray<NSString>>>

👎Deprecated:

Use -allowedContentTypes instead

Available on crate features NSPanel and NSResponder and NSWindow only.

NSSavePanel: An array of NSStrings specifying the file types the user can save the file as. The file type can be a common file extension, or a UTI. A nil value indicates that any file type can be used. If the array is not nil and the array contains no items, an exception will be raised. If no extension is given by the user, the first item in the allowedFileTypes will be used as the extension for the save panel. If the user specifies a type not in the array, and ‘allowsOtherFileTypes’ is YES, they will be presented with another dialog when prompted to save. The default value is ‘nil’. NSOpenPanel: On versions less than 10.6, this property is ignored. For applications that link against 10.6 and higher, this property will determine which files should be enabled in the open panel. Using the deprecated methods to show the open panel (the ones that take a “types:” parameter) will overwrite this value, and should not be used. The allowedFileTypes can be changed while the panel is running (ie: from an accessory view). The file type can be a common file extension, or a UTI. This is also known as the “enabled file types”. A nil value indicates that all files should be enabled.

Source

pub fn setAllowedFileTypes( &self, allowed_file_types: Option<&NSArray<NSString>>, )

👎Deprecated:

Use -allowedContentTypes instead

Available on crate features NSPanel and NSResponder and NSWindow only.

Setter for allowedFileTypes.

Available on crate features NSResponder and NSWindow only.

Setter for worksWhenModal.

Methods from Deref<Target = NSWindow>§

Source

pub fn frameRectForContentRect(&self, content_rect: CGRect) -> CGRect

Available on crate feature NSResponder only.

Source

pub fn contentRectForFrameRect(&self, frame_rect: CGRect) -> CGRect

Available on crate feature NSResponder only.

Source

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

Available on crate feature NSResponder only.

Source

pub fn setTitle(&self, title: &NSString)

Available on crate feature NSResponder only.

Setter for title.

This is copied when set.

Source

pub fn subtitle(&self) -> Retained<NSString>

Available on crate feature NSResponder only.

Secondary text that may be displayed adjacent to or below the primary title depending on the configuration of the window. A value of empty string will remove the subtitle from the window layout.

Source

pub fn setSubtitle(&self, subtitle: &NSString)

Available on crate feature NSResponder only.

Available on crate feature NSResponder only.

contentLayoutGuideis a corollary to contentLayoutRect.It can be used by autolayout constraints to automatically bind to the contentLayoutRect.

Source

pub fn removeTitlebarAccessoryViewControllerAtIndex(&self, index: isize)

Available on crate feature NSResponder only.

Source

pub fn representedURL(&self) -> Option<Retained<NSURL>>

Available on crate feature NSResponder only.

If url is not nil and its path is not empty, the window will show a document icon in the titlebar. If the url represents a filename or other resource with a known icon, that icon will be used as the document icon. Otherwise the default document icon will be used. The icon can be customized using -[[NSWindow standardWindowButton:NSWindowDocumentIconButton] setImage:customImage]. If url is not nil and its path is not empty, the window will have a pop-up menu which can be shown via command-click on the area containing the document icon and title. By default, this menu will display the path components of the url. The presence and contents of this menu can be controlled by the delegate method -[window:shouldPopUpDocumentPathMenu:] If the url is nil or has an empty path, the window will not show a document icon and will not have a pop-up menu available via command-click.

Source

pub fn setRepresentedURL(&self, represented_url: Option<&NSURL>)

Available on crate feature NSResponder only.

Setter for representedURL.

This is copied when set.

Source

pub fn representedFilename(&self) -> Retained<NSString>

Available on crate feature NSResponder only.

Source

pub fn setRepresentedFilename(&self, represented_filename: &NSString)

Available on crate feature NSResponder only.

Setter for representedFilename.

This is copied when set.

Source

Available on crate feature NSResponder only.

Setter for delegate.

This is a weak property.

Source

The frame to use when cascading or sizing a new window based on the receiver’s position or size. This may be different from frame when the receiver is positioned by the system.

Source

Source

pub fn preservesContentDuringLiveResize(&self) -> bool

Available on crate feature NSResponder only.

Source

pub fn setPreservesContentDuringLiveResize( &self, preserves_content_during_live_resize: bool, )

Available on crate feature NSResponder only.

Available on crate feature NSResponder only.

Available on crate feature NSResponder only.

§Safety

action must be a valid selector.
object should be of the correct type.

Source

pub fn setAutorecalculatesContentBorderThickness_forEdge( &self, flag: bool, edge: NSRectEdge, )

Available on crate feature NSResponder only.

Source

Available on crate feature NSResponder only.

Setter for miniwindowTitle.

This is copied when set.

Source

pub fn isDocumentEdited(&self) -> bool

Available on crate feature NSResponder only.

Source

pub fn setDocumentEdited(&self, document_edited: bool)

Available on crate feature NSResponder only.

Available on crate feature NSResponder only.

Source

pub fn preventsApplicationTerminationWhenModal(&self) -> bool

Available on crate feature NSResponder only.

A Boolean value that indicates whether or not to prevent application termination when the receiving window is presented modally. The value of this property is YES if the window should prevent application termination when modal; otherwise, NO. The default value is YES. However, note that some window subclasses and some windows created indirectly (like those created by UI frameworks like AppKit and SwiftUI), may have different default values. For example, the Open panel and toolbar customization sheets should not prevent application termination, so those windows have preventsApplicationTerminationWhenModal set to NO. Some NSAlerts, like those that are simply informational, have windows that do not prevent application termination by default. Setting this property overrides the default behavior.

Source

pub fn setPreventsApplicationTerminationWhenModal( &self, prevents_application_termination_when_modal: bool, )

Available on crate feature NSResponder only.

Available on crate feature NSResponder only.

Source

pub fn setDisplaysWhenScreenProfileChanges( &self, displays_when_screen_profile_changes: bool, )

Available on crate feature NSResponder only.

Setter for displaysWhenScreenProfileChanges.

Source

pub fn canBecomeVisibleWithoutLogin(&self) -> bool

Available on crate feature NSResponder only.

This API controls whether the receiver is permitted onscreen before the user has logged in. This property is off by default. Alert panels and windows presented by input managers are examples of windows which should have this property set.

Source

pub fn setCanBecomeVisibleWithoutLogin( &self, can_become_visible_without_login: bool, )

Available on crate feature NSResponder only.

Setter for canBecomeVisibleWithoutLogin.

Source

Available on crate feature NSResponder only.

Source

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

Available on crate feature NSResponder only.

Source

pub fn appearanceSource(&self) -> Option<Retained<NSObject>>

Available on crate features NSAppearance and NSResponder only.

pub fn setTitlebarSeparatorStyle( &self, titlebar_separator_style: NSTitlebarSeparatorStyle, )

Available on crate feature NSResponder only.

Setter for titlebarSeparatorStyle.

Source

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

Available on crate features NSResponder and NSViewController only.

The main content view controller for the window. This provides the contentView of the window. Assigning this value will remove the existing contentView and will make the contentViewController.view the main contentView for the window. The default value is nil. The contentViewController only controls the contentView, and not the title of the window. The window title can easily be bound to the contentViewController with the following: [window bind:NSTitleBinding toObject:contentViewController withKeyPath: “ title“ options:nil]. Setting the contentViewController will cause the window to resize based on the current size of the contentViewController. Autolayout should be used to restrict the size of the window. The value of the contentViewController is encoded in the NIB. Directly assigning a contentView will clear out the contentViewController.

Source

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

Available on crate features NSResponder and NSViewController only.

Setter for contentViewController.

Source

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

Available on crate features NSResponder and NSView only.

Source

pub fn setInitialFirstResponder(&self, initial_first_responder: Option<&NSView>)

Available on crate features NSResponder and NSView only.

Setter for initialFirstResponder.

pub fn recalculateKeyViewLoop(&self)

Available on crate feature NSResponder only.

Source

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

Available on crate feature NSResponder only.

Source

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

Available on crate feature NSResponder only.

Source

pub fn showsToolbarButton(&self) -> bool

👎Deprecated:

This property has no effect

Available on crate feature NSResponder only.

Source

pub fn setShowsToolbarButton(&self, shows_toolbar_button: bool)

👎Deprecated:

This property has no effect

Available on crate feature NSResponder only.

Setter for showsToolbarButton.

Source

pub fn tabbingMode(&self) -> NSWindowTabbingMode

Available on crate feature NSResponder only.

Get and set the tabbing mode for this window. This should be set before a window is shown. The default value is NSWindowTabbingModeAutomatic.When the value is NSWindowTabbingModeAutomatic,the system will look at the userTabbingPreferenceand automatically tab windows together based on the tabbingIdentifier, when it is appropriate to do so.

Source

pub fn setTabbingMode(&self, tabbing_mode: NSWindowTabbingMode)

Available on crate feature NSResponder only.

Setter for tabbingMode.

Source

pub fn tabbingIdentifier(&self) -> Retained<NSString>

Available on crate feature NSResponder only.

Windows with the same tabbingIdentifierwill have the ability to be tabbed together when a window is being shown. This allows aggregation of similar windows. By default, the tabbingIdentifierwill be generated based on inherent window properties, such as the window class name, the delegate class name, the window controller class name, and some additional state. Windows can be explicitly made to group together by using the same tabbingIdentifier.

Source

pub fn setTabbingIdentifier(&self, tabbing_identifier: &NSString)

Available on crate feature NSResponder only.

Setter for tabbingIdentifier.

This is copied when set.

Source

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

Available on crate feature NSResponder only.

Actions that can be called to perform various tabbed window behaviors. UI that is hooked up to these items can be automatically validated by calling NSWindow’s validateUserInterfaceItem.

Source

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

Available on crate feature NSResponder only.

Source

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

Available on crate feature NSResponder only.

Source

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

Available on crate feature NSResponder only.

Source

Available on crate feature NSResponder only.

Source

pub fn setAcceptsMouseMovedEvents(&self, accepts_mouse_moved_events: bool)

Available on crate feature NSResponder only.

Setter for acceptsMouseMovedEvents.

Source

pub fn ignoresMouseEvents(&self) -> bool

Available on crate feature NSResponder only.

Source

pub fn setIgnoresMouseEvents(&self, ignores_mouse_events: bool)

Available on crate feature NSResponder only.

👎Deprecated:

This property does not do anything and should not be used.

Available on crate feature NSResponder only.

Source

pub fn setShowsResizeIndicator(&self, shows_resize_indicator: bool)

👎Deprecated:

This property does not do anything and should not be used.

Available on crate feature NSResponder only.

Setter for showsResizeIndicator.

Source

pub fn windowRef(&self) -> NonNull<c_void>

👎Deprecated:

This method should not be used.

Available on crate feature NSResponder only.

Available on crate feature NSMenu only.

Source

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

Available on crate feature NSMenu only.

Setter for menu.

Source

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

§Safety

sender should be of the correct type.

Source

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.

Source

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

Source

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.

§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.

Source

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

Source

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

Methods from Deref<Target = NSObject>§

Source

pub fn doesNotRecognizeSelector(&self, sel: Sel) -> !

Handle messages the object doesn’t recognize.

See Apple’s documentation for details.

Methods from Deref<Target = AnyObject>§

Source

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());

Source

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.

Source

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`
    }
}