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

**

** Copyright (C) 2010 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$

**

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

#include <qvariant.h>

#include <private/qwidgetitemdata_p.h>

#include "qfiledialog.h"

#ifndef QT_NO_FILEDIALOG

#include "qfiledialog_p.h"

#include <qfontmetrics.h>

#include <qaction.h>

#include <qheaderview.h>

#include <qshortcut.h>

#include <qgridlayout.h>

#include <qmenu.h>

#include <qmessagebox.h>

#include <qinputdialog.h>

#include <stdlib.h>

#include <qsettings.h>

#include <qdebug.h>

#include <qapplication.h>

#include <qstylepainter.h>

#if !defined(Q_WS_WINCE) && !defined(Q_OS_SYMBIAN)

#include "ui_qfiledialog.h"

#else

#define Q_EMBEDDED_SMALLSCREEN

#include "ui_qfiledialog_embedded.h"

#if defined(Q_OS_WINCE)

extern bool qt_priv_ptr_valid;

#endif

#endif

QT_BEGIN_NAMESPACE

Q_GLOBAL_STATIC(QString, lastVisitedDir)

/*

    \internal

    Exported hooks that can be used to customize the static functions.

 */

typedef QString (*_qt_filedialog_existing_directory_hook)(QWidget *parent, const QString &caption, const QString &dir, QFileDialog::Options options);

Q_GUI_EXPORT _qt_filedialog_existing_directory_hook qt_filedialog_existing_directory_hook = 0;

typedef QString (*_qt_filedialog_open_filename_hook)(QWidget * parent, const QString &caption, const QString &dir, const QString &filter, QString *selectedFilter, QFileDialog::Options options);

Q_GUI_EXPORT _qt_filedialog_open_filename_hook qt_filedialog_open_filename_hook = 0;

typedef QStringList (*_qt_filedialog_open_filenames_hook)(QWidget * parent, const QString &caption, const QString &dir, const QString &filter, QString *selectedFilter, QFileDialog::Options options);

Q_GUI_EXPORT _qt_filedialog_open_filenames_hook qt_filedialog_open_filenames_hook = 0;

typedef QString (*_qt_filedialog_save_filename_hook)(QWidget * parent, const QString &caption, const QString &dir, const QString &filter, QString *selectedFilter, QFileDialog::Options options);

Q_GUI_EXPORT _qt_filedialog_save_filename_hook qt_filedialog_save_filename_hook = 0;

