FileDialog QML Type

A native file dialog. 更多...

import 语句：	import Qt.labs.platform 1.1
Since:	Qt 5.8
继承：	Dialog

所有成员列表，包括继承成员

特性

acceptLabel : string
currentFile : url
currentFiles : list<url>
defaultSuffix : string
file : url
fileMode : enumeration
文件 : list<url>
folder : url
nameFilters : list<string>
options : flags
rejectLabel : string
selectedNameFilter
- selectedNameFilter.extensions : list<string>
- selectedNameFilter.index : int
- selectedNameFilter.name : string

详细描述

The FileDialog type provides a QML API for native platform file dialogs.

To show a file dialog, construct an instance of FileDialog, set the desired properties, and call open() 。 currentFile or currentFiles properties can be used to determine the currently selected file(s) in the dialog. The file and 文件 properties are updated only after the final selection has been made by accepting the dialog.

MenuItem {
    text: "Open..."
    onTriggered: fileDialog.open()
}
FileDialog {
    id: fileDialog
    currentFile: document.source
    folder: StandardPaths.writableLocation(StandardPaths.DocumentsLocation)
}
MyDocument {
    id: document
    source: fileDialog.file
}

可用性

A native platform file dialog is currently available on the following platforms:

iOS
Linux (when running with the GTK+ platform theme)
macOS
Windows
WinRT

The Qt Labs Platform module uses Qt Widgets as a fallback on platforms that do not have a native implementation available. Therefore, applications that use types from the Qt Labs Platform module should link to QtWidgets and use QApplication 而不是 QGuiApplication .

要链接到 QtWidgets library, add the following to your qmake project file:

QT += widgets

Create an instance of QApplication in main() :

#include <QApplication>
#include <QQmlApplicationEngine>
int main(int argc, char *argv[])
{
    QApplication::setAttribute(Qt::AA_EnableHighDpiScaling);
    QApplication app(argc, argv);
    QQmlApplicationEngine engine;
    engine.load(QUrl(QStringLiteral("qrc:/main.qml")));
    return app.exec();
}

注意： Types in Qt.labs modules are not guaranteed to remain compatible in future versions.

另请参阅 FolderDialog and StandardPaths .

特性文档编制

acceptLabel : string

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 打开 or Save depending on which fileMode the dialog is used in.

默认值为空字符串。

另请参阅 rejectLabel .

currentFile : url

This property holds the currently selected file in the dialog.

不像 file 特性， currentFile property is updated while the user is selecting files in the dialog, even before the final selection has been made.

另请参阅 file and currentFiles .

currentFiles : list < url >

This property holds the currently selected files in the dialog.

不像文件特性， currentFiles property is updated while the user is selecting files in the dialog, even before the final selection has been made.

另请参阅 文件 and currentFile .

defaultSuffix : string

This property holds a suffix that is added to selected files that have no suffix specified. 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.

file : url

This property holds the final accepted file.

不像 currentFile 特性， file property is not updated while the user is selecting files in the dialog, but only after the final selection has been made. That is, when the user has clicked OK to accept a file. Alternatively, the accepted() signal can be handled to get the final selection.

另请参阅 currentFile and accepted() .

fileMode : enumeration

This property holds the mode of the dialog.

Available values:

常量	描述
`FileDialog.OpenFile`	The dialog is used to select an existing file (default).
`FileDialog.OpenFiles`	The dialog is used to select multiple existing files.
`FileDialog.SaveFile`	The dialog is used to select any file. The file does not have to exist.

文件 : list < url >

This property holds the final accepted files.

不像 currentFiles 特性， 文件 property is not updated while the user is selecting files in the dialog, but only after the final selection has been made. That is, when the user has clicked OK to accept files. Alternatively, the accepted() signal can be handled to get the final selection.

另请参阅 currentFiles and accepted() .

folder : url

This property holds the folder where files are selected. For selecting a folder, use FolderDialog 代替。

另请参阅 FolderDialog .

nameFilters : list < string >

This property holds the filters that restrict the types of files that can be selected.

FileDialog {
    nameFilters: ["Text files (*.txt)", "HTML files (*.html *.htm)"]
}

注意： *.* is not a portable filter, because the historical assumption that the file extension determines the file type is not consistent on every operating system. It is possible to have a file with no dot in its name (for example, Makefile ). In a native Windows file dialog, *.* will match such files, while in other types of file dialogs it may not. So it is better to use * if you mean to select any file.

另请参阅 selectedNameFilter .

options : flags

This property holds the various options that affect the look and feel of the dialog.

默认情况下，所有选项是被禁用的。

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:

常量	描述
`FileDialog.DontResolveSymlinks`	不解析文件对话框中的符号链接。默认情况下，解析符号链接。
`FileDialog.DontConfirmOverwrite`	不要求确认，若选中现有文件。默认情况下，请求确认。
`FileDialog.ReadOnly`	Indicates that the dialog doesn't allow creating directories.
`FileDialog.HideNameFilterDetails`	指示是否隐藏文件名过滤器细节。

rejectLabel : string

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 Cancel .

默认值为空字符串。

另请参阅 acceptLabel .

selectedNameFilter group
selectedNameFilter.extensions : list < string >
selectedNameFilter.index : int
selectedNameFilter.name : string

These properties hold the currently selected name filter.

名称	描述
index : int	This property determines which name filter is selected. The specified filter is selected when the dialog is opened. The value is updated when the user selects another filter.
[read-only] 名称 : string	This property holds the name of the selected filter. In the example below, the name of the first filter is `"Text files"` and the second is `"HTML files"` .
[read-only] extensions : list<string>	This property holds the list of extensions of the selected filter. In the example below, the list of extensions of the first filter is `["txt"]` and the second is `["html", "htm"]` .

FileDialog {
    id: fileDialog
    selectedNameFilter.index: 1
    nameFilters: ["Text files (*.txt)", "HTML files (*.html *.htm)"]
}
MyDocument {
    id: document
    fileType: fileDialog.selectedNameFilter.extensions[0]
}

另请参阅 nameFilters .