NSOpenSavePanelDelegate Protocol Reference

Conforms to
Framework
/System/Library/Frameworks/AppKit.framework
Availability
Available in OS X v10.6 and later.
Declared in
NSSavePanel.h
Companion guides
Application File Management
Sheet Programming Topics
Related sample code

Overview

The NSOpenSavePanelDelegate protocol defines the methods that a delegate of NSOpenPanel or NSSavePanel should implement.

Tasks

Running Panels

Instance Methods

panel:didChangeToDirectoryURL:

Informs the delegate that the user changed the selected directory to the directory located at the specified URL. The URL may be nil if the current URL can’t be represented by an NSURL object.

- (void)panel:(id)sender didChangeToDirectoryURL:(NSURL *)url
Parameters
sender

The panel whose directory changed.

url

The URL of the new directory, or nil if it can’t be represented by an NSURL object.

Availability
  • Available in OS X v10.6 and later.
Declared In
NSSavePanel.h

panel:shouldEnableURL:

For NSOpenPanel delegates, asks the delegate whether the specified URL should be enabled in the panel. This method is not called for NSSavePanel delegates; all URLs are always disabled.

- (BOOL)panel:(id)sender shouldEnableURL:(NSURL *)url
Parameters
sender

The panel asking whether the URL should be enabled.

url

The URL to be checked.

Return Value

YES to allow the URL to be enabled in the panel; otherwise, NO.

Discussion

Implementations of this method should be fast to avoid stalling the user interface. Use panel:validateURL:error: instead if processing will take a long time.

Availability
  • Available in OS X v10.6 and later.
Declared In
NSSavePanel.h

panel:userEnteredFilename:confirmed:

Tells the delegate that the user confirmed a filename choice by clicking Save in a Save panel.

- (NSString *)panel:(id)sender userEnteredFilename:(NSString *)filename confirmed:(BOOL)okFlag
Parameters
sender

The panel reporting the user’s confirmation of a filename choice.

filename

The user’s filename choice.

okFlag

If YES, the user clicked the Save button; if NO, the user did not.

Return Value

You can either leave the filename alone, or return nil to cancel the save and leave the Save panel as is. (If your app is not running in a sandbox, you can also sanitize the filename to remove undesirable characters, limit its length, and so on.)

This method is called before any required extension is appended to the filename and before the Save panel asks the user to replace an existing file, if applicable.

This method may be called multiple times in the sessions as the user types. In those cases, okFlag will be NO until the user confirms the choice, in which case okFlag will become YES. If the delegate does extensive validation or puts up alerts, it should do so only when okFlag is YES.

Availability
  • Available in OS X v10.0 and later.
  • Available as part of an informal protocol prior to OS X v10.6.
Declared In
NSSavePanel.h

panel:validateURL:error:

For NSSavePanel delegates, asks the delegate for file URL validation when the user chooses the Save button. For NSOpenPanel delegates, asks the delegate for file URL validation once for each selected filename (or directory) when the user chooses the Open button.

- (BOOL)panel:(id)sender validateURL:(NSURL *)url error:(NSError **)outError
Parameters
sender

The panel requesting URL validation.

url

The URL to be validated.

outError

If an error occurred during validation, the error that occurred.

Return Value

YES if the URL is an acceptable URL to save to or to open; otherwise, NO.

Availability
  • Available in OS X v10.6 and later.
Declared In
NSSavePanel.h

panel:willExpand:

Tells the delegate that the Save panel is about to expand or collapse because the user clicked the disclosure triangle that displays or hides the file browser.

- (void)panel:(id)sender willExpand:(BOOL)expanding
Parameters
sender

The panel that is about to expand or collapse.

expanding

YES specifies that the panel is expanding; NO specifies that it is collapsing.

Availability
  • Available in OS X v10.0 and later.
  • Available as part of an informal protocol prior to OS X v10.6.
Declared In
NSSavePanel.h

panelSelectionDidChange:

Tells the delegate that the user changed the selection in the specified Save panel.

- (void)panelSelectionDidChange:(id)sender
Parameters
sender

The panel whose selection changed.

Availability
  • Available in OS X v10.3 and later.
  • Available as part of an informal protocol prior to OS X v10.6.
Declared In
NSSavePanel.h