MeVisLab Scripting Reference
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=NULL)
 
QString getSaveFileName (const QString &initially, const QString &filter, const QString &caption, Option options=DontConfirmOverwrite, MLABWidgetControl *parent=NULL)
 
QString getExistingDirectory (const QString &dir, const QString &caption, Option options=ShowDirsOnly, MLABWidgetControl *parent=NULL)
 
QStringList getOpenFileNames (const QString &filter, const QString &dir, const QString &caption, Option options=static_cast< Option >(0), MLABWidgetControl *parent=NULL)
 

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 Function Documentation

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

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
QString MLABFileDialog::getOpenFileName ( const QString &  initially,
const QString &  filter,
const QString &  caption,
Option  options = static_cast< Option >(0),
MLABWidgetControl parent = NULL 
)
slot

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
QStringList MLABFileDialog::getOpenFileNames ( const QString &  filter,
const QString &  dir,
const QString &  caption,
Option  options = static_cast< Option >(0),
MLABWidgetControl parent = NULL 
)
slot

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
QString MLABFileDialog::getSaveFileName ( const QString &  initially,
const QString &  filter,
const QString &  caption,
Option  options = DontConfirmOverwrite,
MLABWidgetControl parent = NULL 
)
slot

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",
if not file1 == "":
pass # ok
else:
pass # cancel