QGCFileDialog.qml

Go to the documentation of this file.

import QtQuick
import QtQuick.Controls
import QtQuick.Dialogs
import QtQuick.Layouts
import Qt.labs.platform as Labs
 
import QGroundControl
import QGroundControl.Controls
 
/// This control is meant to be a direct replacement for the standard Qml FileDialog control.
/// It differs for mobile builds which uses a completely custom file picker.
Item {
    id:         _root
    visible:    false
 
    property string folder              // Due to Qt bug with file url parsing this must be an absolute path
    property var    nameFilters:    []  // Important: Only name filters with simple wildcarding like *.foo are supported.
    property string title
    property bool   selectFolder:   false
    property string defaultSuffix:  ""
 
    signal acceptedForLoad(string file)
    signal acceptedForSave(string file)
    signal rejected
    signal fileImportedNotify           // Emitted on a successful import so the open dialog can refresh its list.
 
    function openForLoad() {
        _openForLoad = true
        if (QGCFileDialogController.testHookArmed()) {
            // Unit test shim: bypass the native dialog and produce the armed result
            var testFile = QGCFileDialogController.takeTestNextFile()
            if (testFile.length === 0) {
                _root.rejected()
            } else {
                _root.acceptedForLoad(testFile)
            }
        } else if (_mobileDlg && folder.length !== 0) {
            mobileFileOpenDialogFactory.open()
        } else if (selectFolder) {
            fullFolderDialog.open()
        } else {
            fullFileDialog.fileMode = FileDialog.OpenFile
            fullFileDialog.open()
        }
    }
 
    function openForSave() {
        _openForLoad = false
        if (QGCFileDialogController.testHookArmed()) {
            // Unit test shim: bypass the native dialog and produce the armed result
            var testFile = QGCFileDialogController.takeTestNextFile()
            if (testFile.length === 0) {
                _root.rejected()
            } else {
                _root.acceptedForSave(testFile)
            }
        } else if (_mobileDlg && folder.length !== 0) {
            mobileFileSaveDialogFactory.open()
        } else {
            fullFileDialog.fileMode = FileDialog.SaveFile
            fullFileDialog.open()
        }
    }
 
    function close() {
        fullFileDialog.close()
    }
 
    property bool   _openForLoad:   true
    property real   _margins:       ScreenTools.defaultFontPixelHeight / 2
    property bool   _mobileDlg:     QGroundControl.corePlugin.options.useMobileFileDialog
    property var    _rgExtensions
    property string _mobileShortPath
    property bool   _importPending: false
 
    Component.onCompleted: {
        _setupFileExtensions()
        _updateMobileShortPath()
    }
 
    onFolderChanged:        _updateMobileShortPath()
    onNameFiltersChanged:   _setupFileExtensions()
 
    function _updateMobileShortPath() {
        if (ScreenTools.isMobile) {
            _mobileShortPath = QGCFileDialogController.fullFolderPathToShortMobilePath(folder);
        }
    }
 
    function _setupFileExtensions() {
        _rgExtensions = [ ]
        for (var i=0; i<_root.nameFilters.length; i++) {
            var filter = _root.nameFilters[i]
            var regExp = /^.*\‍((.*)\‍)$/
            var result = regExp.exec(filter)
            if (result.length === 2) {
                filter = result[1]
            }
            var rgFilters = filter.split(" ")
            for (var j=0; j<rgFilters.length; j++) {
                if (!_mobileDlg || (rgFilters[j] !== "*" && rgFilters[j] !== "*.*")) {
                    _rgExtensions.push(rgFilters[j])
                }
            }
        }
    }
 
    QGCPalette { id: qgcPal; colorGroupEnabled: true }
 
    Connections {
        target: QGCFileDialogController
        enabled: Qt.platform.os === "android" && _root._importPending
 
        function onFileImported() {
            _root._importPending = false
            _root.fileImportedNotify()
        }
 
        function onImportFailed(errorMessage) {
            _root._importPending = false
            QGroundControl.showMessageDialog(_root, qsTr("Import"), errorMessage)
        }
    }
 
    FileDialog {
        id:             fullFileDialog
        currentFolder:  "file:///" + _root.folder
        nameFilters:    _root.nameFilters ? _root.nameFilters : []
        title:          _root.title
        defaultSuffix:  _root.defaultSuffix
 
        onAccepted: {
            var fullPath = QGCFileDialogController.urlToLocalFile(selectedFile)
            if (fileMode == FileDialog.OpenFile) {
                _root.acceptedForLoad(fullPath)
            } else {
                _root.acceptedForSave(fullPath)
            }
        }
        onRejected: _root.rejected()
    }
 
    Labs.FolderDialog {
        id:             fullFolderDialog
        currentFolder:  "file:///" + _root.folder
        title:          _root.title
 
        onAccepted: _root.acceptedForLoad(QGCFileDialogController.urlToLocalFile(folder))
        onRejected: _root.rejected()
    }
 
    QGCPopupDialogFactory {
        id: mobileFileOpenDialogFactory
 
        dialogComponent: mobileFileOpenDialogComponent
    }
 
    Component {
        id: mobileFileOpenDialogComponent
 
        QGCPopupDialog {
            id:         mobileFileOpenDialog
            title:      _root.title
            buttons:    Dialog.Cancel
 
            Connections {
                target: _root
                function onFileImportedNotify() {
                    fileRepeater.model = QGCFileDialogController.getFiles(folder, _rgExtensions)
                }
            }
 
            Column {
                id:         fileOpenColumn
                width:      40 * ScreenTools.defaultFontPixelWidth
                spacing:    ScreenTools.defaultFontPixelHeight / 2
 
                QGCLabel { text: qsTr("Path: %1").arg(_mobileShortPath) }
 
                Repeater {
                    id:     fileRepeater
                    model:  QGCFileDialogController.getFiles(folder, _rgExtensions)
 
                    FileButton {
                        id:             fileButton
                        anchors.left:   parent.left
                        anchors.right:  parent.right
                        text:           modelData
 
                        onClicked: {
                            mobileFileOpenDialog.close()
                            _root.acceptedForLoad(QGCFileDialogController.fullyQualifiedFilename(folder, modelData))
                        }
 
                        onHamburgerClicked: {
                            highlight = true
                            hamburgerMenu.fileToDelete = QGCFileDialogController.fullyQualifiedFilename(folder, modelData)
                            hamburgerMenu.popup()
                        }
 
                        QGCMenu {
                            id: hamburgerMenu
 
                            property string fileToDelete
 
                            onAboutToHide: fileButton.highlight = false
 
                            QGCMenuItem {
                                text:           qsTr("Delete")
                                onTriggered: {
                                    QGCFileDialogController.deleteFile(hamburgerMenu.fileToDelete)
                                    fileRepeater.model = QGCFileDialogController.getFiles(folder, _rgExtensions)
                                }
                            }
                        }
                    }
                }
 
                QGCLabel {
                    text:       qsTr("No files")
                    visible:    fileRepeater.model.length === 0
                }
 
                QGCButton {
                    anchors.left:   parent.left
                    anchors.right:  parent.right
                    text:           qsTr("Import")
                    visible:        Qt.platform.os === "android"
 
                    onClicked: {
                        _root._importPending = true
                        QGCFileDialogController.importFromNativePicker()
                    }
                }
            }
        }
    }
 
    QGCPopupDialogFactory {
        id: mobileFileSaveDialogFactory
 
        dialogComponent: mobileFileSaveDialogComponent
    }
 
    Component {
        id: mobileFileSaveDialogComponent
 
        QGCPopupDialog {
            id:         mobileFileSaveDialog
            title:      _root.title
            buttons:    Dialog.Cancel | Dialog.Ok
 
            onAccepted: {
                if (filenameTextField.text == "") {
                    mobileFileSaveDialog.preventClose = true
                    return
                }
                if (!replaceMessage.visible) {
                    if (QGCFileDialogController.fileExists(QGCFileDialogController.fullyQualifiedFilename(folder, filenameTextField.text, _rgExtensions))) {
                        replaceMessage.visible = true
                        mobileFileSaveDialog.preventClose = true
                        return
                    }
                }
                _root.acceptedForSave(QGCFileDialogController.fullyQualifiedFilename(folder, filenameTextField.text, _rgExtensions))
            }
 
            Column {
                id:         fileSaveColumn
                width:      40 * ScreenTools.defaultFontPixelWidth
                spacing:    ScreenTools.defaultFontPixelHeight / 2
 
                RowLayout {
                    anchors.left:   parent.left
                    anchors.right:  parent.right
                    spacing:        ScreenTools.defaultFontPixelWidth
 
                    QGCLabel { text: qsTr("New file name:") }
 
                    QGCTextField {
                        id:                 filenameTextField
                        Layout.fillWidth:   true
                        onTextChanged:      replaceMessage.visible = false
                    }
                }
 
                QGCLabel {
                    id:             replaceMessage
                    anchors.left:   parent.left
                    anchors.right:  parent.right
                    wrapMode:       Text.WordWrap
                    text:           qsTr("The file %1 exists. Click Save again to replace it.").arg(filenameTextField.text)
                    visible:        false
                    color:          qgcPal.warningText
                }
 
                SectionHeader {
                    anchors.left:   parent.left
                    anchors.right:  parent.right
                    text:           qsTr("Save to existing file:")
                }
 
                Repeater {
                    id:     fileRepeater
                    model:  QGCFileDialogController.getFiles(folder, [ _rgExtensions ])
 
                    FileButton {
                        id:             fileButton
                        anchors.left:   parent.left
                        anchors.right:  parent.right
                        text:           modelData
 
                        onClicked: {
                            mobileFileSaveDialog.close()
                            _root.acceptedForSave(QGCFileDialogController.fullyQualifiedFilename(folder, modelData))
                        }
 
                        onHamburgerClicked: {
                            highlight = true
                            hamburgerMenu.fileToDelete = QGCFileDialogController.fullyQualifiedFilename(folder, modelData)
                            hamburgerMenu.popup()
                        }
 
                        QGCMenu {
                            id: hamburgerMenu
 
                            property string fileToDelete
 
                            onAboutToHide: fileButton.highlight = false
 
                            QGCMenuItem {
                                text:           qsTr("Delete")
                                onTriggered: {
                                    QGCFileDialogController.deleteFile(hamburgerMenu.fileToDelete)
                                    fileRepeater.model = QGCFileDialogController.getFiles(folder, [ _rgExtensions ])
                                }
                            }
                        }
                    }
                }
            }
        }
    }
}