FileDialog QML Type

ネイティブのファイルダイアログ。詳細...

この型は Qt Labs Platform 6.9 以降で非推奨となっています。新しいコードでの使用は強く推奨しません。

• 継承されたメンバーを含む、すべてのメンバーの一覧

プロパティ

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

詳細説明

代わりにQtQuick.Dialogs FileDialog を使用してください。

FileDialog 型は、ネイティブプラットフォームのファイルダイアログ用の QML API を提供します。

ファイルダイアログを表示するには、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
}

利用可能プラットフォーム

ネイティブのプラットフォームファイルダイアログは、現在以下のプラットフォームで利用可能です:

• Android
• iOS
• Linux（GTK+プラットフォームテーマで実行している場合）
• macOS
• Windows

Qt Labs Platform モジュールは、ネイティブの実装が利用できないプラットフォームにおいて、Qt Widgets をフォールバックとして使用します。したがって、Qt Labs Platform モジュールの型を使用するアプリケーションは、QtWidgets にリンクし、QGuiApplication の代わりにQApplication を使用する必要があります。

QtWidgets ライブラリに対してリンクするには、qmakeプロジェクトファイルに以下を追加してください：

QT += widgets

main() 内でQApplication のインスタンスを作成します:

#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();
}

QtQuick.Dialogs::FileDialog 、FolderDialog 、およびStandardPathsも参照してください 。

プロパティのドキュメント

acceptLabel : string

このプロパティには、ダイアログを閉じるボタンに表示されるラベルテキストが格納されます。

空の文字列に設定された場合、基盤となるプラットフォームのデフォルトのラベルが使用されます。デフォルトのラベルは、通常、ダイアログが使用されるfileMode によって、「Open 」または「Save 」のいずれかになります。

デフォルト値は空の文字列です。

rejectLabelも参照してください 。

currentFile : url

このプロパティには、ダイアログで現在選択されているファイルが格納されます。

file プロパティとは異なり、currentFile プロパティは、ユーザーがダイアログでファイルを選択している間、最終的な選択が行われる前であっても更新されます。

「 file 」および「currentFiles 」も参照してください 。

currentFiles : list<url>

このプロパティには、ダイアログで現在選択されているファイルが格納されます。

files プロパティとは異なり、currentFiles プロパティは、ユーザーがダイアログでファイルを選択している間、最終的な選択が行われる前であっても更新されます。

「 files 」および「currentFile 」も参照してください 。

defaultSuffix : string

このプロパティには、拡張子が指定されていない選択されたファイルに追加される拡張子が設定されます。この拡張子は通常、ファイルの種類を示すために使用されます（例：「txt」はテキストファイルを示します）。

最初の文字がドット（'.'）の場合は、それが削除されます。

file : url

このプロパティには、最終的に受け入れられたファイルが格納されます。

currentFile プロパティとは異なり、file プロパティは、ユーザーがダイアログでファイルを選択している間は更新されず、最終的な選択が完了した後にのみ更新されます。つまり、ユーザーが「OK 」をクリックしてファイルを受け入れたときです。あるいは、accepted()シグナルをハンドルすることで、最終的な選択を取得することもできます。

currentFile およびaccepted()も参照してください 。

fileMode : enumeration

このプロパティは、ダイアログのモードを保持します。

使用可能な値：

files : list<url>

このプロパティには、最終的に受け入れられたファイルが格納されます。

currentFiles プロパティとは異なり、files プロパティは、ユーザーがダイアログでファイルを選択している間は更新されず、最終的な選択が完了した後にのみ更新されます。つまり、ユーザーが「OK 」をクリックしてファイルを受け入れた時点です。あるいは、accepted()シグナルをハンドルすることで、最終的な選択内容を取得することもできます。

currentFiles およびaccepted()も参照してください 。

folder : url

このプロパティは、ファイルが選択されるフォルダを保持します。フォルダを選択するには、代わりに FolderDialog を使用してください。

「FolderDialog」も参照してください 。

nameFilters : list<string>

このプロパティには、選択可能なファイルの種類を制限するフィルタが格納されます。

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

selectedNameFilterも参照してください 。

options : flags

このプロパティには、ダイアログの外観や動作に影響を与えるさまざまなオプションが格納されています。

デフォルトでは、すべてのオプションは無効になっています。

オプションは、ダイアログを表示する前に設定する必要があります。ダイアログが表示されている間に設定しても、ダイアログに即座に反映されるとは限りません（オプションやプラットフォームによって異なります）。

利用可能なオプション：

rejectLabel : string

このプロパティには、ダイアログを閉じるボタンに表示されるラベルテキストが格納されます。

空の文字列に設定すると、基盤となるプラットフォームのデフォルトのラベルが使用されます。デフォルトのラベルは通常、「Cancel 」です。

デフォルト値は空の文字列です。

「acceptLabel」も参照してください 。

selectedNameFilter group

これらのプロパティには、現在選択されている名前フィルターが格納されています。

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

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

nameFiltersも参照してください 。