The FileDialog class is the base interface class of the file dialogs.
More...
#include <filedialog.h>
Inherited by QtFileDialog.
List of all members.
Public Types |
enum | Mode {
AddFile = 0,
AddDir,
AddFiles,
AddDirs,
AddDirsFiles,
PlayDirsFiles,
SaveFile
} |
Signals |
void | filesSelected (const QStringList &selected, bool play=false) |
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 | ~FileDialog () |
virtual void | raise (const QString &dir, Mode mode, const QString &caption, const QStringList &mask) |
virtual QStringList | exec (QWidget *parent, const QString &dir, Mode mode, const QString &caption, const QString &filter=QString(), QString *selectedFilter=0)=0 |
Detailed Description
The FileDialog class is the base interface class of the file dialogs.
- Author:
- Vladimir Kuznetsov <vovanec@gmail.com>
Member Enumeration Documentation
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
|
PlayDirsFiles |
Get existing files and directories with play button (if supported)
|
SaveFile |
Get existing or non-existing file
|
Constructor & Destructor Documentation
Member Function Documentation
virtual QStringList exec |
( |
QWidget * |
parent, |
|
|
const QString & |
dir, |
|
|
Mode |
mode, |
|
|
const QString & |
caption, |
|
|
const QString & |
filter = QString() , |
|
|
QString * |
selectedFilter = 0 |
|
) |
| [protected, pure virtual] |
This is a function that will open modal file dialog and return a file(s) or directory name selected by the user. Subclass should reimplement this function.
- Parameters:
-
parent | Parent widget. |
dir | Default directory. |
mode | File dialog mode. |
caption | Dialog title. |
filter | Filer used by file dialog (example: "Audio (*.mp3 *.ogg);;Text files (*.txt);;XML files (*.xml)"). |
selectedFilter | Default selected filter. |
Returns a list of registered file dialog factories.
Returns plugin file path.
- Parameters:
-
factory | File dialog plugin factory. |
void filesSelected |
( |
const QStringList & |
selected, |
|
|
bool |
play = false |
|
) |
| [signal] |
Emitted when the add/open 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:
-
parent | Parent widget. |
caption | Dialog title. |
dir | Default 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:
-
parent | Parent widget. |
caption | Dialog title. |
dir | Default directory. |
filter | Filer used by file dialog (example: "Audio (*.mp3 *.ogg);;Text files (*.txt);;XML files (*.xml)"). |
selectedFilter | Default 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:
-
parent | Parent widget. |
caption | Dialog title. |
dir | Default directory. |
filter | Filer used by file dialog (example: "Audio (*.mp3 *.ogg);;Text files (*.txt);;XML files (*.xml)"). |
selectedFilter | Default 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:
-
parent | Parent widget. |
caption | Dialog title. |
dir | Default directory. |
filter | Filer used by file dialog (example: "Audio (*.mp3 *.ogg);;Text files (*.txt);;XML files (*.xml)"). |
selectedFilter | Default selected filter. |
Returns true if file dialog factory is used by default, otherwise returns false
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:
-
parent | Parent widget. |
mode | File dialog mode. |
dir | Default directory. |
receiver | Receiver QObject. |
member | Receiver slot. |
caption | Dialog title. |
filters | Filer 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(QStringList)), tr("Choose a directory"));
virtual void raise |
( |
const QString & |
dir, |
|
|
Mode |
mode, |
|
|
const QString & |
caption, |
|
|
const QStringList & |
mask |
|
) |
| [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:
-
dir | Default directory. |
mode | File dialog mode. |
caption | Dialog title. |
mask | Filer used by file dialog |
Selects current file dialog factory.
The documentation for this class was generated from the following file: