The IFileDialog::Settings class contains input for an IFileDialog object. If you do not specify a Settings object on the IFileDialog constructor, a default Settings object is created for you. This default object provides an open dialog with no other settings in effect.
You can pass the following information within an IFileDialog::Settings object to an IFileDialog:
You can also specify the following items within a Settings object:
You can construct and destruct objects of this class.
![]() |
public:
~Settings()
Windows | OS/2 | AIX |
Yes | Yes | Yes |
![]() |
public:
Settings()
Provides the default constructor, which accepts no parameters.
Windows | OS/2 | AIX |
Yes | Yes | Yes |
Use these members to customize the file dialog presented to the user. The file dialog includes the dialog's title, OK push button's text, dialog position, and the dialog template to use.
![]() |
public:
bool isDialogTemplateSet() const
Returns true if the dialog template was set.
Windows | OS/2 | AIX |
Yes | Yes | Yes |
![]() |
public:
bool isPositionSet() const
Returns true if the dialog position was set.
Windows | OS/2 | AIX |
Yes | Yes | Yes |
![]() |
public:
IString okButtonText() const
Returns the text of the OK push button.
Windows | OS/2 | AIX |
Yes | Yes | Yes |
![]() |
public:
IPoint position() const
Returns the initial placement of the dialog within the parent window.
Windows | OS/2 | AIX |
Yes | Yes | Yes |
![]() |
public:
Settings& setDialogTemplate(const IResourceId& resId)
Sets a dialog template resource to use in place of the supplied default file dialog.
Windows | OS/2 | AIX |
Yes | Yes | Ignored |
![]() |
Sets the text that appears on the OK push button. The parameters are one of the following:
public:
Settings& setOKButtonText(const char* newText)
Windows | OS/2 | AIX |
Yes | Yes | Yes |
public:
Settings& setOKButtonText(const IResourceId& resId)
Windows | OS/2 | AIX |
Yes | Yes | Yes |
![]() |
public:
Settings& setPosition(const IPoint& position)
Sets the initial placement of the dialog within the parent window.
Windows | OS/2 | AIX |
Yes | Yes | Yes |
![]() |
Sets the dialog's title. The parameters are one of the following:
public:
Settings& setTitle(const char* newTitle)
Windows | OS/2 | AIX |
Yes | Yes | Yes |
public:
Settings& setTitle(const IResourceId& resId)
Windows | OS/2 | AIX |
Yes | Yes | Yes |
![]() |
public:
IString title() const
Returns the dialog's title.
Windows | OS/2 | AIX |
Yes | Yes | Yes |
Use these members to set and query the initial information that appears in the dialog.
![]() |
public:
Settings& addDrive(const char* drive)
Adds a drive or network identifier to the Drive list in the initial dialog. If you call this function, the Drive list is limited to the drives you specify in drive.
Windows | OS/2 | AIX |
Ignored | Yes | Ignored |
![]() |
public:
Settings& addFileType( const char* fileType, const char* filter = 0 )
Adds the specified type to the drop-down list box of extended-attribute types in OS/2, or adds a description and file filter to the file types list box in Windows.
Windows | OS/2 | AIX |
Yes | Yes | Ignored |
![]() |
public:
IString fileName() const
Returns the default file name selection.
Windows | OS/2 | AIX |
Yes | Yes | Yes |
![]() |
public:
IString initialDrive() const
Returns the drive for which initial information is displayed.
Windows | OS/2 | AIX |
Yes | Yes | Ignored |
![]() |
public:
IString initialFileType() const
Returns the file type that is used to filter the initial list of files.
Windows | OS/2 | AIX |
Ignored | Yes | Ignored |
![]() |
public:
bool isOpenDialog() const
Returns true if dialog is an open dialog.
Windows | OS/2 | AIX |
Yes | Yes | Yes |
![]() |
public:
Settings& setFileName( const char* fileName, bool fileNameIsFilter = true )
Sets a default file name selection.
Windows | OS/2 | AIX |
Yes | Yes | Yes |
The second parameter is ignored.
The second parameter is ignored.
![]() |
public:
Settings& setInitialDrive(const char* drive)
Sets the drive for which initial information is displayed. If you do not call this function, the dialog displays the information for the current drive. If you specify a drive for this function, you do not have to specify it again when calling addDrive.
Windows | OS/2 | AIX |
Yes | Yes | Ignored |
![]() |
public:
Settings& setInitialFileType(const char* fileType)
Sets the extended attribute that filters the initial display of files.
If you do not call this function, the default is
Windows | OS/2 | AIX |
Ignored | Yes | Ignored |
![]() |
public:
Settings& setOpenDialog()
Creates an Open File dialog. An Open File dialog has the list of files enabled for selection, while a Save As dialog has this list disabled. An Open File dialog is the default.
Windows | OS/2 | AIX |
Yes | Yes | Yes |
![]() |
public:
Settings& setSaveAsDialog()
Creates a Save As dialog. An Open File dialog is the default. By default, an Open File dialog has the list of files enabled for selection, while a Save As dialog has this list disabled. You can use the style IFileDialog::selectableListbox to force the list of files to be selectable on a Save As dialog.
Windows | OS/2 | AIX |
Yes | Yes | Yes |