Qmmp
Public Types | Signals | Static Public Member Functions | Protected Member Functions
FileDialog Class Reference

#include <filedialog.h>

Inherited by QtFileDialog.

List of all members.

Public Types

enum  Mode {
  AddFile = 0, AddDir, AddFiles, AddDirs,
  AddDirsFiles, SaveFile
}

Signals

void filesAdded (const QStringList &)

Static Public Member Functions

static QList< FileDialogFactory * > factories ()
static void setEnabled (FileDialogFactory *factory)
static bool isEnabled (FileDialogFactory *factory)
static QString file (FileDialogFactory *factory)
static QString getExistingDirectory (QWidget *parent=0, const QString &caption=QString(), const QString &dir=QString())
static QString getOpenFileName (QWidget *parent=0, const QString &caption=QString(), const QString &dir=QString(), const QString &filter=QString(), QString *selectedFilter=0)
static QStringList getOpenFileNames (QWidget *parent=0, const QString &caption=QString(), const QString &dir=QString(), const QString &filter=QString(), QString *selectedFilter=0)
static QString getSaveFileName (QWidget *parent=0, const QString &caption=QString(), const QString &dir=QString(), const QString &filter=QString(), QString *selectedFilter=0)
static void popup (QWidget *parent=0, Mode mode=AddFiles, QString *dir=0, QObject *receiver=0, const char *member=0, const QString &caption=QString(), const QString &filters=QString())

Protected Member Functions

 FileDialog ()
virtual QString existingDirectory (QWidget *parent, const QString &caption, const QString &dir)
virtual QString openFileName (QWidget *parent, const QString &caption, const QString &dir, const QString &filter, QString *selectedFilter)
virtual QStringList openFileNames (QWidget *parent, const QString &caption, const QString &dir, const QString &filter, QString *selectedFilter)
virtual QString saveFileName (QWidget *parent, const QString &caption, const QString &dir, const QString &filter, QString *selectedFilter)
virtual ~FileDialog ()
virtual void raise (const QString &dir=QString(), Mode mode=AddFiles, const QString &caption=QString(), const QStringList &mask=QStringList())

Detailed Description

The FileDialog class is the base interface class of the file dialogs.

Author:
Vladimir Kuznetsov <vovanec@gmail.com>

Member Enumeration Documentation

enum Mode

Enum of available file dialog modes

Enumerator:
AddFile 

Get existing file

AddDir 

Get existing directory

AddFiles 

Get existing files

AddDirs 

Get existing directories

AddDirsFiles 

Get existing files and directories

SaveFile 

Get existing or non-existing file


Constructor & Destructor Documentation

FileDialog ( ) [protected]

Object constructor.

virtual ~FileDialog ( ) [protected, virtual]

Object destructor


Member Function Documentation

virtual QString existingDirectory ( QWidget *  parent,
const QString &  caption,
const QString &  dir 
) [protected, virtual]

This is a function that will open modal file dialog and return an existing directory selected by the user.

Parameters:
parentParent widget.
captionDialog title.
dirDefault directory.
static QList<FileDialogFactory*> factories ( ) [static]

Returns a list of registered file dialog factories.

static QString file ( FileDialogFactory factory) [static]

Returns plugin file path.

Parameters:
factoryFile dialog plugin factory.
void filesAdded ( const QStringList &  ) [signal]

Emitted when the add button has pressed. Subclass should emit this signal.

static QString getExistingDirectory ( QWidget *  parent = 0,
const QString &  caption = QString(),
const QString &  dir = QString() 
) [static]

This is a static function that will open modal file dialog and return an existing directory selected by the user.

Parameters:
parentParent widget.
captionDialog title.
dirDefault directory.
static QString getOpenFileName ( QWidget *  parent = 0,
const QString &  caption = QString(),
const QString &  dir = QString(),
const QString &  filter = QString(),
QString *  selectedFilter = 0 
) [static]

This is a static function that will open modal file dialog and return an existing file selected by the user.

Parameters:
parentParent widget.
captionDialog title.
dirDefault directory.
filterFiler used by file dialog (example: "Audio (*.mp3 *.ogg);;Text files (*.txt);;XML files (*.xml)").
selectedFilterDefault selected filter
static QStringList getOpenFileNames ( QWidget *  parent = 0,
const QString &  caption = QString(),
const QString &  dir = QString(),
const QString &  filter = QString(),
QString *  selectedFilter = 0 
) [static]