/*!

  \class QFileDialog

  \brief The QFileDialog class provides a dialog that allow users to select files or directories.

  \ingroup standard-dialogs

  The QFileDialog class enables a user to traverse the file system in

  order to select one or many files or a directory.

  The easiest way to create a QFileDialog is to use the static

  functions. On Windows, Mac OS X, KDE and GNOME, these static functions will

  call the native file dialog when possible.

  \snippet doc/src/snippets/code/src_gui_dialogs_qfiledialog.cpp 0

  In the above example, a modal QFileDialog is created using a static

  function. The dialog initially displays the contents of the "/home/jana"

  directory, and displays files matching the patterns given in the

  string "Image Files (*.png *.jpg *.bmp)". The parent of the file dialog

  is set to \e this, and the window title is set to "Open Image".

  If you want to use multiple filters, separate each one with

  \e two semicolons. For example:

  \snippet doc/src/snippets/code/src_gui_dialogs_qfiledialog.cpp 1

  You can create your own QFileDialog without using the static

  functions. By calling setFileMode(), you can specify what the user must

  select in the dialog:

  \snippet doc/src/snippets/code/src_gui_dialogs_qfiledialog.cpp 2

  In the above example, the mode of the file dialog is set to

  AnyFile, meaning that the user can select any file, or even specify a

  file that doesn't exist. This mode is useful for creating a

  "Save As" file dialog. Use ExistingFile if the user must select an

  existing file, or \l Directory if only a directory may be selected.

  See the \l QFileDialog::FileMode enum for the complete list of modes.

  The fileMode property contains the mode of operation for the dialog;

  this indicates what types of objects the user is expected to select.

  Use setNameFilter() to set the dialog's file filter. For example:

  \snippet doc/src/snippets/code/src_gui_dialogs_qfiledialog.cpp 3

  In the above example, the filter is set to \c{"Images (*.png *.xpm *.jpg)"},

  this means that only files with the extension \c png, \c xpm,

  or \c jpg will be shown in the QFileDialog. You can apply

  several filters by using setNameFilters(). Use selectNameFilter() to select

  one of the filters you've given as the file dialog's default filter.

  The file dialog has two view modes: \l{QFileDialog::}{List} and

  \l{QFileDialog::}{Detail}.

  \l{QFileDialog::}{List} presents the contents of the current directory

  as a list of file and directory names. \l{QFileDialog::}{Detail} also

  displays a list of file and directory names, but provides additional

  information alongside each name, such as the file size and modification

  date. Set the mode with setViewMode():

  \snippet doc/src/snippets/code/src_gui_dialogs_qfiledialog.cpp 4

  The last important function you will need to use when creating your

  own file dialog is selectedFiles().

  \snippet doc/src/snippets/code/src_gui_dialogs_qfiledialog.cpp 5

  In the above example, a modal file dialog is created and shown. If

  the user clicked OK, the file they selected is put in \c fileName.

  The dialog's working directory can be set with setDirectory().

  Each file in the current directory can be selected using

  the selectFile() function.

  The \l{dialogs/standarddialogs}{Standard Dialogs} example shows

  how to use QFileDialog as well as other built-in Qt dialogs.

  \sa QDir, QFileInfo, QFile, QPrintDialog, QColorDialog, QFontDialog, {Standard Dialogs Example},

      {Application Example}

*/

/*!

    \enum QFileDialog::AcceptMode

    \value AcceptOpen

    \value AcceptSave

*/

/*!

    \enum QFileDialog::ViewMode

    This enum describes the view mode of the file dialog; i.e. what

    information about each file will be displayed.

    \value Detail Displays an icon, a name, and details for each item in

                  the directory.

    \value List   Displays only an icon and a name for each item in the

                  directory.

    \sa setViewMode()

*/

/*!

    \enum QFileDialog::FileMode

    This enum is used to indicate what the user may select in the file

    dialog; i.e. what the dialog will return if the user clicks OK.

    \value AnyFile        The name of a file, whether it exists or not.

    \value ExistingFile   The name of a single existing file.

    \value Directory      The name of a directory. Both files and

                          directories are displayed.

    \value ExistingFiles  The names of zero or more existing files.

    This value is obsolete since Qt 4.5:

    \value DirectoryOnly  Use \c Directory and setOption(ShowDirsOnly, true) instead.

    \sa setFileMode()

*/

/*!

    \enum QFileDialog::Option

    \value ShowDirsOnly Only show directories in the file dialog. By

    default both files and directories are shown. (Valid only in the

    \l Directory file mode.)

    \value DontResolveSymlinks Don't resolve symlinks in the file

    dialog. By default symlinks are resolved.

    \value DontConfirmOverwrite Don't ask for confirmation if an

    existing file is selected.  By default confirmation is requested.

    \value DontUseNativeDialog Don't use the native file dialog. By

    default, the native file dialog is used unless you use a subclass

    of QFileDialog that contains the Q_OBJECT macro.

    \value ReadOnly Indicates that the model is readonly.

    \value HideNameFilterDetails Indicates if the is hidden or not.

    \value DontUseSheet In previous versions of Qt, the static

    functions would create a sheet by default if the static function

    was given a parent. This is no longer supported and does nothing in Qt 4.5, The

    static functions will always be an application modal dialog. If

    you want to use sheets, use QFileDialog::open() instead.

*/

/*!

  \enum QFileDialog::DialogLabel

  \value LookIn

  \value FileName

  \value FileType

  \value Accept

  \value Reject

*/

