|
Mac OS 9
|
#include <Navigation.h>
Data Fields | |
| UInt16 | version |
| NavDialogOptionFlags | optionFlags |
| Point | location |
| CFStringRef | clientName |
| CFStringRef | windowTitle |
| CFStringRef | actionButtonLabel |
| CFStringRef | cancelButtonLabel |
| CFStringRef | saveFileName |
| CFStringRef | message |
| UInt32 | preferenceKey |
| CFArrayRef | popupExtension |
| WindowModality | modality |
| WindowRef | parentWindow |
| char | reserved [16] |
Summary: Options used to control the appearance and operation of a Nav Services dialog
Discussion: NavDialogCreationOptions is a preferred replacement for NavDialogOptions. The new structure uses CFStrings in place of Pascal strings, and adds fields for setting the dialog modality and the parent window (for sheet dialogs). A NavDialogCreationOptions structure can be initialized using NavDialogGetDefaultCreationOptions. Each of the NavCreate*Dialog functions accepts a pointer to the client's NavDialogCreationOptions structure.
| CFStringRef NavDialogCreationOptions::actionButtonLabel |
The custom label for the default (Open/Save/Choose) button. Specify NULL to use the default label.
| CFStringRef NavDialogCreationOptions::cancelButtonLabel |
The custom label for the Cancel button. Specify NULL to use the default label.
| CFStringRef NavDialogCreationOptions::clientName |
The user-readable name of the client, usually the name of the current application. This value is used to construct the default window title in the file dialogs, and the message text in the Ask dialogs. On Mac OS 9 and earlier, this value is used as a key to store persistent per-client dialog settings, so it's always a good idea to set this field to a non-NULL value.
| Point NavDialogCreationOptions::location |
The screen position at which to place the upper left corner of the dialog, in global coordinates. Specify (-1, -1) to use the default (persistent) location. Ignored for sheet dialogs.
| CFStringRef NavDialogCreationOptions::message |
For the file dialogs, a banner message appearing across the top of the dialog. Specify NULL to provide no banner message. For the Ask alerts, a custom message to replace the default message.
| WindowModality NavDialogCreationOptions::modality |
The modality in which to present the dialog. The default modality for all dialogs is kWindowModalityAppModal. If kWindowModalityWindowModal is specified, then a valid parentWindow is required.
| NavDialogOptionFlags NavDialogCreationOptions::optionFlags |
Options for the dialog. See NavDialogOptionFlags for a description of each option.
| WindowRef NavDialogCreationOptions::parentWindow |
The window to which a window-modal (sheet) dialog is to be attached.
| CFArrayRef NavDialogCreationOptions::popupExtension |
A CFArray of CFStrings. The strings are added as menu items to the Show or Format popup menus in the GetFile or PutFile dialogs, respectively.
| UInt32 NavDialogCreationOptions::preferenceKey |
A key to uniquely identify the dialog's usage context within the application. If an application uses the same class of dialog (e.g. GetFile or ChooseFile) for more than one purpose, set this field to a unique value for each usage in order to give each dialog its own persistent settings (e.g. screen rectangle, starting target folder).
| char NavDialogCreationOptions::reserved[16] |
Reserved for future use.
| CFStringRef NavDialogCreationOptions::saveFileName |
The initial value appearing in the edit text field for the file name to be saved (PutFile only).
| UInt16 NavDialogCreationOptions::version |
The version of the struture. Currently, the only valid version is 0, containing all the fields described here.
| CFStringRef NavDialogCreationOptions::windowTitle |
The custom title for the dialog window. Specify NULL to use the default title.