This is a static function that will open modal file dialog and return an existing file selected by the user.

Parameters:
parentParent widget.
captionDialog title.
dirDefault directory.
filterFiler used by file dialog (example: "Audio (*.mp3 *.ogg);;Text files (*.txt);;XML files (*.xml)").
selectedFilterDefault selected filter.
static QString getSaveFileName ( QWidget *  parent = 0,
const QString &  caption = QString(),
const QString &  dir = QString(),
const QString &  filter = QString(),
QString *  selectedFilter = 0 
) [static]

This is a static function that will open modal file dialog and return a file name selected by the user. The file does not have to exist.

Parameters:
parentParent widget.
captionDialog title.
dirDefault directory.
filterFiler used by file dialog (example: "Audio (*.mp3 *.ogg);;Text files (*.txt);;XML files (*.xml)").
selectedFilterDefault selected filter.
static bool isEnabled ( FileDialogFactory factory) [static]

Returns true if file dialog factory is used by default, otherwise returns false

virtual QString openFileName ( QWidget *  parent,
const QString &  caption,
const QString &  dir,
const QString &  filter,
QString *  selectedFilter 
) [protected, virtual]

This is a function that will open modal file dialog and return an existing file selected by the user. Subclass should reimplement this function.

Parameters:
parentParent widget.
captionDialog title.
dirDefault directory.
filterFiler used by file dialog (example: "Audio (*.mp3 *.ogg);;Text files (*.txt);;XML files (*.xml)").
selectedFilterDefault selected filter
virtual QStringList openFileNames ( QWidget *  parent,
const QString &  caption,
const QString &  dir,
const QString &  filter,
QString *  selectedFilter 
) [protected, virtual]

This is a function that will open modal file dialog and return an existing files selected by the user. Subclass should reimplement this function.

Parameters:
parentParent widget.
captionDialog title.
dirDefault directory.
filterFiler used by file dialog (example: "Audio (*.mp3 *.ogg);;Text files (*.txt);;XML files (*.xml)").
selectedFilterDefault selected filter
static void popup ( QWidget *  parent = 0,
Mode  mode = AddFiles,
QString *  dir = 0,
QObject *  receiver = 0,
const char *  member = 0,
const QString &  caption = QString(),
const QString &  filters = QString() 
) [static]

Opens nonmodal file dialog. Selected file dialog should support nonmodal mode. Otherwise this function creates modal dialog.

Parameters:
parentParent widget.
modeFile dialog mode.
dirDefault directory.
receiverReceiver QObject.
memberReceiver slot.
captionDialog title.
filtersFiler used by file dialog (example: "Audio (*.mp3 *.ogg);;Text files (*.txt);;XML files (*.xml)").

Usage: FileDialog::popup(this, FileDialog::AddDirs, &m_lastDir, m_playListModel, SLOT(addFileList(const QStringList&)), tr("Choose a directory"));

virtual void raise ( const QString &  dir = QString(),
Mode  mode = AddFiles,
const QString &  caption = QString(),
const QStringList &  mask = QStringList() 
) [protected, virtual]

Opens nonmodal file dialog. Selected file dialog should support nonmodal mode. Otherwise this function does nothing. Nonmodal dialog subclass should reimplement this function.

Parameters:
dirDefault directory.
modeFile dialog mode.
captionDialog title.
maskFiler used by file dialog
virtual QString saveFileName ( QWidget *  parent,
const QString &  caption,
const QString &  dir,
const QString &  filter,
QString *  selectedFilter 
) [protected, virtual]

This is a function that will open modal file dialog and return a file name selected by the user. The file does not have to exist. Subclass should reimplement this function.

Parameters:
parentParent widget.
captionDialog title.
dirDefault directory.
filterFiler used by file dialog (example: "Audio (*.mp3 *.ogg);;Text files (*.txt);;XML files (*.xml)").
selectedFilterDefault selected filter.
static void setEnabled ( FileDialogFactory factory) [static]

Selects current file dialog factory.


The documentation for this class was generated from the following file:
 All Classes Functions Variables Enumerations Enumerator