/*!

    \fn void QFileDialog::filesSelected(const QStringList &selected)

    When the selection changes and the dialog is accepted, this signal is

    emitted with the (possibly empty) list of \a selected files.

    \sa currentChanged(), QDialog::Accepted

*/

/*!

    \fn void QFileDialog::fileSelected(const QString &file)

    When the selection changes and the dialog is accepted, this signal is

    emitted with the (possibly empty) selected \a file.

    \sa currentChanged(), QDialog::Accepted

*/

/*!

    \fn void QFileDialog::currentChanged(const QString &path)

    When the current file changes, this signal is emitted with the

    new file name as the \a path parameter.

    \sa filesSelected()

*/

/*!

  \fn void QFileDialog::directoryEntered(const QString &directory)

  \since 4.3

  This signal is emitted when the user enters a \a directory.

*/

/*!

  \fn void QFileDialog::filterSelected(const QString &filter)

  \since 4.3

  This signal is emitted when the user selects a \a filter.

*/

#if defined(Q_WS_WIN) || defined(Q_WS_MAC)

bool Q_GUI_EXPORT qt_use_native_dialogs = true; // for the benefit of testing tools, until we have a proper API

#endif

QT_BEGIN_INCLUDE_NAMESPACE

#ifdef Q_WS_WIN

#include <qwindowsstyle.h>

#endif

#include <qshortcut.h>

#ifdef Q_WS_MAC

#include <private/qunicodetables_p.h>

#include <qmacstyle_mac.h>

#endif

QT_END_INCLUDE_NAMESPACE

/*!

    \fn QFileDialog::QFileDialog(QWidget *parent, Qt::WindowFlags flags)

    Constructs a file dialog with the given \a parent and widget \a flags.

*/

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

    : QDialog(*new QFileDialogPrivate, parent, f)

{

    Q_D(QFileDialog);

    d->init();

    d->lineEdit()->selectAll();

}

/*!

    Constructs a file dialog with the given \a parent and \a caption that

    initially displays the contents of the specified \a directory.

    The contents of the directory are filtered before being shown in the

    dialog, using a semicolon-separated list of filters specified by

    \a filter.

*/

QFileDialog::QFileDialog(QWidget *parent,

                     const QString &caption,

                     const QString &directory,

                     const QString &filter)

    : QDialog(*new QFileDialogPrivate, parent, 0)

{

    Q_D(QFileDialog);

    d->init(directory, filter, caption);

    d->lineEdit()->selectAll();

}

/*!

    \internal

*/

QFileDialog::QFileDialog(const QFileDialogArgs &args)

    : QDialog(*new QFileDialogPrivate, args.parent, 0)

{

    Q_D(QFileDialog);

    d->init(args.directory, args.filter, args.caption);

    setFileMode(args.mode);

    setOptions(args.options);

    selectFile(args.selection);

    d->lineEdit()->selectAll();

}

/*!

    Destroys the file dialog.

*/

QFileDialog::~QFileDialog()

{

    Q_D(QFileDialog);

#ifndef QT_NO_SETTINGS

    QSettings settings(QSettings::UserScope, QLatin1String("Trolltech"));

    settings.beginGroup(QLatin1String("Qt"));

    settings.setValue(QLatin1String("filedialog"), saveState());

#endif

    d->deleteNativeDialog_sys();

}

/*!

    \since 4.3

    Sets the \a urls that are located in the sidebar.

    For instance:

    \snippet doc/src/snippets/filedialogurls.cpp 0

    The file dialog will then look like this:

    \image filedialogurls.png

    \sa sidebarUrls()

*/

void QFileDialog::setSidebarUrls(const QList<QUrl> &urls)

{

    Q_D(QFileDialog);

    d->qFileDialogUi->sidebar->setUrls(urls);

}

/*!

    \since 4.3

    Returns a list of urls that are currently in the sidebar

*/

QList<QUrl> QFileDialog::sidebarUrls() const

{

    Q_D(const QFileDialog);

    return d->qFileDialogUi->sidebar->urls();

}

