FileDialog Class Reference

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, SaveFile
}

Signals

void filesAdded (const QStringList &)

Static Public Member Functions

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())
static QList< FileDialogFactory * > registeredFactories ()
static bool isModal ()
static void setEnabled (FileDialogFactory *factory)
static bool isEnabled (FileDialogFactory *factory)

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 bool modal () const
virtual ~FileDialog ()
virtual void raise (const QString &dir=QString(), Mode mode=AddFiles, const QString &caption=QString(), const QStringList &mask=QStringList())

Static Protected Member Functions

static FileDialoginstance ()
static FileDialogdefaultInstance ()
static bool registerFactory (FileDialogFactory *factory)


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 (  )  [inline, protected, virtual]

Object destructor


Member Function Documentation

static FileDialog* defaultInstance (  )  [static, protected]

Returns a pointer to the default file dialog instance.

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:
parent Parent widget.
caption Dialog title.
dir Default directory.

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:
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.

static FileDialog* instance (  )  [static, protected]

Returns a pointer to the selected file dialog instance.

static bool isEnabled ( FileDialogFactory factory  )  [static]

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

static bool isModal (  )  [static]

Returns true if selected file dialog doesn't support nonmodal mode, otherwise returns false

virtual bool modal (  )  const [inline, protected, virtual]

Returns true if file dialog doesn't support nonmodal mode, otherwise returns false Subclass should reimplement this function.

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:
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

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:
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 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(const QStringList&)), tr("Choose a directory"));

virtual void raise ( const QString &  dir = QString(),
Mode  mode = AddFiles,
const QString &  caption = QString(),
const QStringList &  mask = QStringList() 
) [inline, 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

static QList<FileDialogFactory*> registeredFactories (  )  [static]

Returns a list of registered file dialog factories.

static bool registerFactory ( FileDialogFactory factory  )  [static, protected]

Registers file dialog factory Returns false if factory is already registered, otherwise returns true

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:
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 void setEnabled ( FileDialogFactory factory  )  [static]

Selects current file dialog factory.


The documentation for this class was generated from the following file:

Generated on Thu Nov 10 20:39:11 2011 for Qmmp by  doxygen 1.5.9