Qmmp
Public Types | Signals | Static Public Member Functions | Protected Member Functions | List of all members
FileDialog Class Referenceabstract

#include <filedialog.h>

Inherits QObject.

Inherited by QtFileDialog.

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 (const FileDialogFactory *factory)
 
static bool isEnabled (const FileDialogFactory *factory)
 
static QString file (const FileDialogFactory *factory)
 
static QString getExistingDirectory (QWidget *parent=nullptr, const QString &caption=QString(), const QString &dir=QString())
 
static QString getOpenFileName (QWidget *parent=nullptr, const QString &caption=QString(), const QString &dir=QString(), const QString &filter=QString(), QString *selectedFilter=nullptr)
 
static QStringList getOpenFileNames (QWidget *parent=nullptr, const QString &caption=QString(), const QString &dir=QString(), const QString &filter=QString(), QString *selectedFilter=nullptr)
 
static QString getSaveFileName (QWidget *parent=nullptr, const QString &caption=QString(), const QString &dir=QString(), const QString &filter=QString(), QString *selectedFilter=nullptr)
 
static void popup (QWidget *parent=nullptr, Mode mode=AddFiles, QString *dir=nullptr, QObject *receiver=nullptr, const char *member=nullptr, 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=nullptr)=0
 

Detailed Description

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

Author
Vladimir Kuznetsov vovan.nosp@m.ec@g.nosp@m.mail..nosp@m.com

Member Enumeration Documentation

◆ Mode

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

PlayDirsFiles 

Get existing files and directories with play button (if supported)

SaveFile 

Get existing or non-existing file

Constructor & Destructor Documentation

◆ FileDialog()

FileDialog ( )
protected

Object constructor.

◆ ~FileDialog()

virtual ~FileDialog ( )
protectedvirtual

Object destructor

Member Function Documentation

◆ exec()

virtual QStringList exec ( QWidget *  parent,
const QString &  dir,
Mode  mode,
const QString &  caption,
const QString &  filter = QString(),
QString *  selectedFilter = nullptr 
)
protectedpure 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
parentParent widget.
dirDefault directory.
modeFile dialog mode.
captionDialog title.
filterFiler used by file dialog (example: "Audio (*.mp3 *.ogg);;Text files (*.txt);;XML files (*.xml)").
selectedFilterDefault selected filter.

◆ factories()

static QList<FileDialogFactory*> factories ( )
static

Returns a list of registered file dialog factories.

◆ file()

static QString file ( const FileDialogFactory factory)
static

Returns plugin file path.

Parameters
factoryFile dialog plugin factory.

◆ filesSelected

void filesSelected ( const QStringList &  selected,
bool  play = false 
)
signal

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

◆ getExistingDirectory()

static QString getExistingDirectory ( QWidget *  parent = nullptr,
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.

◆ getOpenFileName()

static QString getOpenFileName ( QWidget *  parent = nullptr,
const QString &  caption = QString(),
const QString &  dir = QString(),
const QString &  filter = QString(),
QString *  selectedFilter = nullptr 
)
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

◆ getOpenFileNames()

static QStringList getOpenFileNames ( QWidget *  parent = nullptr,
const QString &  caption = QString(),
const QString &  dir = QString(),
const QString &  filter = QString(),
QString *  selectedFilter = nullptr 
)
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.

◆ getSaveFileName()

static QString getSaveFileName ( QWidget *  parent = nullptr,
const QString &  caption = QString(),
const QString &  dir = QString(),
const QString &  filter = QString(),
QString *  selectedFilter = nullptr 
)
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.

◆ isEnabled()

static bool isEnabled ( const FileDialogFactory factory)
static

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

◆ popup()

static void popup ( QWidget *  parent = nullptr,
Mode  mode = AddFiles,
QString *  dir = nullptr,
QObject *  receiver = nullptr,
const char *  member = nullptr,
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(QStringList)), tr("Choose a directory"));

◆ raise()

virtual void raise ( const QString &  dir,
Mode  mode,
const QString &  caption,
const QStringList &  mask 
)
protectedvirtual

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

◆ setEnabled()

static void setEnabled ( const FileDialogFactory factory)
static

Selects current file dialog factory.


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