TSdlDialog
Provides (file) dialog functionality
Definition
Unit: Neslib.Sdl3.Additional
Methods
| Name | Description |
|---|---|
| ShowOpenFile | Displays a dialog that lets the user select a file on their filesystem to open a file from. |
| ShowOpenFolder | Displays a dialog that lets the user select a folder on their filesystem. |
| ShowSaveFile | Displays a dialog that lets the user choose a new or existing file on their filesystem to save a file to. |
Method Descriptions
ShowOpenFile(TSdlDialogFileCallback, TSdlWindow, TArray<TSdlDialogFileFilter>, String, Boolean)
Displays a dialog that lets the user select a file on their filesystem to open a file from.
This is an asynchronous function; it will return immediately, and the result will be passed to the callback.
The callback will be invoked with a list of files the user chose. The list will be nil (empty) if the user canceled the dialog.
Note that the callback may be called from a different thread than the one the function was invoked on.
Depending on the platform, the user may be allowed to input paths that don't yet exist.
class procedure ShowOpenFile(const ACallback: TSdlDialogFileCallback; const AWindow: TSdlWindow; const AFilters: TArray<TSdlDialogFileFilter> = nil; const ADefaultLocation: String = ''; const AAllowMany: Boolean = False); static
Parameters
ACallback: TSdlDialogFileCallback
: The callback to be invoked when the user selects one or more files and accepts, or cancels the dialog, or an error occurs.
AWindow: TSdlWindow
: The window that the dialog should be modal for, may be nil. Not all platforms support this option.
AFilters: TArray<TSdlDialogFileFilter> = nil
: (Optional) list of filters. Not all platforms support this option, and platforms that do support it may allow the user to ignore the filters.
ADefaultLocation: String = ''
: (Optional) default folder or file to start the dialog at. Not all platforms support this option.
AAllowMany: Boolean = False
: (Optional) whether the user will be allowed to select multiple entries. Defaults to False. Not all platforms support this option.
See Also
Remarks
This method should be called only from the main thread. The callback may be invoked from the same thread or from a different one, depending on the OS's constraints.
ShowOpenFolder(TSdlDialogFileCallback, TSdlWindow, String, Boolean)
Displays a dialog that lets the user select a folder on their filesystem.
This is an asynchronous function; it will return immediately, and the result will be passed to the callback.
The callback will be invoked with a list with the folder the user chose. The list will be empty if the user canceled the dialog.
Note that the callback may be called from a different thread than the one the function was invoked on.
Depending on the platform, the user may be allowed to input paths that don't yet exist.
class procedure ShowOpenFolder(const ACallback: TSdlDialogFileCallback; const AWindow: TSdlWindow; const ADefaultLocation: String = ''; const AAllowMany: Boolean = False); static
Parameters
ACallback: TSdlDialogFileCallback
: The callback to be invoked when the user selects a folder and accepts, or cancels the dialog, or an error occurs.
AWindow: TSdlWindow
: The window that the dialog should be modal for, may be nil. Not all platforms support this option.
ADefaultLocation: String = ''
: (Optional) default folder or file to start the dialog at. Not all platforms support this option.
AAllowMany: Boolean = False
: (Optional) whether the user will be allowed to select multiple entries. Defaults to False. Not all platforms support this option.
See Also
Remarks
This method should be called only from the main thread. The callback may be invoked from the same thread or from a different one, depending on the OS's constraints.
ShowSaveFile(TSdlDialogFileCallback, TSdlWindow, TArray<TSdlDialogFileFilter>, String)
Displays a dialog that lets the user choose a new or existing file on their filesystem to save a file to.
This is an asynchronous function; it will return immediately, and the result will be passed to the callback.
The callback will be invoked with a list with the file the user chose. The list will be empty if the user canceled the dialog.
Note that the callback may be called from a different thread than the one the function was invoked on.
The chosen file may or may not already exist.
class procedure ShowSaveFile(const ACallback: TSdlDialogFileCallback; const AWindow: TSdlWindow; const AFilters: TArray<TSdlDialogFileFilter> = nil; const ADefaultLocation: String = ''); static
Parameters
ACallback: TSdlDialogFileCallback
: The callback to be invoked when the user selects a file and accepts, or cancels the dialog, or an error occurs.
AWindow: TSdlWindow
: The window that the dialog should be modal for, may be nil. Not all platforms support this option.
AFilters: TArray<TSdlDialogFileFilter> = nil
: (Optional) list of filters. Not all platforms support this option, and platforms that do support it may allow the user to ignore the filters.
ADefaultLocation: String = ''
: (Optional) default folder or file to start the dialog at. Not all platforms support this option.
See Also
Remarks
This method should be called only from the main thread. The callback may be invoked from the same thread or from a different one, depending on the OS's constraints.