| /**************************************************************************** | |
| ** | |
| ** Copyright (C) 2016 The Qt Company Ltd. | |
| ** Contact: https://www.qt.io/licensing/ | |
| ** | |
| ** This file is part of the Qt Quick Dialogs 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$ | |
| ** | |
| ****************************************************************************/ | |
| #include "qquickplatformfiledialog_p.h" | |
| #include "qquickitem.h" | |
| #include <private/qguiapplication_p.h> | |
| #include <QWindow> | |
| #include <QQuickView> | |
| #include <QQuickWindow> | |
| QT_BEGIN_NAMESPACE | |
| /*! | |
| \qmltype FileDialog | |
| \instantiates QQuickPlatformFileDialog1 | |
| \inqmlmodule QtQuick.Dialogs | |
| \ingroup qtquickdialogs | |
| \brief Dialog component for choosing files from a local filesystem. | |
| \since 5.1 | |
| FileDialog provides a basic file chooser: it allows the user to select | |
| existing files and/or directories, or create new filenames. The dialog is | |
| initially invisible. You need to set the properties as desired first, then | |
| set \l visible to true or call \l open(). | |
| Here is a minimal example to open a file dialog and exit after the user | |
| chooses a file: | |
| \qml | |
| import QtQuick 2.2 | |
| import QtQuick.Dialogs 1.0 | |
| FileDialog { | |
| id: fileDialog | |
| title: "Please choose a file" | |
| folder: shortcuts.home | |
| onAccepted: { | |
| console.log("You chose: " + fileDialog.fileUrls) | |
| Qt.quit() | |
| } | |
| onRejected: { | |
| console.log("Canceled") | |
| Qt.quit() | |
| } | |
| Component.onCompleted: visible = true | |
| } | |
| \endqml | |
| A FileDialog window is automatically transient for its parent window. So | |
| whether you declare the dialog inside an \l Item or inside a \l Window, the | |
| dialog will appear centered over the window containing the item, or over | |
| the Window that you declared. | |
| The implementation of FileDialog will be a platform file dialog if | |
| possible. If that isn't possible, then it will try to instantiate a | |
| \l QFileDialog. If that also isn't possible, then it will fall back to a QML | |
| implementation, DefaultFileDialog.qml. In that case you can customize the | |
| appearance by editing this file. DefaultFileDialog.qml contains a Rectangle | |
| to hold the dialog's contents, because certain embedded systems do not | |
| support multiple top-level windows. When the dialog becomes visible, it | |
| will automatically be wrapped in a Window if possible, or simply reparented | |
| on top of the main window if there can only be one window. | |
| The QML implementation has a sidebar containing \l shortcuts to common | |
| platform-specific locations, and user-modifiable favorites. It uses | |
| application-specific \l {Qt.labs.settings}{settings} to store the user's | |
| favorites, as well as other user-modifiable state, such as whether or | |
| not the sidebar is shown, the positions of the splitters, and the dialog | |
| size. The settings are stored in a section called \c QQControlsFileDialog | |
| of the application-specific \l QSettings. For example when testing an | |
| application with the qml tool, the \c QQControlsFileDialog section will be | |
| created in the \c {Qml Runtime} settings file (or registry entry). If an | |
| application is started via a custom C++ main() function, it is recommended | |
| to set the | |
| \l {QCoreApplication::applicationName}{name}, | |
| \l {QCoreApplication::organizationName}{organization} and | |
| \l {QCoreApplication::organizationDomain}{domain} in order to control | |
| the location of the application's settings. If you use | |
| \l {Qt.labs.settings}{Settings} objects in other parts of an | |
| application, they will be stored in other sections of the same file. | |
| \l QFileDialog stores its settings globally instead of per-application. | |
| Platform-native file dialogs may or may not store settings in various | |
| platform-dependent ways. | |
| */ | |
| /*! | |
| \qmlsignal QtQuick::Dialogs::FileDialog::accepted | |
| This signal is emitted when the user has finished using the | |
| dialog. You can then inspect the \l fileUrl or \l fileUrls properties to | |
| get the selection. | |
| Example: | |
| \qml | |
| FileDialog { | |
| onAccepted: { console.log("Selected file: " + fileUrl) } | |
| } | |
| \endqml | |
| The corresponding handler is \c onAccepted. | |
| */ | |
| /*! | |
| \qmlsignal QtQuick::Dialogs::FileDialog::rejected | |
| This signal is emitted when the user has dismissed the dialog, | |
| either by closing the dialog window or by pressing the Cancel button. | |
| The corresponding handler is \c onRejected. | |
| */ | |
| /*! | |
| \class QQuickPlatformFileDialog1 | |
| \inmodule QtQuick.Dialogs | |
| \internal | |
| \since 5.1 | |
| \brief The QQuickPlatformFileDialog1 class provides a file dialog | |
| The dialog is implemented via the QPlatformFileDialogHelper when possible; | |
| otherwise it falls back to a QFileDialog or a QML implementation. | |
| */ | |
| /*! | |
| Constructs a file dialog with parent window \a parent. | |
| */ | |
| QQuickPlatformFileDialog1::QQuickPlatformFileDialog1(QObject *parent) : | |
| QQuickFileDialog(parent) | |
| { | |
| } | |
| /*! | |
| Destroys the file dialog. | |
| */ | |
| QQuickPlatformFileDialog1::~QQuickPlatformFileDialog1() | |
| { | |
| if (m_dlgHelper) | |
| m_dlgHelper->hide(); | |
| delete m_dlgHelper; | |
| } | |
| QList<QUrl> QQuickPlatformFileDialog1::fileUrls() const | |
| { | |
| if (m_dialogHelperInUse) | |
| return m_dlgHelper->selectedFiles(); | |
| return QQuickFileDialog::fileUrls(); | |
| } | |
| void QQuickPlatformFileDialog1::setModality(Qt::WindowModality m) | |
| { | |
| #ifdef Q_OS_WIN | |
| // A non-modal native file dialog is not possible on Windows, so | |
| // be stubborn about it. Emit modalityChanged() whether it changed | |
| // or not, to ensure that anything which depends on the property | |
| // will re-read the actual current value. | |
| if (m != Qt::ApplicationModal) | |
| m = Qt::ApplicationModal; | |
| if (m == m_modality) | |
| emit modalityChanged(); | |
| #endif | |
| QQuickAbstractFileDialog::setModality(m); | |
| } | |
| QPlatformFileDialogHelper *QQuickPlatformFileDialog1::helper() | |
| { | |
| QQuickItem *parentItem = qobject_cast<QQuickItem *>(parent()); | |
| if (parentItem) | |
| m_parentWindow = parentItem->window(); | |
| if ( !m_dlgHelper && QGuiApplicationPrivate::platformTheme()-> | |
| usePlatformNativeDialog(QPlatformTheme::FileDialog) ) { | |
| m_dlgHelper = static_cast<QPlatformFileDialogHelper *>(QGuiApplicationPrivate::platformTheme() | |
| ->createPlatformDialogHelper(QPlatformTheme::FileDialog)); | |
| if (!m_dlgHelper) | |
| return m_dlgHelper; | |
| m_dlgHelper->setOptions(m_options); | |
| connect(m_dlgHelper, SIGNAL(filterSelected(QString)), this, SIGNAL(filterSelected())); | |
| connect(m_dlgHelper, SIGNAL(accept()), this, SLOT(accept())); | |
| connect(m_dlgHelper, SIGNAL(reject()), this, SLOT(reject())); | |
| } | |
| return m_dlgHelper; | |
| } | |
| void QQuickPlatformFileDialog1::accept() | |
| { | |
| updateFolder(folder()); | |
| QQuickFileDialog::accept(); | |
| } | |
| /*! | |
| \qmlproperty bool FileDialog::visible | |
| This property holds whether the dialog is visible. By default this is | |
| false. | |
| \sa modality | |
| */ | |
| /*! | |
| \qmlproperty Qt::WindowModality FileDialog::modality | |
| Whether the dialog should be shown modal with respect to the window | |
| containing the dialog's parent Item, modal with respect to the whole | |
| application, or non-modal. | |
| By default it is \c Qt.WindowModal. | |
| Modality does not mean that there are any blocking calls to wait for the | |
| dialog to be accepted or rejected; it's only that the user will be | |
| prevented from interacting with the parent window and/or the application | |
| windows at the same time. You probably need to write an onAccepted handler | |
| to actually load or save the chosen file. | |
| */ | |
| /*! | |
| \qmlmethod void FileDialog::open() | |
| Shows the dialog to the user. It is equivalent to setting \l visible to | |
| true. | |
| */ | |
| /*! | |
| \qmlmethod void FileDialog::close() | |
| Closes the dialog. | |
| */ | |
| /*! | |
| \qmlproperty string FileDialog::title | |
| The title of the dialog window. | |
| */ | |
| /*! | |
| \qmlproperty bool FileDialog::selectExisting | |
| Whether only existing files or directories can be selected. | |
| By default, this property is true. This property must be set to the desired | |
| value before opening the dialog. Setting this property to false implies | |
| that the dialog is for naming a file to which to save something, or naming | |
| a folder to be created; therefore \l selectMultiple must be false. | |
| */ | |
| /*! | |
| \qmlproperty bool FileDialog::selectMultiple | |
| Whether more than one filename can be selected. | |
| By default, this property is false. This property must be set to the | |
| desired value before opening the dialog. Setting this property to true | |
| implies that \l selectExisting must be true. | |
| */ | |
| /*! | |
| \qmlproperty bool FileDialog::selectFolder | |
| Whether the selected item should be a folder. | |
| By default, this property is false. This property must be set to the | |
| desired value before opening the dialog. Setting this property to true | |
| implies that \l selectMultiple must be false and \l selectExisting must be | |
| true. | |
| */ | |
| /*! | |
| \qmlproperty url FileDialog::folder | |
| The path to the currently selected folder. Setting this property before | |
| invoking open() will cause the file browser to be initially positioned on | |
| the specified folder. | |
| The value of this property is also updated after the dialog is closed. | |
| By default, the url is empty. | |
| \note On iOS, if you set \a folder to \l{shortcuts} | |
| {shortcuts.pictures}, | |
| a native image picker dialog will be used for accessing the user's photo album. | |
| The URL returned can be set as \l{Image::source}{source} for \l{Image}. | |
| For this to be enabled, the Info.plist assigned to QMAKE_INFO_PLIST in the project file must | |
| contain the key, NSPhotoLibraryUsageDescription. See Info.plist documentation from Apple for | |
| more information regarding this key. This feature was added in Qt 5.5. | |
| \sa shortcuts | |
| */ | |
| /*! | |
| \qmlproperty Object FileDialog::shortcuts | |
| \since 5.5 | |
| A map of some useful paths from QStandardPaths to their URLs. | |
| Each path is verified to exist on the user's computer before being added | |
| to this list, at the time when the FileDialog is created. | |
| \table | |
| \row | |
| \li \c desktop | |
| \li \l QStandardPaths::DesktopLocation | |
| \li The user's desktop directory. | |
| \row | |
| \li \c documents | |
| \li \l QStandardPaths::DocumentsLocation | |
| \li The directory containing user document files. | |
| \row | |
| \li \c home | |
| \li \l QStandardPaths::HomeLocation | |
| \li The user's home directory. | |
| \row | |
| \li \c music | |
| \li \l QStandardPaths::MusicLocation | |
| \li The directory containing the user's music or other audio files. | |
| \row | |
| \li \c movies | |
| \li \l QStandardPaths::MoviesLocation | |
| \li The directory containing the user's movies and videos. | |
| \row | |
| \li \c pictures | |
| \li \l QStandardPaths::PicturesLocation | |
| \li The directory containing the user's pictures or photos. It is always | |
| a kind of \c file: URL; but on some platforms, it will be specialized, | |
| such that the FileDialog will be realized as a gallery browser dialog. | |
| \endtable | |
| For example, \c shortcuts.home will provide the URL of the user's | |
| home directory. | |
| */ | |
| /*! | |
| \qmlproperty list<string> FileDialog::nameFilters | |
| A list of strings to be used as file name filters. Each string can be a | |
| space-separated list of filters; filters may include the ? and * wildcards. | |
| The list of filters can also be enclosed in parentheses and a textual | |
| description of the filter can be provided. | |
| For example: | |
| \qml | |
| FileDialog { | |
| nameFilters: [ "Image files (*.jpg *.png)", "All files (*)" ] | |
| } | |
| \endqml | |
| \note Directories are not excluded by filters. | |
| \sa selectedNameFilter | |
| */ | |
| /*! | |
| \qmlproperty string FileDialog::selectedNameFilter | |
| Which of the \l nameFilters is currently selected. | |
| This property can be set before the dialog is visible, to set the default | |
| name filter, and can also be set while the dialog is visible to set the | |
| current name filter. It is also updated when the user selects a different | |
| filter. | |
| */ | |
| /*! | |
| \qmlproperty url FileDialog::fileUrl | |
| The path of the file which was selected by the user. | |
| \note This property is set only if exactly one file was selected. In all | |
| other cases, it will be empty. | |
| \sa fileUrls | |
| */ | |
| /*! | |
| \qmlproperty list<url> FileDialog::fileUrls | |
| The list of file paths which were selected by the user. | |
| */ | |
| /*! | |
| \qmlproperty bool FileDialog::sidebarVisible | |
| \since 5.4 | |
| This property holds whether the sidebar in the dialog containing shortcuts | |
| and bookmarks is visible. By default it depends on the setting stored in | |
| the \c QQControlsFileDialog section of the application's | |
| \l {Qt.labs.settings}{Settings}. | |
| */ | |
| /*! | |
| \qmlproperty string FileDialog::defaultSuffix | |
| \since 5.10 | |
| This property holds the suffix added to the filename if no other suffix was | |
| specified. | |
| This property specifies a string that will be added to the filename if it | |
| has no suffix already. The suffix is typically used to indicate the file | |
| type (e.g. "txt" indicates a text file). | |
| If the first character is a dot ('.'), it is removed. | |
| */ | |
| QT_END_NAMESPACE |