FolderListModel QML Type

The FolderListModel provides a model of the contents of a file system folder. More...

• List of all members, including inherited members

Properties

• count : int
• folder : string
• nameFilters : list<string>
• parentFolder : url
• rootFolder : url
• showDirs : bool
• showDirsFirst : bool
• showDotAndDotDot : bool
• showFiles : bool
• showHidden : bool
• showOnlyReadable : bool
• sortField : enumeration
• sortReversed : bool

Methods

• var get(int index, string property)
• bool isFolder(int index)

Detailed Description

FolderListModel provides access to information about the contents of a folder in the local file system, exposing a list of files to views and other data components.

Note: This type is made available by importing the Qt.labs.folderlistmodel module. Elements in the Qt.labs module are not guaranteed to remain compatible in future versions.

import Qt.labs.folderlistmodel 2.1

The folder property specifies the folder to access. Information about the files and directories in the folder is supplied via the model's interface. Components access names and paths via the following roles:

• fileName
• filePath
• fileURL (since Qt 5.2)
• fileBaseName
• fileSuffix
• fileSize
• fileModified
• fileAccessed
• fileIsDir

Additionally a file entry can be differentiated from a folder entry via the isFolder() method.

Filtering

Various properties can be set to filter the number of files and directories exposed by the model.

The nameFilters property can be set to contain a list of wildcard filters that are applied to names of files and directories, causing only those that match the filters to be exposed.

Directories can be included or excluded using the showDirs property, navigation directories can also be excluded by setting the showDotAndDotDot property to false, hidden files can be included or excluded using the showHidden property.

It is sometimes useful to limit the files and directories exposed to those that the user can access. The showOnlyReadable property can be set to enable this feature.

Example Usage

The following example shows a FolderListModel being used to provide a list of QML files in a ListView:

import QtQuick 2.0
import Qt.labs.folderlistmodel 2.1

ListView {
    width: 200; height: 400

    FolderListModel {
        id: folderModel
        nameFilters: ["*.qml"]
    }

    Component {
        id: fileDelegate
        Text { text: fileName }
    }

    model: folderModel
    delegate: fileDelegate
}

Path Separators

Qt uses "/" as a universal directory separator in the same way that "/" is used as a path separator in URLs. If you always use "/" as a directory separator, Qt will translate your paths to conform to the underlying operating system.

See also QML Data Models.

Property Documentation

FolderListModel {
    nameFilters: [ "*.png", "*.jpg" ]
}

Method Documentation