Kwave::FileDialog Class Reference

#include <FileDialog.h>

Inheritance diagram for Kwave::FileDialog:

Collaboration diagram for Kwave::FileDialog:

Public Types
enum	OperationMode { SaveFile = 0, OpenFile, SelectDir }

Signals
void	filterChanged (const QString &filter)

Public Member Functions
	FileDialog (const QString &startDir, OperationMode mode, const QString &filter, QWidget *parent, const QUrl last_url=QUrl(), const QString last_ext=QString())
virtual	~FileDialog () Q_DECL_OVERRIDE
QString	selectedExtension ()
QUrl	selectedUrl () const
QUrl	baseUrl () const
void	setDirectory (const QString &directory)
void	selectUrl (const QUrl &url)
void	setCustomWidget (QWidget *widget)
KUrlComboBox *	locationEdit () const

Protected Slots
virtual void	accept () Q_DECL_OVERRIDE
void	saveConfig ()

Protected Member Functions
void	loadConfig (const QString &section)

Private Member Functions
QString	guessFilterFromFileExt (const QString &pattern, OperationMode mode)

Private Attributes
QVBoxLayout	m_layout
KFileWidget	m_file_widget
QString	m_config_group
QUrl	m_last_url
QString	m_last_ext

Detailed Description

An improved version of KFileWidget that does not forget the previous directory and pre-selects the previous file extension.

Definition at line 41 of file FileDialog.h.

Member Enumeration Documentation

OperationMode

enum Kwave::FileDialog::OperationMode

Enumerator
SaveFile	save a file
OpenFile	open a file
SelectDir	select a directory

Definition at line 45 of file FileDialog.h.

                     {
            SaveFile = 0, 
            OpenFile,     
            SelectDir     
        } OperationMode;

Constructor & Destructor Documentation

FileDialog()

Kwave::FileDialog::FileDialog	(	const QString &	startDir,
		OperationMode	mode,
		const QString &	filter,
		QWidget *	parent,
		const QUrl	last_url = QUrl(),
		const QString	last_ext = QString()
	)

Constructor.

See also

KFileWidget

Parameters

startDir	directory to start with, can start with the scheme "kfiledialog://scope/path"
mode	determines the mode in which the dialog is used, either to open a file, save a file or select a directory
filter	a "\n" separated list of file filters, each filter consists of a space separated list of file patterns (including "*.") and a "|" as separator followed by a verbose description of the file type
parent	the parent widget of the dialog
last_url	URL used for the last call, optional
last_ext	file extension (pattern) used for the last call (optional), including a "*."

Definition at line 41 of file FileDialog.cpp.

