- Generated by
1.9.1
|
Mac OS 9
|
#include <Navigation.h>
Data Fields | |
| UInt16 | version |
| Boolean | validRecord |
| Boolean | replacing |
| Boolean | isStationery |
| Boolean | translationNeeded |
| AEDescList | selection |
| ScriptCode | keyScript |
| FileTranslationSpecArrayHandle | fileTranslation |
| UInt32 | reserved1 |
| CFStringRef | saveFileName |
| Boolean | saveFileExtensionHidden |
| UInt8 | reserved2 |
| char | reserved [225] |
Summary: A structure describing the results of a Nav Services dialog
Discussion: A reply record is the result of a Nav Services file dialog. Using the older API, which is always modal, the client passes the address of a reply record when invoking the dialog. In the Carbon API, dialogs may also be window modal or modeless, so the client requests the reply record by calling NavDialogGetReply when a kNavCBUserAction event is received. Either way, a reply record should be disposed of using NavDisposeReply.
| FileTranslationSpecArrayHandle NavReplyRecord::fileTranslation |
A handle to an array of type FileTranslationSpec. Each array entry corresponds to an item in the selection and describes the translation that was performed (GetFile) or needs to be performed (PutFile) on that item.
| Boolean NavReplyRecord::isStationery |
True if this reply is from a PutFile dialog and the user wants to save the file as stationery.
| Boolean NavReplyRecord::replacing |
True if this reply is from a PutFile dialog and the file to be saved already exists and needs to be replaced. The user has already been warned unless the kNavDontConfirmReplacement option flag is used.
| char NavReplyRecord::reserved[225] |
Reserved for future use.
| UInt32 NavReplyRecord::reserved1 |
Reserved for private use.
| UInt8 NavReplyRecord::reserved2 |
Reserved for future use.
| Boolean NavReplyRecord::saveFileExtensionHidden |
The extension on the name of the saved file should be hidden. Once the file has been saved, the client should call NavCompleteSave. NavCompleteSave will take care of hiding the extension on the file. However, the client needs to know that the extension is hidden so that it can display the document name correctly in the UI, such as in window titles and menus. This field is only used if the client has r equested extension preservation using the kNavPreserveSaveFileExtension dialog option flag. This field was added in structure version 2.
| CFStringRef NavReplyRecord::saveFileName |
Carbon PutFile dialog only: the name of the file to be saved. This field contains the true file name to saved, even if the extension will be hidden from the user. This field was added in structure version 1.
| AEDescList NavReplyRecord::selection |
For GetFile or Choose dialogs, a list of items chosen by the user. For the older NavPutFile dialog, a list containing one item: an FSSpec of the file to be saved. ** IMPORTANT NOTE *** For the new Carbon-only PutFile dialog created with NavCreatePutFileDialog, the selection is a list containing one item: the DIRECTORY where the file is to be saved. The file name is obtained from the saveFileName field. When using the original modal API, each descriptor will contain an FSSpec (typeFSS). When using the new Carbon-only dialogs created via the NavCreate*Dialog functions, each descriptor could contain either an FSSpec (typeFSS, used on Mac OS 8 or 9) or an FSRef (typeFSRef, used on Mac OS X). This divergence is caused by the need to use FSRef (for Unicode/HFS+ support) on Mac OS X, while being unable to provide FSRefs on Mac OS 8.6.
| Boolean NavReplyRecord::translationNeeded |
True if translation was performed on the file(s) to be opened or if transtlation will be needed on the file to be saved.
| Boolean NavReplyRecord::validRecord |
True if the reply contains a non-null selection
| UInt16 NavReplyRecord::version |
The version of the structure. The first public version of the structure was version 0. Fields added after version 0, starting with the saveFileName field, are noted below.
1.9.1