FolderListModel QML Type

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.

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

import QtQuick
import Qt.labs.folderlistmodel

ListView {
    width: 200; height: 400

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

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

    model: folderModel
    delegate: fileDelegate
}

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

Use case sensitive pattern matching.

By default, this property is true.

This property was introduced in Qt 5.7.

Returns the number of items in the current folder that match the filter criteria.

The folder property holds a URL for the folder that the model currently provides.

The value must be a file: or qrc: URL, or a relative URL.

The default value is an invalid URL.

The nameFilters property contains a list of file name filters. The filters may include the ? and * wildcards.

The example below filters on PNG and JPEG files:

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

Returns the URL of the parent of the current folder.

When this property is set, the given folder will be treated as the root in the file system, so that you can only traverse subfolders within it.

If true, directories are included in the model; otherwise only files are included.

By default, this property is true.

Note that the nameFilters are not applied to directories.

See Also▲

If true, if directories are included in the model they will always be shown first, then the files.

By default, this property is false.

If true, the "." and ".." directories are included in the model; otherwise they are excluded.

By default, this property is false.

See Also▲

If true, files are included in the model; otherwise only directories are included.

By default, this property is true.

This property was introduced in Qt 5.2.

See Also▲

If true, hidden files and directories are included in the model; otherwise they are excluded.

By default, this property is false.

This property was introduced in Qt 5.2.

If true, only readable files and directories are shown; otherwise all files and directories are shown.

By default, this property is false.

See Also▲

If set to true, the sort is case sensitive. This property is true by default.

This property was introduced in Qt 5.12.

The sortField property contains field to use for sorting. sortField may be one of:

• Unsorted - no sorting is applied.

• Name - sort by filename

• Time - sort by time modified

• Size - sort by file size

• Type - sort by file type (extension)

See Also▲

If set to true, reverses the sort order. The default is false.

See Also▲

This property holds the status of folder reading. It can be one of:

• FolderListModel.Null - no folder has been set

• FolderListModel.Ready - the folder has been loaded

• FolderListModel.Loading - the folder is currently being loaded

Use this status to provide an update or respond to the status change in some way. For example, you could:

• Trigger a state change:

   

  Sélectionnez

  State { name: 'loaded'; when: folderModel.status == FolderListModel.Ready }

• Implement an onStatusChanged signal handler:

   

  Sélectionnez

  FolderListModel {
      id: folderModel
      onStatusChanged: if (folderModel.status == FolderListModel.Ready) console.log('Loaded')
  }

• Bind to the status value:

   

  Sélectionnez

  Text { text: folderModel.status == FolderListModel.Ready ? 'Loaded' : 'Not loaded' }

This property was introduced in Qt 5.11.

Returns the folder property for the given index. The following properties are available:

• fileName

• filePath

• fileURL (since Qt 5.2; deprecated since Qt 5.15)

• fileUrl (since Qt 5.15)

• fileBaseName

• fileSuffix

• fileSize

• fileModified

• fileAccessed

• fileIsDir

Returns the index of the given file URL if the model contains it, or -1 if not.

This method was introduced in Qt 5.6.

Returns true if the entry index is a folder; otherwise returns false.