References _, accept(), Kwave::connect(), DBG, filterChanged(), guessFilterFromFileExt(), loadConfig(), m_file_widget, m_last_ext, m_last_url, m_layout, OpenFile, SaveFile, and SelectDir.

    :QDialog(parent),
     m_layout(this),
     m_file_widget(QUrl::fromUserInput(startDir), this),
     m_config_group(),
     m_last_url(last_url),
     m_last_ext(last_ext)
{
    const bool saving = (mode == SaveFile);

    // do some layout and init stuff
    m_layout.addWidget(&m_file_widget);
    setMinimumSize(m_file_widget.dialogSizeHint());
    setModal(true);
    connect(&m_file_widget, SIGNAL(filterChanged(QString)),
            this, SIGNAL(filterChanged(QString)));

    // connect the Cancel button
    QPushButton *button;
    button = m_file_widget.cancelButton();
    connect(button, SIGNAL(clicked()), this, SLOT(reject()));
    button->show();

    // connect the Open/Save button
    button = m_file_widget.okButton();
    connect(&m_file_widget, SIGNAL(accepted()), this, SLOT(accept()));
    connect(button, SIGNAL(clicked(bool)), &m_file_widget, SLOT(slotOk()));
    button->show();

    switch (mode) {
        case SaveFile:
            m_file_widget.setOperationMode(KFileWidget::Saving);
            m_file_widget.setMode(KFile::File);
            m_file_widget.setConfirmOverwrite(false);
            break;
        case OpenFile:
            m_file_widget.setOperationMode(KFileWidget::Opening);
            m_file_widget.setMode(KFile::File |
                                  KFile::ExistingOnly);
            break;
        case SelectDir:
            m_file_widget.setOperationMode(KFileWidget::Opening);
            m_file_widget.setMode(KFile::Directory |
                                  KFile::ExistingOnly);
            break;
    }

    QString special_prefix = _("kfiledialog:///");
    if (startDir.startsWith(special_prefix)) {
        // configuration key given
        m_file_widget.setKeepLocation(true);

        // load initial settings
        QString section = startDir;
        section = section.remove(0, special_prefix.length());
        if (section.contains(_("/")))
            section = section.left(section.indexOf(_("/")));
        section.prepend(_("KwaveFileDialog-"));
        loadConfig(section);
    }

    // if a file extension was passed but no filter, try to guess
    // the mime type
    QString file_filter = filter;
    if (!file_filter.length() && m_last_ext.length()) {
        file_filter = guessFilterFromFileExt(m_last_ext, mode);
        qDebug("guessed filter for '%s': '%s",
               DBG(m_last_ext), DBG(file_filter));
    }

    // if a filename or directory URL was passed, try to re-use it
    if (!m_last_url.isEmpty() && (m_last_url.isLocalFile() || saving)) {
        QFileInfo file(m_last_url.toLocalFile());
        if (QFileInfo(file.path()).exists() || saving)
            m_file_widget.setUrl(m_last_url.adjusted(QUrl::RemoveFilename));
        if (!file.isDir() && (file.exists() || saving))
            m_file_widget.setSelectedUrl(
                QUrl::fromLocalFile(m_last_url.fileName()));
    }

    // parse the list of file filters and put the last extension on top
    if (file_filter.length()) {
        QStringList filter_list = file_filter.split(_("\n"));
        QStringList name_filters;
        QString best_filter;
        QString best_pattern;
        foreach (const QString &filter_item, filter_list) {
            QString f(filter_item);
            QString p(_("*"));
            if (f.contains(_("|"))) {
                int i = f.indexOf(_("|"));
                p = f.left(i);
                f = f.mid(i + 1);
            }
            if (!f.length()) continue;

            // put the last extension to the top of the list
            // and thus make it selected
            if (m_last_ext.length()) {
                QStringList extensions = p.split(_(" "));
                if (extensions.contains(m_last_ext)) {
                    if (!best_filter.length() ||
                        (p.length() <= best_pattern.length())) {
                        best_filter  = filter_item;
                        best_pattern = p;
                    }
                }
            }

            name_filters.append(filter_item);
        }
        if (best_filter.length()) {
            name_filters.removeAll(best_filter);
            name_filters.prepend(best_filter);
        }

        m_file_widget.setFilter(name_filters.join(QChar::fromLatin1('\n')));
    }
}

Here is the call graph for this function:

~FileDialog()

virtual Kwave::FileDialog::~FileDialog ( )

inlinevirtual

Destructor

Definition at line 75 of file FileDialog.h.

        {
        }

Member Function Documentation

accept

void Kwave::FileDialog::accept ( )

protectedvirtualslot

overwritten to call accept() of the KFileWidget and saveConfig()

Definition at line 277 of file FileDialog.cpp.

References m_file_widget, and saveConfig().

Referenced by FileDialog().

{
    m_file_widget.accept();

    // save the configuration when the dialog was accepted
    saveConfig();

    QDialog::accept();
}

Here is the call graph for this function:

Here is the caller graph for this function:

baseUrl()

QUrl Kwave::FileDialog::baseUrl

(

)

const

Returns the URL of the currently visible directory

Definition at line 259 of file FileDialog.cpp.

References m_file_widget.

Referenced by Kwave::SaveBlocksDialog::emitUpdate().

{
    return m_file_widget.baseUrl();
}

Here is the caller graph for this function:

filterChanged

void Kwave::FileDialog::filterChanged ( const QString &  filter )

signal

Referenced by FileDialog(), and Kwave::SaveBlocksDialog::SaveBlocksDialog().

Here is the caller graph for this function:

guessFilterFromFileExt()

QString Kwave::FileDialog::guessFilterFromFileExt ( const QString &  pattern, OperationMode  mode  )

private

Try to guess a file filter from a given file extension

Parameters

pattern	a file extension, e.g. "*.wav *.snd"
mode	determines the mode in which the dialog is used, see constructor

Returns

a filter string suitable for a KFileDialog

Definition at line 288 of file FileDialog.cpp.

References _, Kwave::CodecManager::decodingFilter(), Kwave::CodecManager::encodingFilter(), and SaveFile.

Referenced by FileDialog().

