Тип QML FileDialog

Встроенный диалог выбора файла. Подробнее...

• Список всех членов, включая наследуемые

Свойства

• acceptLabel : строка
• currentFile : url
• currentFiles : список<url>
• defaultSuffix : строка
• file : url
• fileMode : перечисление
• files : список<url>
• folder : url
• nameFilters : список<строка>
• options : флаги
• rejectLabel : строка
• selectedNameFilter
  • selectedNameFilter.extensions : список<строка>
  • selectedNameFilter.index : целое
  • selectedNameFilter.name : строка

Подробное описание

Тип FileDialog предоставляет API QML для встроенных диалогов выбора файлов.

Чтобы отобразить диалог выбора файла, создайте экземпляр FileDialog, задайте необходимые свойства и вызовите open(). Свойства currentFile или currentFiles можно использовать для определения текущих выбранных файлов в диалоге. Свойства file и files обновляются только после окончательного выбора, сделанного путем подтверждения диалога.

MenuItem {
    text: "Open..."
    onTriggered: fileDialog.open()
}

FileDialog {
    id: fileDialog
    currentFile: document.source
    folder: StandardPaths.writableLocation(StandardPaths.DocumentsLocation)
}

MyDocument {
    id: document
    source: fileDialog.file
}

Доступность

Встроенный диалог выбора файла в настоящее время доступен на следующих платформах:

• iOS
• Linux (при работе с темой платформы GTK+)
• macOS
• Windows

Модуль Qt Labs Platform использует Qt Widgets в качестве резервного варианта на платформах, на которых нет встроенной реализации. Поэтому приложения, использующие типы из модуля Qt Labs Platform, должны ссылаться на QtWidgets и использовать QApplication вместо QGuiApplication.

Для ссылки на библиотеку QtWidgets добавьте следующее в свой файл проекта qmake:

QT += widgets

Создайте экземпляр QApplication в main():

#include <QApplication>
#include <QQmlApplicationEngine>

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

Примечание: Типы в модулях Qt.labs не гарантируют совместимости в будущих версиях.

См. также FolderDialog и StandardPaths.

Документация по свойствам

acceptLabel : строка

Это свойство содержит текст метки, отображаемой на кнопке, которая подтверждает диалог.

При установке в пустую строку используется метка по умолчанию для базовой платформы. Метка по умолчанию обычно равна Открыть или Сохранить, в зависимости от используемого fileMode в диалоге.

Значение по умолчанию — пустая строка.

См. также rejectLabel.

currentFile : url

Это свойство содержит текущий выбранный файл в диалоге.

В отличие от свойства file, свойство currentFile обновляется во время выбора файлов пользователем в диалоге, даже до окончательного выбора.

См. также file и currentFiles.

currentFiles : список<url>

Это свойство содержит текущие выбранные файлы в диалоге.

В отличие от свойства files, свойство currentFiles обновляется во время выбора файлов пользователем в диалоге, даже до окончательного выбора.

См. также files и currentFile.

defaultSuffix : строка

Это свойство содержит суффикс, который добавляется к выбранным файлам, у которых нет указанного суффикса. Суффикс обычно используется для обозначения типа файла (например, "txt" обозначает текстовый файл).

Если первый символ — точка ('.') — она удаляется.

file : url

Это свойство содержит окончательно принятый файл.

В отличие от свойства currentFile, свойство file не обновляется во время выбора файлов пользователем в диалоге, а только после окончательного выбора. То есть, когда пользователь нажал ОК, чтобы принять файл. В качестве альтернативы можно обработать сигнал accepted(), чтобы получить окончательный выбор.

См. также currentFile и accepted().

fileMode : перечисление

Это свойство содержит режим диалога.

Доступные значения:

files : список<url>

Это свойство содержит окончательно принятые файлы.

В отличие от свойства currentFiles, свойство files не обновляется во время выбора файлов пользователем в диалоге, а только после окончательного выбора. То есть, когда пользователь нажал ОК, чтобы принять файлы. В качестве альтернативы можно обработать сигнал accepted(), чтобы получить окончательный выбор.

См. также currentFiles и accepted().

folder : url

Это свойство содержит папку, где выбираются файлы. Для выбора папки используйте FolderDialog вместо этого.

См. также FolderDialog.

nameFilters : список<строка>

Это свойство содержит фильтры, которые ограничивают типы файлов, которые могут быть выбраны.

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

Примечание: *.* — это не переносимый фильтр, потому что историческое предположение о том, что расширение файла определяет тип файла, не согласуется на всех операционных системах. Возможно наличие файла без точки в имени (например, Makefile). В встроенном диалоге Windows *.* будет соответствовать таким файлам, в то время как в других типах диалогов это может быть не так. Поэтому лучше использовать *, если вы хотите выбрать любой файл.

См. также selectedNameFilter.

options : флаги

Это свойство содержит различные параметры, которые влияют на внешний вид диалога.

По умолчанию все параметры отключены.

Параметры должны быть установлены перед отображением диалога. Установка их во время отображения диалога не гарантирует немедленного эффекта на диалог (в зависимости от параметра и платформы).

Доступные параметры:

rejectLabel : строка

Это свойство содержит текст метки, отображаемой на кнопке, отклоняющей диалог.

При установке в пустую строку используется метка по умолчанию для текущей платформы. Метка по умолчанию обычно Отмена.

Значение по умолчанию — пустая строка.

См. также acceptLabel.

selectedNameFilter.extensions : список<строка>

Эти свойства содержат текущий выбранный фильтр имен.

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

MyDocument {
    id: document
    fileType: fileDialog.selectedNameFilter.extensions[0]
}

См. также nameFilters.