diff options
| author | Mitch Curtis <mitch.curtis@qt.io> | 2022-08-23 17:22:09 +0800 |
|---|---|---|
| committer | Mitch Curtis <mitch.curtis@qt.io> | 2022-08-26 19:36:54 +0800 |
| commit | 25bd3b526c6b78694422d0ebcb6052996dd68f2c (patch) | |
| tree | f48b8d9afed9fec3a53ce1a68c33d8b9f919f422 | |
| parent | af34e238b8bb572097a99b45b8522b120fd102ea (diff) | |
Doc: fix and improve FileDialog example snippet
Replace it with a self-contained example that can be copy-pasted and
run, and that is easier to understand.
Pick-to: 6.3 6.4
Change-Id: I54b67b0173d25aee509318ff842bb895c7244a48
Reviewed-by: Shawn Rutledge <shawn.rutledge@qt.io>
3 files changed, 37 insertions, 17 deletions
diff --git a/src/quickdialogs2/quickdialogs2/doc/qtquickdialogs.qdocconf b/src/quickdialogs2/quickdialogs2/doc/qtquickdialogs.qdocconf index 6d59f69817..d4f7595f0f 100644 --- a/src/quickdialogs2/quickdialogs2/doc/qtquickdialogs.qdocconf +++ b/src/quickdialogs2/quickdialogs2/doc/qtquickdialogs.qdocconf @@ -24,6 +24,8 @@ depends = qtcore qtqmlcore qtgui qtdoc qtqml qtquick qtquickcontrols qtlabsplatf # This module has no documented C++ types, clear the module header moduleheader = +exampledirs += snippets + headerdirs += .. sourcedirs += .. \ src diff --git a/src/quickdialogs2/quickdialogs2/doc/snippets/qtquickdialogs-filedialog.qml b/src/quickdialogs2/quickdialogs2/doc/snippets/qtquickdialogs-filedialog.qml new file mode 100644 index 0000000000..ab3f33f910 --- /dev/null +++ b/src/quickdialogs2/quickdialogs2/doc/snippets/qtquickdialogs-filedialog.qml @@ -0,0 +1,34 @@ +// Copyright (C) 2022 The Qt Company Ltd. +// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only + +//! [file] +import QtCore +import QtQuick +import QtQuick.Controls +import QtQuick.Dialogs + +ApplicationWindow { + width: 640 + height: 480 + visible: true + + header: ToolBar { + Button { + text: qsTr("Choose Image...") + onClicked: fileDialog.open() + } + } + + Image { + id: image + anchors.fill: parent + fillMode: Image.PreserveAspectFit + } + + FileDialog { + id: fileDialog + currentFolder: StandardPaths.standardLocations(StandardPaths.PicturesLocation)[0] + onAccepted: image.source = selectedFile + } +} +//! [file] diff --git a/src/quickdialogs2/quickdialogs2/qquickfiledialog.cpp b/src/quickdialogs2/quickdialogs2/qquickfiledialog.cpp index 4caaec96cf..f46a2bc7d9 100644 --- a/src/quickdialogs2/quickdialogs2/qquickfiledialog.cpp +++ b/src/quickdialogs2/quickdialogs2/qquickfiledialog.cpp @@ -36,23 +36,7 @@ Q_LOGGING_CATEGORY(lcFileDialog, "qt.quick.dialogs.filedialog") properties are updated only after the final selection has been made by accepting the dialog. - \code - MenuItem { - text: "Open..." - onTriggered: fileDialog.open() - } - - FileDialog { - id: fileDialog - currentFile: document.source - folder: StandardPaths.writableLocation(StandardPaths.DocumentsLocation) - } - - MyDocument { - id: document - source: fileDialog.file - } - \endcode + \snippet qtquickdialogs-filedialog.qml file \section2 Availability |