MLABFileDialog Class Reference

Inherits QObject.

Public Types
enum	Option {   ShowFilesAndDirs = 0 , ShowDirsOnly = QFileDialog::ShowDirsOnly , DontConfirmOverwrite = QFileDialog::DontConfirmOverwrite , DontUseSheet = QFileDialog::DontUseSheet ,   DontUseNativeDialog = QFileDialog::DontUseNativeDialog }

Public Slots
FileDialog methods
QString	getOpenFileName (const QString &initially, const QString &filter, const QString &caption, Option options=static_cast< Option >(0), MLABWidgetControl *parent=nullptr)
QString	getOpenFileName (const QString &initially, const QString &filter, const QString &caption, const QString &browsingGroup, Option options=static_cast< Option >(0), MLABWidgetControl *parent=nullptr)
QString	getSaveFileName (const QString &initially, const QString &filter, const QString &caption, Option options=static_cast< Option >(0), MLABWidgetControl *parent=nullptr)
QString	getSaveFileName (const QString &initially, const QString &filter, const QString &caption, const QString &browsingGroup, Option options=static_cast< Option >(0), MLABWidgetControl *parent=nullptr)
QString	getExistingDirectory (const QString &dir, const QString &caption, Option options=ShowDirsOnly, MLABWidgetControl *parent=nullptr)
QString	getExistingDirectory (const QString &dir, const QString &caption, const QString &browsingGroup, Option options=ShowDirsOnly, MLABWidgetControl *parent=nullptr)
QStringList	getOpenFileNames (const QString &filter, const QString &dir, const QString &caption, Option options=static_cast< Option >(0), MLABWidgetControl *parent=nullptr)
QStringList	getOpenFileNames (const QString &filter, const QString &dir, const QString &caption, const QString &browsingGroup, Option options=static_cast< Option >(0), MLABWidgetControl *parent=nullptr)
QString	lastFileDialogPath (const QString &browsingGroup="")
void	setLastFileDialogPath (const QString &path, const QString &browsingGroup="")

Detailed Description

Global MLABFileDialog object available in all script.s.

The MLABFileDialog object can be used as follows:

file1 = MLABFileDialog.getOpenFileName(ctx.localPath(), "Def/Script files (*.def *.script)", "Open file")
if not file1 == "":
  pass # ok
else:
  pass # cancel
 
MLAB.log(file1)
 
file2 = MLABFileDialog.getSaveFileName(ctx.localPath() + "/test.def", "Def/Script files (*.def *.script)", "Save file")
 
MLAB.log(file2)
 
file3 = MLABFileDialog.getExistingDirectory(ctx.localPath(), "Select a Directory")
MLAB.log(file3)
 