{
    // if there are multiple extensions in a list, iterate over them
    if (pattern.contains(_(" "))) {
        QStringList patterns = pattern.split(_(" "));
        foreach (const QString &p, patterns) {
            QString f = guessFilterFromFileExt(p, mode);
            if (f.length()) return f;
        }
    }

    // get the filter list of our own codecs, this prefers the Kwave internal
    // mime types against the ones from KDE
    QString filters = (mode == SaveFile) ?
        Kwave::CodecManager::encodingFilter() :
        Kwave::CodecManager::decodingFilter();
    foreach (const QString &filter, filters.split(_(" "))) {
        QString p = filter;
        if (p.contains(_("|"))) {
            int i = p.indexOf(_("|"));
            p = p.left(i);
        }
        foreach (const QString &mask, p.split(_(" "))) {
            if (mask == pattern) {
//              qDebug("MATCH from CodecManager: '%s' matches '%s' -> '%s'",
//                     DBG(mask), DBG(pattern), DBG(filter));
                return filter;
            }
        }
    }

    // try to find out by asking the Qt mime database
    QMimeDatabase db;
    QList<QMimeType> mime_types = db.mimeTypesForFileName(pattern);
    if (!mime_types.isEmpty()) {
        foreach (const QMimeType &m, mime_types) {
            if (m.isValid() && !m.isDefault()) {
                QString filter_string =
                    m.globPatterns().join(_(" ")) + _("|") +
                    m.filterString();
//              qDebug("MATCH from QMimeDatabase: '%s' -> '%s'",
//                     DBG(pattern), DBG(filter_string));
                return filter_string;
            }
        }
    }

    return QString();
}

Here is the call graph for this function:

Here is the caller graph for this function:

loadConfig()

void Kwave::FileDialog::loadConfig ( const QString &  section )

protected

load previous settings

Definition at line 169 of file FileDialog.cpp.

References m_config_group, m_last_ext, and m_last_url.

Referenced by FileDialog().

{
    if (!section.length()) return;
    KConfigGroup cfg = KSharedConfig::openConfig()->group(section);
    m_config_group = section;
    if (!m_last_url.isEmpty()) {
        QUrl last_path = cfg.readEntry("last_url", m_last_url);
        if (!last_path.isEmpty()) {
            // take last path, but user defined file name
            QString file_name = m_last_url.fileName();
            last_path = last_path.adjusted(QUrl::RemoveFilename);
            m_last_url = QUrl::fromUserInput(last_path.path() + file_name);
        }
    } else {
        m_last_url = QUrl::fromUserInput(cfg.readEntry("last_url",
            m_last_url.toDisplayString()));
    }
    if (!m_last_ext.length())
        m_last_ext = cfg.readEntry("last_ext", m_last_ext);

    // get last dialog size (Kwave global config)
    cfg = KSharedConfig::openConfig()->group("FileDialog");
    int w = cfg.readEntry("dialog_width",  sizeHint().width());
    int h = cfg.readEntry("dialog_height", sizeHint().height());
    if (w < minimumWidth())  w = sizeHint().width();
    if (h < minimumHeight()) w = sizeHint().height();
    resize(w, h);
}

Here is the caller graph for this function:

locationEdit()

KUrlComboBox * Kwave::FileDialog::locationEdit

(

)

const

Returns the combobox used to type the filename or full location of the file.

See also

KFileWidget

Definition at line 346 of file FileDialog.cpp.

References m_file_widget.

Referenced by Kwave::SaveBlocksDialog::emitUpdate(), and Kwave::SaveBlocksDialog::SaveBlocksDialog().

{
    return m_file_widget.locationEdit();
}

Here is the caller graph for this function:

saveConfig

void Kwave::FileDialog::saveConfig ( )

protectedslot

save current settings

Definition at line 199 of file FileDialog.cpp.

References _, m_config_group, m_file_widget, m_last_ext, m_last_url, and selectedUrl().

Referenced by accept().

