MLABFileDialog Class Reference
[Scripting]

Global MLABFileDialog object available in all scripts. More...

List of all members.

Public Types
Public Slots
FileDialog methods
QString	getExistingDirectory (const QString &dir, const QString &caption, Option options=ShowDirsOnly, MLABWidgetControl *parent=NULL)
QString	getOpenFileName (const QString &initially, const QString &filter, const QString &caption, Option options=static_cast< Option >(0), MLABWidgetControl *parent=NULL)
QStringList	getOpenFileNames (const QString &filter, const QString &dir, 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)

---

Detailed Description

Global MLABFileDialog object available in all scripts.

The MLABFileDialog object can be used as follows:

  var file1 = MLABFileDialog.getOpenFileName(ctx.localPath(), "Def/Script files (*.def *.script)", "Open file");
  if (file1!="") {
    // ok
  } else {
    // cancel
  }

  MLAB.log(file1);

  var file2 = MLABFileDialog.getSaveFileName(ctx.localPath() + "/test.def", "Def/Script files (*.def *.script)", "Save file");

  MLAB.log(file2);

  var file3 = MLABFileDialog.getExistingDirectory(ctx.localPath(), "Select a Directory");
  MLAB.log(file3);

  var filelist = MLABFileDialog.getOpenFileNames("Def/Script files (*.def *.script)", ctx.localPath(), "Select multiple files");
  var i;
  for (i = 0; i < filelist.length; i++) {
    ctx.log(i + ": " + filelist[i]);
  }

---

Member Enumeration Documentation

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 Mac OS X, 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 Mac OS X and Windows, the native file dialog is used.

---

Member Function Documentation

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

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

Script Example:

  var file1 = MLABFileDialog.getExistingDirectory(ctx.localPath(), "Select a Directory", MLABFileDialog.ShowDirsOnly);
  if (file1!="") {
    // ok
  } else {
    // cancel
  }

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

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

Script Example:

  var file1 = MLABFileDialog.getOpenFileName(ctx.localPath(), "Def/Script files (*.def *.script)", "Open file");
  if (file1!="") {
    // ok
  } else {
    // cancel
  }

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

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

Script Example:

  var filelist = MLABFileDialog.getOpenFileNames("Def/Script files (*.def *.script)", ctx.localPath(), "Select multiple files");
  var i;
  for (i = 0; i < filelist.length; i++) {
    ctx.log(i + ": " + filelist[i]);
  }

QString MLABFileDialog::getSaveFileName	(	const QString &	initially,
		const QString &	filter,
		const QString &	caption,
		Option	options = DontConfirmOverwrite,
		MLABWidgetControl *	parent = NULL
	)			[slot]

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

Script Example:

  var file1 = MLABFileDialog.getSaveFileName(ctx.localPath() + "/test.def", "Def/Script files (*.def *.script)", "Save file",
                                             MLABFileDialog.DontConfirmOverwrite | MLABFileDialog.DontUseSheet);
  if (file1!="") {
    // ok
  } else {
    // cancel
  }