/****************************************************************************

**

** Copyright (C) 2009 Nokia Corporation and/or its subsidiary(-ies).

** All rights reserved.

** Contact: Nokia Corporation (qt-info@nokia.com)

**

** This file is part of the QtGui module of the Qt Toolkit.

**

** $QT_BEGIN_LICENSE:LGPL$

** No Commercial Usage

** This file contains pre-release code and may not be distributed.

** You may use this file in accordance with the terms and conditions

** contained in the Technology Preview License Agreement accompanying

** this package.

**

** GNU Lesser General Public License Usage

** Alternatively, this file may be used under the terms of the GNU Lesser

** General Public License version 2.1 as published by the Free Software

** Foundation and appearing in the file LICENSE.LGPL included in the

** packaging of this file.  Please review the following information to

** ensure the GNU Lesser General Public License version 2.1 requirements

** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.

**

** In addition, as a special exception, Nokia gives you certain additional

** rights.  These rights are described in the Nokia Qt LGPL Exception

** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.

**

** If you have questions regarding the use of this file, please contact

** Nokia at qt-info@nokia.com.

**

**

**

**

**

**

**

**

** $QT_END_LICENSE$

**

****************************************************************************/

#ifndef QFILEDIALOG_H

#define QFILEDIALOG_H

#include <QtCore/qdir.h>

#include <QtCore/qstring.h>

#include <QtGui/qdialog.h>

QT_BEGIN_HEADER

QT_BEGIN_NAMESPACE

QT_MODULE(Gui)

#ifndef QT_NO_FILEDIALOG

class QModelIndex;

class QItemSelection;

struct QFileDialogArgs;

class QFileIconProvider;

class QFileDialogPrivate;

class QAbstractItemDelegate;

class QAbstractProxyModel;

class QUrl;

class Q_GUI_EXPORT QFileDialog : public QDialog

{

    Q_OBJECT

    Q_ENUMS(ViewMode FileMode AcceptMode Option)

    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(bool readOnly READ isReadOnly WRITE setReadOnly DESIGNABLE false)

    Q_PROPERTY(bool resolveSymlinks READ resolveSymlinks WRITE setResolveSymlinks DESIGNABLE false)

    Q_PROPERTY(bool confirmOverwrite READ confirmOverwrite WRITE setConfirmOverwrite DESIGNABLE false)

    Q_PROPERTY(QString defaultSuffix READ defaultSuffix WRITE setDefaultSuffix)

    Q_PROPERTY(bool nameFilterDetailsVisible READ isNameFilterDetailsVisible

               WRITE setNameFilterDetailsVisible DESIGNABLE false)

    Q_PROPERTY(Options options READ options WRITE setOptions)

public:

    enum ViewMode { Detail, List };

    enum FileMode { AnyFile, ExistingFile, Directory, ExistingFiles, DirectoryOnly };

    enum AcceptMode { AcceptOpen, AcceptSave };

    enum DialogLabel { LookIn, FileName, FileType, Accept, Reject };

    // ### Rename to FileDialogOption and FileDialogOptions for Qt 5.0

    enum Option

    {

        ShowDirsOnly          = 0x00000001,

        DontResolveSymlinks   = 0x00000002,

        DontConfirmOverwrite  = 0x00000004,

        DontUseSheet          = 0x00000008,

        DontUseNativeDialog   = 0x00000010,

        ReadOnly              = 0x00000020,

        HideNameFilterDetails = 0x00000040

    };

    Q_DECLARE_FLAGS(Options, Option)

    QFileDialog(QWidget *parent, Qt::WindowFlags f);