{
    if (!m_config_group.length()) return;
    if (selectedUrl().isEmpty()) return;

    QString file_name = selectedUrl().fileName();
    if (!file_name.length()) return; // aborted

    // store the last URL
    m_last_url = m_file_widget.baseUrl();

    // store the last extension if present
    QFileInfo file(file_name);
    QString extension = file.suffix();
    if (extension.length()) {
        // simple case: file extension
        m_last_ext = _("*.") + extension;
    } else {
        // tricky case: filename mask
        QString pattern = m_file_widget.currentFilter();
        if (pattern.contains(_("|"))) {
            int i = pattern.indexOf(_("|"));
            pattern = pattern.left(i);
        }
        m_last_ext = _("");
        foreach (const QString &mask, pattern.split(_(" "))) {
            QRegExp regex(mask, Qt::CaseSensitive, QRegExp::Wildcard);
            if (regex.indexIn(file_name) >= 0) {
                m_last_ext = mask;
                break;
            }
        }
    }

    KConfigGroup cfg = KSharedConfig::openConfig()->group(m_config_group);
    cfg.writeEntry("last_url",      m_last_url);
    cfg.writeEntry("last_ext",      m_last_ext);
    cfg.sync();

    // save the geometry of the dialog (Kwave global config)
    cfg = KSharedConfig::openConfig()->group("FileDialog");
    cfg.writeEntry("dialog_width",  width());
    cfg.writeEntry("dialog_height", height());
    cfg.sync();
}

Here is the call graph for this function:

Here is the caller graph for this function:

selectedExtension()

QString Kwave::FileDialog::selectedExtension

(

)

Returns the previously used extension, including "*."

Definition at line 246 of file FileDialog.cpp.

References _, and m_file_widget.

Referenced by Kwave::SaveBlocksDialog::emitUpdate().

{
    QStringList ext_list = m_file_widget.currentFilter().split(_(" "));
    return *(ext_list.begin());
}

Here is the caller graph for this function:

selectedUrl()

QUrl Kwave::FileDialog::selectedUrl

(

)

const

Returns the first selected URL (if any)

Definition at line 253 of file FileDialog.cpp.

References m_file_widget.

Referenced by Kwave::MainWidget::loadLabels(), Kwave::TopWidget::openFile(), Kwave::SonagramWindow::save(), saveConfig(), Kwave::FileContext::saveFileAs(), Kwave::MainWidget::saveLabels(), and Kwave::MemoryDialog::searchSwapDir().

{
    return m_file_widget.selectedUrl();
}

Here is the caller graph for this function:

selectUrl()

void Kwave::FileDialog::selectUrl

(

const QUrl &

url

)

Sets the currently selected URL

Parameters

url	the new URL to show

Definition at line 271 of file FileDialog.cpp.

References m_file_widget.

Referenced by Kwave::PlayBackDialog::selectPlaybackDevice(), and Kwave::RecordDialog::selectRecordDevice().

{
    m_file_widget.setUrl(url);
}

Here is the caller graph for this function:

setCustomWidget()

void Kwave::FileDialog::setCustomWidget

(

QWidget *

widget

)

Add a custom widget to the dialog

See also

KFileWidget

Definition at line 340 of file FileDialog.cpp.

References m_file_widget.

Referenced by Kwave::K3BExportDialog::K3BExportDialog(), and Kwave::SaveBlocksDialog::SaveBlocksDialog().

{
    m_file_widget.setCustomWidget(widget);
}

Here is the caller graph for this function:

setDirectory()

void Kwave::FileDialog::setDirectory

(

const QString &

directory

)

Sets the current directory

Parameters

directory

the new directory to show

Definition at line 265 of file FileDialog.cpp.

References m_file_widget.

Referenced by Kwave::MP3EncoderDialog::browseFile().

{
    m_file_widget.setStartDir(QUrl::fromUserInput(directory));
}

Here is the caller graph for this function:

Member Data Documentation

m_config_group

QString Kwave::FileDialog::m_config_group

private

name of the group in the config file

Definition at line 157 of file FileDialog.h.

Referenced by loadConfig(), and saveConfig().

m_file_widget

KFileWidget Kwave::FileDialog::m_file_widget

private

the KFileWidget that we wrap

Definition at line 154 of file FileDialog.h.

Referenced by accept(), baseUrl(), FileDialog(), locationEdit(), saveConfig(), selectedExtension(), selectedUrl(), selectUrl(), setCustomWidget(), and setDirectory().

m_last_ext

QString Kwave::FileDialog::m_last_ext

private

extension of the last selected single URL or file

Definition at line 163 of file FileDialog.h.

Referenced by FileDialog(), loadConfig(), and saveConfig().

m_last_url

QUrl Kwave::FileDialog::m_last_url

private

URL of the previously opened file or directory

Definition at line 160 of file FileDialog.h.

Referenced by FileDialog(), loadConfig(), and saveConfig().

m_layout

QVBoxLayout Kwave::FileDialog::m_layout

private

layout for holding the KFileWidget

Definition at line 151 of file FileDialog.h.

Referenced by FileDialog().

---

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

• libgui/FileDialog.h
• libgui/FileDialog.cpp