DocumentDialog QML Type

(BETA) Provides access to documents external to your app. More...

• List of all members, including inherited members

Properties

• defaultSuffix : string
• error : object
• fileUrl : url
• fileUrls : object
• folder : url
• modality : int
• nameFilters : QStringList
• selectExisting : bool
• selectFolder : bool
• selectMultiple : bool
• selectedNameFilter : string
• shortcuts : var
• sidebarVisible : bool
• title : string

Signals

• accepted()
• rejected()

Methods

• object close()
• object open()

Detailed Description

The DocumentDialog component is used to access documents external to your app, of any filetype. This component doesn't facilitate interaction with these files; this needs to be provided by other components.

On Android, the External Storage capability must be enabled in the Capabilities tab of the Settings tool to use this component in an app. You also need to use a PermissionDialog pop-up before invoking the document dialog. The app will crash if this capability is not enabled.

Only files available on the device's local storage can be accessed using DocumentDialog. Files stored in a cloud service will first need to be downloaded before using DocumentDialog to browse to and select them.

The following code sample demonstrates opening a document dialog to search through your device's files.

Item {

    property bool storagePermissionGranted

    Component.onCompleted: {
        // Check if storage permission is granted (this is only required for Android)
        storagePermissionGranted = Permission.checkPermission(Permission.PermissionTypeStorage) === Permission.PermissionResultGranted
    }

    PermissionDialog {
        id: permissionDialog
        openSettingsWhenDenied: true
        permission: PermissionDialog.PermissionDialogTypeStorage

        onAccepted: {
            doc.open()
            console.log("Permission accepted")
        }

        onRejected: {
            console.log("Permission rejected")
        }
    }

    Button {
        text: "Select document"
        onClicked: {
            if (doc.supported) {
                if (storagePermissionGranted) {
                    doc.open();
                } else {
                    permissionDialog.open();
                }
            } else {
                console.log("Not Supported");
            }
        }
    }

        DocumentDialog {
                id: doc

                onAccepted: {
                        console.log("selected file path " , fileUrl.filePath)
                }

                onRejected: {
                        if (status == DocumentDialog.DocumentDialogCancelledByUser) {
                                // Cancelled By User
                        }
                        if (status == DocumentDialog.DocumentDialogPermissionDenied) {
                                // Permission Denied
                        }
                        if (status == DocumentDialog.DocumentDialogNotSupported) {
                                // Not Supported
                        }
                        if (status == DocumentDialog.DocumentDialogFileReadError) {
                                // File Read Error
                        }
                }
        }
}

Property Documentation

Signal Documentation

Method Documentation