filelist = MLABFileDialog.getOpenFileNames("Def/Script files (*.def *.script)", ctx.localPath(), "Select multiple files")
i = 0
for file in filelist:
  ctx.log(str(i) + ": " + file
  i = i + 1

Member Enumeration Documentation

Option

enum MLABFileDialog::Option

file dialog options

Enumerator
ShowFilesAndDirs	Show both files and directories in the file dialog. This is the default.
ShowDirsOnly	Only show directories in the file dialog. By default both files and directories are shown.
DontConfirmOverwrite	Don't ask for confirmation if an existing file is selected. By default confirmation is requested.
DontUseSheet	Don't make the native file dialog a sheet. By default on macOS, the native file dialog is made a sheet if it has a parent that can take a sheet.
DontUseNativeDialog	Don't use the native file dialog. By default on macOS and Windows, the native file dialog is used.

Member Function Documentation

getExistingDirectory [1/2]

QString MLABFileDialog::getExistingDirectory ( const QString &  dir, const QString &  caption, const QString &  browsingGroup, Option  options = ShowDirsOnly, MLABWidgetControl *  parent = nullptr  )

slot

Same method with the browsingGroup parameter. (See getOpenFileName() about that.)

getExistingDirectory [2/2]

QString MLABFileDialog::getExistingDirectory ( const QString &  dir, const QString &  caption, Option  options = ShowDirsOnly, MLABWidgetControl *  parent = nullptr  )

inlineslot

Returns an existing directory, returns absolute path or empty string on cancel.

Script Example:

file1 = MLABFileDialog.getExistingDirectory(ctx.localPath(), "Select a Directory", MLABFileDialog.ShowDirsOnly)
if not file1 == "":
  pass # ok
else:
  pass # cancel

getOpenFileName [1/2]

QString MLABFileDialog::getOpenFileName ( const QString &  initially, const QString &  filter, const QString &  caption, const QString &  browsingGroup, Option  options = static_cast< Option >(0), MLABWidgetControl *  parent = nullptr  )

slot

Same method with the browsingGroup parameter.

Parameters

browsingGroup

If initially is empty the last used path is used as starting path. By selecting unique identifiers for browsingGroup you can have different last paths for different purposes.

getOpenFileName [2/2]

QString MLABFileDialog::getOpenFileName ( const QString &  initially, const QString &  filter, const QString &  caption, Option  options = static_cast<Option> (0), MLABWidgetControl *  parent = nullptr  )

inlineslot

Opens a file with a file dialog box, returns absolute path or empty string on cancel.

Script Example:

file1 = MLABFileDialog.getOpenFileName(ctx.localPath(), "Def/Script files (*.def *.script)", "Open file")
if not file1 == "":
  pass # ok
else:
  pass # cancel

Parameters

initially	An path to display initially
filter	Set one or more name filters - the format is that defined for QFileDialog, multiple filters must be separated by two semicolons
caption	A caption to show on top of the dialog
options	A set of options to modify the behavior of the dialog
parent	A parent control which is used to place the dialog

getOpenFileNames [1/2]

QStringList MLABFileDialog::getOpenFileNames ( const QString &  filter, const QString &  dir, const QString &  caption, const QString &  browsingGroup, Option  options = static_cast< Option >(0), MLABWidgetControl *  parent = nullptr  )

slot

Same method with the browsingGroup parameter. (See getOpenFileName() about that.)

getOpenFileNames [2/2]

QStringList MLABFileDialog::getOpenFileNames ( const QString &  filter, const QString &  dir, const QString &  caption, Option  options = static_cast<Option> (0), MLABWidgetControl *  parent = nullptr  )

inlineslot

Returns multiple filenames with a file dialog box, returns a list of absolute paths.

Script Example:

filelist = MLABFileDialog.getOpenFileNames("Def/Script files (*.def *.script)", ctx.localPath(), "Select multiple files")
i = 0
for file in filelist:
  ctx.log(str(i) + ": " + file
  i = i + 1

getSaveFileName [1/2]

QString MLABFileDialog::getSaveFileName ( const QString &  initially, const QString &  filter, const QString &  caption, const QString &  browsingGroup, Option  options = static_cast< Option >(0), MLABWidgetControl *  parent = nullptr  )

slot

Same method with the browsingGroup parameter. (See getOpenFileName() about that.)

getSaveFileName [2/2]

QString MLABFileDialog::getSaveFileName ( const QString &  initially, const QString &  filter, const QString &  caption, Option  options = static_cast<Option> (0), MLABWidgetControl *  parent = nullptr  )

inlineslot

Saves a file with a file dialog box, returns absolute path or empty string on cancel.

Script Example:

file1 = MLABFileDialog.getSaveFileName(ctx.localPath() + "/test.def", "Def/Script files (*.def *.script)", "Save file",
                                       MLABFileDialog.DontConfirmOverwrite | MLABFileDialog.DontUseSheet)
if not file1 == "":
  pass # ok
else:
  pass # cancel

lastFileDialogPath

QString MLABFileDialog::lastFileDialogPath ( const QString &  browsingGroup = "" )

slot

Return the path last used with the given browsingGroup.

setLastFileDialogPath

void MLABFileDialog::setLastFileDialogPath ( const QString &  path, const QString &  browsingGroup = ""  )

slot

Set the path to show for the given browsingGroup when the next file dialog is opened (this is only used if no default file path is given for that dialog).

This path is persistent across runs of an application and holds the last path used in a file dialog (without cancelling).