1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
|
// Copyright (C) 2017 The Qt Company Ltd.
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR LGPL-3.0-only OR GPL-2.0-only OR GPL-3.0-only
#include "qquicklabsplatformfolderdialog_p.h"
QT_BEGIN_NAMESPACE
/*!
\qmltype FolderDialog
\inherits Dialog
//! \instantiates QQuickLabsPlatformFolderDialog
\inqmlmodule Qt.labs.platform
\since 5.8
\brief A native folder dialog.
The FolderDialog type provides a QML API for native platform folder dialogs.
\image qtlabsplatform-folderdialog-gtk.png
To show a folder dialog, construct an instance of FolderDialog, set the
desired properties, and call \l {Dialog::}{open()}. The \l currentFolder
property can be used to determine the currently selected folder in the
dialog. The \l folder property is updated only after the final selection
has been made by accepting the dialog.
\code
MenuItem {
text: "Open..."
onTriggered: folderDialog.open()
}
FolderDialog {
id: folderDialog
currentFolder: viewer.folder
folder: StandardPaths.standardLocations(StandardPaths.PicturesLocation)[0]
}
MyViewer {
id: viewer
folder: folderDialog.folder
}
\endcode
\section2 Availability
A native platform folder dialog is currently available on the following platforms:
\list
\li Android
\li iOS
\li Linux (when running with the GTK+ platform theme)
\li macOS
\li Windows
\endlist
\input includes/widgets.qdocinc 1
\labs
\sa FileDialog, StandardPaths
*/
QQuickLabsPlatformFolderDialog::QQuickLabsPlatformFolderDialog(QObject *parent)
: QQuickLabsPlatformDialog(QPlatformTheme::FileDialog, parent),
m_options(QFileDialogOptions::create())
{
m_options->setFileMode(QFileDialogOptions::Directory);
m_options->setAcceptMode(QFileDialogOptions::AcceptOpen);
}
/*!
\qmlproperty url Qt.labs.platform::FolderDialog::folder
This property holds the final accepted folder.
Unlike the \l currentFolder property, the \c folder property is not updated
while the user is selecting folders in the dialog, but only after the final
selection has been made. That is, when the user has clicked \uicontrol OK
to accept a folder. Alternatively, the \l {Dialog::}{accepted()} signal
can be handled to get the final selection.
\sa currentFolder, {Dialog::}{accepted()}
*/
QUrl QQuickLabsPlatformFolderDialog::folder() const
{
return m_folder;
}
void QQuickLabsPlatformFolderDialog::setFolder(const QUrl &folder)
{
if (m_folder == folder)
return;
m_folder = folder;
emit folderChanged();
}
/*!
\qmlproperty url Qt.labs.platform::FolderDialog::currentFolder
This property holds the currently selected folder in the dialog.
Unlike the \l folder property, the \c currentFolder property is updated
while the user is selecting folders in the dialog, even before the final
selection has been made.
\sa folder
*/
QUrl QQuickLabsPlatformFolderDialog::currentFolder() const
{
if (QPlatformFileDialogHelper *fileDialog = qobject_cast<QPlatformFileDialogHelper *>(handle())) {
const QList<QUrl> selectedFiles = fileDialog->selectedFiles();
if (!selectedFiles.isEmpty())
return selectedFiles.first();
return fileDialog->directory();
}
return m_options->initialDirectory();
}
void QQuickLabsPlatformFolderDialog::setCurrentFolder(const QUrl &folder)
{
if (QPlatformFileDialogHelper *fileDialog = qobject_cast<QPlatformFileDialogHelper *>(handle()))
fileDialog->setDirectory(folder);
m_options->setInitialDirectory(folder);
}
/*!
\qmlproperty flags Qt.labs.platform::FolderDialog::options
This property holds the various options that affect the look and feel of the dialog.
By default, all options are disabled.
Options should be set before showing the dialog. Setting them while the dialog is
visible is not guaranteed to have an immediate effect on the dialog (depending on
the option and on the platform).
Available options:
\value FolderDialog.ShowDirsOnly Only show directories in the folder dialog. By default both folders and directories are shown.
\value FolderDialog.DontResolveSymlinks Don't resolve symlinks in the folder dialog. By default symlinks are resolved.
\value FolderDialog.ReadOnly Indicates that the dialog doesn't allow creating directories.
*/
QFileDialogOptions::FileDialogOptions QQuickLabsPlatformFolderDialog::options() const
{
return m_options->options();
}
void QQuickLabsPlatformFolderDialog::setOptions(QFileDialogOptions::FileDialogOptions options)
{
if (options == m_options->options())
return;
m_options->setOptions(options);
emit optionsChanged();
}
void QQuickLabsPlatformFolderDialog::resetOptions()
{
setOptions({});
}
/*!
\qmlproperty string Qt.labs.platform::FolderDialog::acceptLabel
This property holds the label text shown on the button that accepts the dialog.
When set to an empty string, the default label of the underlying platform is used.
The default label is typically \uicontrol Open.
The default value is an empty string.
\sa rejectLabel
*/
QString QQuickLabsPlatformFolderDialog::acceptLabel() const
{
return m_options->labelText(QFileDialogOptions::Accept);
}
void QQuickLabsPlatformFolderDialog::setAcceptLabel(const QString &label)
{
if (label == m_options->labelText(QFileDialogOptions::Accept))
return;
m_options->setLabelText(QFileDialogOptions::Accept, label);
emit acceptLabelChanged();
}
void QQuickLabsPlatformFolderDialog::resetAcceptLabel()
{
setAcceptLabel(QString());
}
/*!
\qmlproperty string Qt.labs.platform::FolderDialog::rejectLabel
This property holds the label text shown on the button that rejects the dialog.
When set to an empty string, the default label of the underlying platform is used.
The default label is typically \uicontrol Cancel.
The default value is an empty string.
\sa acceptLabel
*/
QString QQuickLabsPlatformFolderDialog::rejectLabel() const
{
return m_options->labelText(QFileDialogOptions::Reject);
}
void QQuickLabsPlatformFolderDialog::setRejectLabel(const QString &label)
{
if (label == m_options->labelText(QFileDialogOptions::Reject))
return;
m_options->setLabelText(QFileDialogOptions::Reject, label);
emit rejectLabelChanged();
}
void QQuickLabsPlatformFolderDialog::resetRejectLabel()
{
setRejectLabel(QString());
}
bool QQuickLabsPlatformFolderDialog::useNativeDialog() const
{
return QQuickLabsPlatformDialog::useNativeDialog()
&& !m_options->testOption(QFileDialogOptions::DontUseNativeDialog);
}
void QQuickLabsPlatformFolderDialog::onCreate(QPlatformDialogHelper *dialog)
{
if (QPlatformFileDialogHelper *fileDialog = qobject_cast<QPlatformFileDialogHelper *>(dialog)) {
connect(fileDialog, &QPlatformFileDialogHelper::currentChanged, this, &QQuickLabsPlatformFolderDialog::currentFolderChanged);
fileDialog->setOptions(m_options);
}
}
void QQuickLabsPlatformFolderDialog::onShow(QPlatformDialogHelper *dialog)
{
m_options->setWindowTitle(title());
if (QPlatformFileDialogHelper *fileDialog = qobject_cast<QPlatformFileDialogHelper *>(dialog))
fileDialog->setOptions(m_options);
}
void QQuickLabsPlatformFolderDialog::accept()
{
setFolder(currentFolder());
QQuickLabsPlatformDialog::accept();
}
QT_END_NAMESPACE
#include "moc_qquicklabsplatformfolderdialog_p.cpp"
|