    explicit QFileDialog(QWidget *parent = 0,

                         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 selectFile(const QString &filename);

    QStringList selectedFiles() const;

#ifdef QT_DEPRECATED

    QT_DEPRECATED void setFilter(const QString &filter);

    QT_DEPRECATED void setFilters(const QStringList &filters);

    QT_DEPRECATED QStringList filters() const;

    QT_DEPRECATED void selectFilter(const QString &filter);

    QT_DEPRECATED QString selectedFilter() const;

#endif

    void setNameFilterDetailsVisible(bool enabled);

    bool isNameFilterDetailsVisible() const;

    void setNameFilter(const QString &filter);

    void setNameFilters(const QStringList &filters);

    QStringList nameFilters() const;

    void selectNameFilter(const QString &filter);

    QString selectedNameFilter() const;

    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;

    void setReadOnly(bool enabled);

    bool isReadOnly() const;

    void setResolveSymlinks(bool enabled);

    bool resolveSymlinks() const;

    void setSidebarUrls(const QList<QUrl> &urls);

    QList<QUrl> sidebarUrls() const;

    QByteArray saveState() const;

    bool restoreState(const QByteArray &state);

    void setConfirmOverwrite(bool enabled);

    bool confirmOverwrite() const;

    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;

#ifndef QT_NO_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;

#ifdef Q_NO_USING_KEYWORD

#ifndef Q_QDOC

    void open() { QDialog::open(); }

#endif

#else

    using QDialog::open;

#endif

    void open(QObject *receiver, const char *member);

    void setVisible(bool visible);

Q_SIGNALS:

    void fileSelected(const QString &file);

    void filesSelected(const QStringList &files);

    void currentChanged(const QString &path);

    void directoryEntered(const QString &directory);

    void filterSelected(const QString &filter);

public:

#ifdef QT3_SUPPORT

    typedef FileMode Mode;

    inline QT3_SUPPORT void setMode(FileMode m) { setFileMode(m); }

    inline QT3_SUPPORT FileMode mode() const { return fileMode(); }

    inline QT3_SUPPORT void setDir(const QString &directory) { setDirectory(directory); }

    inline QT3_SUPPORT void setDir( const QDir &directory ) { setDirectory(directory); }

    QT3_SUPPORT QString selectedFile() const;

#endif

    static QString getOpenFileName(QWidget *parent = 0,

                                   const QString &caption = QString(),

                                   const QString &dir = QString(),

                                   const QString &filter = QString(),

                                   QString *selectedFilter = 0,

                                   Options options = 0);

    static QString getSaveFileName(QWidget *parent = 0,

                                   const QString &caption = QString(),

                                   const QString &dir = QString(),

                                   const QString &filter = QString(),

                                   QString *selectedFilter = 0,

                                   Options options = 0);

    static QString getExistingDirectory(QWidget *parent = 0,

                                        const QString &caption = QString(),

                                        const QString &dir = QString(),

                                        Options options = ShowDirsOnly);

    static QStringList getOpenFileNames(QWidget *parent = 0,

                                        const QString &caption = QString(),

                                        const QString &dir = QString(),

                                        const QString &filter = QString(),

                                        QString *selectedFilter = 0,

                                        Options options = 0);

#ifdef QT3_SUPPORT

    inline static QString QT3_SUPPORT getOpenFileName(const QString &dir,

                                                    const QString &filter = QString(),

                                                    QWidget *parent = 0, const char* name = 0,

                                                    const QString &caption = QString(),

                                                    QString *selectedFilter = 0,

                                                    bool resolveSymlinks = true)

        { Q_UNUSED(name);

          return getOpenFileName(parent, caption, dir, filter, selectedFilter,

                                 resolveSymlinks ? Option(0) : DontResolveSymlinks); }

    inline static QString QT3_SUPPORT getSaveFileName(const QString &dir,

                                                    const QString &filter = QString(),

                                                    QWidget *parent = 0, const char* name = 0,

                                                    const QString &caption = QString(),

                                                    QString *selectedFilter = 0,

                                                    bool resolveSymlinks = true)

        { Q_UNUSED(name);

          return getSaveFileName(parent, caption, dir, filter, selectedFilter,

                                 resolveSymlinks ? Option(0) : DontResolveSymlinks); }

    inline static QString QT3_SUPPORT getExistingDirectory(const QString &dir,

                                                         QWidget *parent = 0,

                                                         const char* name = 0,

                                                         const QString &caption = QString(),

                                                         bool dirOnly = true,

                                                         bool resolveSymlinks = true)

        { Q_UNUSED(name);

          return getExistingDirectory(parent, caption, dir,

                                      Options((resolveSymlinks ? Option(0) : DontResolveSymlinks)

                                      | (dirOnly ? ShowDirsOnly : Option(0)))); }

    inline static QStringList QT3_SUPPORT getOpenFileNames(const QString &filter,

                                                         const QString &dir = QString(),

                                                         QWidget *parent = 0,

                                                         const char* name = 0,

                                                         const QString &caption = QString(),

                                                         QString *selectedFilter = 0,

                                                         bool resolveSymlinks = true)

        { Q_UNUSED(name);

          return getOpenFileNames(parent, caption, dir, filter, selectedFilter,

                                  resolveSymlinks ? Option(0) : DontResolveSymlinks); }

#endif // QT3_SUPPORT

protected:

    QFileDialog(const QFileDialogArgs &args);

    void done(int result);

    void accept();

    void changeEvent(QEvent *e);

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_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))

#if defined(Q_WS_MAC)

    Q_PRIVATE_SLOT(d_func(), void _q_macRunNativeAppModalPanel())

#endif

};

inline void QFileDialog::setDirectory(const QDir &adirectory)

{ setDirectory(adirectory.absolutePath()); }

Q_DECLARE_OPERATORS_FOR_FLAGS(QFileDialog::Options)

#endif // QT_NO_FILEDIALOG

QT_END_NAMESPACE

QT_END_HEADER

#endif // QFILEDIALOG_H