340 lines
14 KiB
C++
340 lines
14 KiB
C++
/****************************************************************************
|
|
**
|
|
** Copyright (C) 2016 The Qt Company Ltd.
|
|
** Contact: https://www.qt.io/licensing/
|
|
**
|
|
** This file is part of the QtWidgets module of the Qt Toolkit.
|
|
**
|
|
** $QT_BEGIN_LICENSE:LGPL$
|
|
** Commercial License Usage
|
|
** Licensees holding valid commercial Qt licenses may use this file in
|
|
** accordance with the commercial license agreement provided with the
|
|
** Software or, alternatively, in accordance with the terms contained in
|
|
** a written agreement between you and The Qt Company. For licensing terms
|
|
** and conditions see https://www.qt.io/terms-conditions. For further
|
|
** information use the contact form at https://www.qt.io/contact-us.
|
|
**
|
|
** GNU Lesser General Public License Usage
|
|
** Alternatively, this file may be used under the terms of the GNU Lesser
|
|
** General Public License version 3 as published by the Free Software
|
|
** Foundation and appearing in the file LICENSE.LGPL3 included in the
|
|
** packaging of this file. Please review the following information to
|
|
** ensure the GNU Lesser General Public License version 3 requirements
|
|
** will be met: https://www.gnu.org/licenses/lgpl-3.0.html.
|
|
**
|
|
** GNU General Public License Usage
|
|
** Alternatively, this file may be used under the terms of the GNU
|
|
** General Public License version 2.0 or (at your option) the GNU General
|
|
** Public license version 3 or any later version approved by the KDE Free
|
|
** Qt Foundation. The licenses are as published by the Free Software
|
|
** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3
|
|
** included in the packaging of this file. Please review the following
|
|
** information to ensure the GNU General Public License requirements will
|
|
** be met: https://www.gnu.org/licenses/gpl-2.0.html and
|
|
** https://www.gnu.org/licenses/gpl-3.0.html.
|
|
**
|
|
** $QT_END_LICENSE$
|
|
**
|
|
****************************************************************************/
|
|
|
|
#ifndef QFILEDIALOG_H
|
|
#define QFILEDIALOG_H
|
|
|
|
#include <QtWidgets/qtwidgetsglobal.h>
|
|
#include <QtCore/qdir.h>
|
|
#include <QtCore/qstring.h>
|
|
#include <QtCore/qurl.h>
|
|
#include <QtWidgets/qdialog.h>
|
|
|
|
#include <functional>
|
|
|
|
QT_REQUIRE_CONFIG(filedialog);
|
|
|
|
QT_BEGIN_NAMESPACE
|
|
|
|
class QModelIndex;
|
|
class QItemSelection;
|
|
struct QFileDialogArgs;
|
|
class QFileIconProvider;
|
|
class QFileDialogPrivate;
|
|
class QAbstractItemDelegate;
|
|
class QAbstractProxyModel;
|
|
|
|
class Q_WIDGETS_EXPORT QFileDialog : public QDialog
|
|
{
|
|
Q_OBJECT
|
|
Q_PROPERTY(ViewMode viewMode READ viewMode WRITE setViewMode)
|
|
Q_PROPERTY(FileMode fileMode READ fileMode WRITE setFileMode)
|
|
Q_PROPERTY(AcceptMode acceptMode READ acceptMode WRITE setAcceptMode)
|
|
Q_PROPERTY(QString defaultSuffix READ defaultSuffix WRITE setDefaultSuffix)
|
|
#if QT_DEPRECATED_SINCE(5, 13)
|
|
Q_PROPERTY(bool readOnly READ isReadOnly WRITE setReadOnly DESIGNABLE false)
|
|
Q_PROPERTY(bool confirmOverwrite READ confirmOverwrite WRITE setConfirmOverwrite DESIGNABLE false)
|
|
Q_PROPERTY(bool resolveSymlinks READ resolveSymlinks WRITE setResolveSymlinks DESIGNABLE false)
|
|
Q_PROPERTY(bool nameFilterDetailsVisible READ isNameFilterDetailsVisible
|
|
WRITE setNameFilterDetailsVisible DESIGNABLE false)
|
|
#endif
|
|
Q_PROPERTY(Options options READ options WRITE setOptions)
|
|
Q_PROPERTY(QStringList supportedSchemes READ supportedSchemes WRITE setSupportedSchemes)
|
|
|
|
public:
|
|
enum ViewMode { Detail, List };
|
|
Q_ENUM(ViewMode)
|
|
enum FileMode { AnyFile, ExistingFile, Directory, ExistingFiles,
|
|
DirectoryOnly Q_DECL_ENUMERATOR_DEPRECATED_X("Use setOption(ShowDirsOnly, true) instead")};
|
|
Q_ENUM(FileMode)
|
|
enum AcceptMode { AcceptOpen, AcceptSave };
|
|
Q_ENUM(AcceptMode)
|
|
enum DialogLabel { LookIn, FileName, FileType, Accept, Reject };
|
|
|
|
enum Option
|
|
{
|
|
ShowDirsOnly = 0x00000001,
|
|
DontResolveSymlinks = 0x00000002,
|
|
DontConfirmOverwrite = 0x00000004,
|
|
#if QT_DEPRECATED_SINCE(5, 14)
|
|
DontUseSheet Q_DECL_ENUMERATOR_DEPRECATED = 0x00000008,
|
|
#endif
|
|
DontUseNativeDialog = 0x00000010,
|
|
ReadOnly = 0x00000020,
|
|
HideNameFilterDetails = 0x00000040,
|
|
DontUseCustomDirectoryIcons = 0x00000080
|
|
};
|
|
Q_ENUM(Option)
|
|
Q_DECLARE_FLAGS(Options, Option)
|
|
Q_FLAG(Options)
|
|
|
|
QFileDialog(QWidget *parent, Qt::WindowFlags f);
|
|
explicit QFileDialog(QWidget *parent = nullptr,
|
|
const QString &caption = QString(),
|
|
const QString &directory = QString(),
|
|
const QString &filter = QString());
|
|
~QFileDialog();
|
|
|
|
void setDirectory(const QString &directory);
|
|
inline void setDirectory(const QDir &directory);
|
|
QDir directory() const;
|
|
|
|
void setDirectoryUrl(const QUrl &directory);
|
|
QUrl directoryUrl() const;
|
|
|
|
void selectFile(const QString &filename);
|
|
QStringList selectedFiles() const;
|
|
|
|
void selectUrl(const QUrl &url);
|
|
QList<QUrl> selectedUrls() const;
|
|
|
|
#if QT_DEPRECATED_SINCE(5, 13)
|
|
QT_DEPRECATED_X("Use setOption(HideNameFilterDetails, !enabled) instead")
|
|
void setNameFilterDetailsVisible(bool enabled);
|
|
QT_DEPRECATED_X("Use !testOption(HideNameFilterDetails) instead")
|
|
bool isNameFilterDetailsVisible() const;
|
|
#endif
|
|
|
|
void setNameFilter(const QString &filter);
|
|
void setNameFilters(const QStringList &filters);
|
|
QStringList nameFilters() const;
|
|
void selectNameFilter(const QString &filter);
|
|
QString selectedMimeTypeFilter() const;
|
|
QString selectedNameFilter() const;
|
|
|
|
#if QT_CONFIG(mimetype)
|
|
void setMimeTypeFilters(const QStringList &filters);
|
|
QStringList mimeTypeFilters() const;
|
|
void selectMimeTypeFilter(const QString &filter);
|
|
#endif
|
|
|
|
QDir::Filters filter() const;
|
|
void setFilter(QDir::Filters filters);
|
|
|
|
void setViewMode(ViewMode mode);
|
|
ViewMode viewMode() const;
|
|
|
|
void setFileMode(FileMode mode);
|
|
FileMode fileMode() const;
|
|
|
|
void setAcceptMode(AcceptMode mode);
|
|
AcceptMode acceptMode() const;
|
|
|
|
#if QT_DEPRECATED_SINCE(5, 13)
|
|
void setReadOnly(bool enabled);
|
|
bool isReadOnly() const;
|
|
|
|
QT_DEPRECATED_X("Use setOption(DontResolveSymlinks, !enabled) instead")
|
|
void setResolveSymlinks(bool enabled);
|
|
QT_DEPRECATED_X("Use !testOption(DontResolveSymlinks) instead")
|
|
bool resolveSymlinks() const;
|
|
#endif
|
|
|
|
void setSidebarUrls(const QList<QUrl> &urls);
|
|
QList<QUrl> sidebarUrls() const;
|
|
|
|
QByteArray saveState() const;
|
|
bool restoreState(const QByteArray &state);
|
|
|
|
#if QT_DEPRECATED_SINCE(5, 13)
|
|
QT_DEPRECATED_X("Use setOption(DontConfirmOverwrite, !enabled) instead")
|
|
void setConfirmOverwrite(bool enabled);
|
|
QT_DEPRECATED_X("Use !testOption(DontConfirmOverwrite) instead")
|
|
bool confirmOverwrite() const;
|
|
#endif
|
|
|
|
void setDefaultSuffix(const QString &suffix);
|
|
QString defaultSuffix() const;
|
|
|
|
void setHistory(const QStringList &paths);
|
|
QStringList history() const;
|
|
|
|
void setItemDelegate(QAbstractItemDelegate *delegate);
|
|
QAbstractItemDelegate *itemDelegate() const;
|
|
|
|
void setIconProvider(QFileIconProvider *provider);
|
|
QFileIconProvider *iconProvider() const;
|
|
|
|
void setLabelText(DialogLabel label, const QString &text);
|
|
QString labelText(DialogLabel label) const;
|
|
|
|
void setSupportedSchemes(const QStringList &schemes);
|
|
QStringList supportedSchemes() const;
|
|
|
|
#if QT_CONFIG(proxymodel)
|
|
void setProxyModel(QAbstractProxyModel *model);
|
|
QAbstractProxyModel *proxyModel() const;
|
|
#endif
|
|
|
|
void setOption(Option option, bool on = true);
|
|
bool testOption(Option option) const;
|
|
void setOptions(Options options);
|
|
Options options() const;
|
|
|
|
using QDialog::open;
|
|
void open(QObject *receiver, const char *member);
|
|
void setVisible(bool visible) override;
|
|
|
|
Q_SIGNALS:
|
|
void fileSelected(const QString &file);
|
|
void filesSelected(const QStringList &files);
|
|
void currentChanged(const QString &path);
|
|
void directoryEntered(const QString &directory);
|
|
|
|
void urlSelected(const QUrl &url);
|
|
void urlsSelected(const QList<QUrl> &urls);
|
|
void currentUrlChanged(const QUrl &url);
|
|
void directoryUrlEntered(const QUrl &directory);
|
|
|
|
void filterSelected(const QString &filter);
|
|
|
|
public:
|
|
|
|
static QString getOpenFileName(QWidget *parent = nullptr,
|
|
const QString &caption = QString(),
|
|
const QString &dir = QString(),
|
|
const QString &filter = QString(),
|
|
QString *selectedFilter = nullptr,
|
|
Options options = Options());
|
|
|
|
static QUrl getOpenFileUrl(QWidget *parent = nullptr,
|
|
const QString &caption = QString(),
|
|
const QUrl &dir = QUrl(),
|
|
const QString &filter = QString(),
|
|
QString *selectedFilter = nullptr,
|
|
Options options = Options(),
|
|
const QStringList &supportedSchemes = QStringList());
|
|
|
|
static QString getSaveFileName(QWidget *parent = nullptr,
|
|
const QString &caption = QString(),
|
|
const QString &dir = QString(),
|
|
const QString &filter = QString(),
|
|
QString *selectedFilter = nullptr,
|
|
Options options = Options());
|
|
|
|
static QUrl getSaveFileUrl(QWidget *parent = nullptr,
|
|
const QString &caption = QString(),
|
|
const QUrl &dir = QUrl(),
|
|
const QString &filter = QString(),
|
|
QString *selectedFilter = nullptr,
|
|
Options options = Options(),
|
|
const QStringList &supportedSchemes = QStringList());
|
|
|
|
static QString getExistingDirectory(QWidget *parent = nullptr,
|
|
const QString &caption = QString(),
|
|
const QString &dir = QString(),
|
|
Options options = ShowDirsOnly);
|
|
|
|
static QUrl getExistingDirectoryUrl(QWidget *parent = nullptr,
|
|
const QString &caption = QString(),
|
|
const QUrl &dir = QUrl(),
|
|
Options options = ShowDirsOnly,
|
|
const QStringList &supportedSchemes = QStringList());
|
|
|
|
static QStringList getOpenFileNames(QWidget *parent = nullptr,
|
|
const QString &caption = QString(),
|
|
const QString &dir = QString(),
|
|
const QString &filter = QString(),
|
|
QString *selectedFilter = nullptr,
|
|
Options options = Options());
|
|
|
|
static QList<QUrl> getOpenFileUrls(QWidget *parent = nullptr,
|
|
const QString &caption = QString(),
|
|
const QUrl &dir = QUrl(),
|
|
const QString &filter = QString(),
|
|
QString *selectedFilter = nullptr,
|
|
Options options = Options(),
|
|
const QStringList &supportedSchemes = QStringList());
|
|
|
|
static void getOpenFileContent(const QString &nameFilter,
|
|
const std::function<void(const QString &, const QByteArray &)> &fileContentsReady);
|
|
static void saveFileContent(const QByteArray &fileContent, const QString &fileNameHint = QString());
|
|
|
|
protected:
|
|
QFileDialog(const QFileDialogArgs &args);
|
|
void done(int result) override;
|
|
void accept() override;
|
|
void changeEvent(QEvent *e) override;
|
|
|
|
private:
|
|
Q_DECLARE_PRIVATE(QFileDialog)
|
|
Q_DISABLE_COPY(QFileDialog)
|
|
|
|
Q_PRIVATE_SLOT(d_func(), void _q_pathChanged(const QString &))
|
|
|
|
Q_PRIVATE_SLOT(d_func(), void _q_navigateBackward())
|
|
Q_PRIVATE_SLOT(d_func(), void _q_navigateForward())
|
|
Q_PRIVATE_SLOT(d_func(), void _q_navigateToParent())
|
|
Q_PRIVATE_SLOT(d_func(), void _q_createDirectory())
|
|
Q_PRIVATE_SLOT(d_func(), void _q_showListView())
|
|
Q_PRIVATE_SLOT(d_func(), void _q_showDetailsView())
|
|
Q_PRIVATE_SLOT(d_func(), void _q_showContextMenu(const QPoint &))
|
|
Q_PRIVATE_SLOT(d_func(), void _q_renameCurrent())
|
|
Q_PRIVATE_SLOT(d_func(), void _q_deleteCurrent())
|
|
Q_PRIVATE_SLOT(d_func(), void _q_showHidden())
|
|
Q_PRIVATE_SLOT(d_func(), void _q_updateOkButton())
|
|
Q_PRIVATE_SLOT(d_func(), void _q_currentChanged(const QModelIndex &index))
|
|
Q_PRIVATE_SLOT(d_func(), void _q_enterDirectory(const QModelIndex &index))
|
|
Q_PRIVATE_SLOT(d_func(), void _q_emitUrlSelected(const QUrl &))
|
|
Q_PRIVATE_SLOT(d_func(), void _q_emitUrlsSelected(const QList<QUrl> &))
|
|
Q_PRIVATE_SLOT(d_func(), void _q_nativeCurrentChanged(const QUrl &))
|
|
Q_PRIVATE_SLOT(d_func(), void _q_nativeEnterDirectory(const QUrl&))
|
|
Q_PRIVATE_SLOT(d_func(), void _q_goToDirectory(const QString &path))
|
|
Q_PRIVATE_SLOT(d_func(), void _q_useNameFilter(int index))
|
|
Q_PRIVATE_SLOT(d_func(), void _q_selectionChanged())
|
|
Q_PRIVATE_SLOT(d_func(), void _q_goToUrl(const QUrl &url))
|
|
Q_PRIVATE_SLOT(d_func(), void _q_goHome())
|
|
Q_PRIVATE_SLOT(d_func(), void _q_showHeader(QAction *))
|
|
Q_PRIVATE_SLOT(d_func(), void _q_autoCompleteFileName(const QString &text))
|
|
Q_PRIVATE_SLOT(d_func(), void _q_rowsInserted(const QModelIndex & parent))
|
|
Q_PRIVATE_SLOT(d_func(), void _q_fileRenamed(const QString &path,
|
|
const QString &oldName,
|
|
const QString &newName))
|
|
friend class QPlatformDialogHelper;
|
|
};
|
|
|
|
inline void QFileDialog::setDirectory(const QDir &adirectory)
|
|
{ setDirectory(adirectory.absolutePath()); }
|
|
|
|
Q_DECLARE_OPERATORS_FOR_FLAGS(QFileDialog::Options)
|
|
|
|
QT_END_NAMESPACE
|
|
|
|
#endif // QFILEDIALOG_H
|