static const qint32 QFileDialogMagic = 0xbe;

const char *qt_file_dialog_filter_reg_exp =

"^(.*)\\(([a-zA-Z0-9_.*? +;#\\-\\[\\]@\\{\\}/!<>\\$%&=^~:\\|]*)\\)$";

/*!

    \since 4.3

    Saves the state of the dialog's layout, history and current directory.

    Typically this is used in conjunction with QSettings to remember the size

    for a future session. A version number is stored as part of the data.

*/

QByteArray QFileDialog::saveState() const

{

    Q_D(const QFileDialog);

    int version = 3;

    QByteArray data;

    QDataStream stream(&data, QIODevice::WriteOnly);

    stream << qint32(QFileDialogMagic);

    stream << qint32(version);

    stream << d->qFileDialogUi->splitter->saveState();

    stream << d->qFileDialogUi->sidebar->urls();

    stream << history();

    stream << *lastVisitedDir();

    stream << d->qFileDialogUi->treeView->header()->saveState();

    stream << qint32(viewMode());

    return data;

}

/*!

    \since 4.3

    Restores the dialogs's layout, history and current directory to the \a state specified.

    Typically this is used in conjunction with QSettings to restore the size

    from a past session.

    Returns false if there are errors

*/

bool QFileDialog::restoreState(const QByteArray &state)

{

    Q_D(QFileDialog);

    int version = 3;

    QByteArray sd = state;

    QDataStream stream(&sd, QIODevice::ReadOnly);

    if (stream.atEnd())

        return false;

    QByteArray splitterState;

    QByteArray headerData;

    QList<QUrl> bookmarks;

    QStringList history;

    QString currentDirectory;

    qint32 marker;

    qint32 v;

    qint32 viewMode;

    stream >> marker;

    stream >> v;

    if (marker != QFileDialogMagic || v != version)

        return false;

    stream >> splitterState

           >> bookmarks

           >> history

           >> currentDirectory

           >> headerData

           >> viewMode;

    if (!d->qFileDialogUi->splitter->restoreState(splitterState))

        return false;

    QList<int> list = d->qFileDialogUi->splitter->sizes();

    if (list.count() >= 2 && list.at(0) == 0 && list.at(1) == 0) {

        for (int i = 0; i < list.count(); ++i)

            list[i] = d->qFileDialogUi->splitter->widget(i)->sizeHint().width();

        d->qFileDialogUi->splitter->setSizes(list);

    }

    d->qFileDialogUi->sidebar->setUrls(bookmarks);

    while (history.count() > 5)

        history.pop_front();

    setHistory(history);

    setDirectory(lastVisitedDir()->isEmpty() ? currentDirectory : *lastVisitedDir());

    if (!d->qFileDialogUi->treeView->header()->restoreState(headerData))

        return false;

    setViewMode(ViewMode(viewMode));

    return true;

}

/*!

    \reimp

*/

void QFileDialog::changeEvent(QEvent *e)

{

    Q_D(QFileDialog);

    if (e->type() == QEvent::LanguageChange) {

        d->retranslateWindowTitle();

        d->retranslateStrings();

    }

    QDialog::changeEvent(e);

}

QFileDialogPrivate::QFileDialogPrivate()

    :

#ifndef QT_NO_PROXYMODEL

        proxyModel(0),

#endif

        model(0),

        fileMode(QFileDialog::AnyFile),

        acceptMode(QFileDialog::AcceptOpen),

        currentHistoryLocation(-1),

        renameAction(0),

        deleteAction(0),

        showHiddenAction(0),

        useDefaultCaption(true),

        defaultFileTypes(true),

        fileNameLabelExplicitlySat(false),

        nativeDialogInUse(false),

#ifdef Q_WS_MAC

        mDelegate(0),

#ifndef QT_MAC_USE_COCOA

        mDialog(0),

        mDialogStarted(false),

        mDialogClosed(true),

#endif

#endif

        qFileDialogUi(0)

{

}

QFileDialogPrivate::~QFileDialogPrivate()

{