QDir类

ゝ一世哀愁。 2023-07-05 05:29 6阅读 0赞

# QDir Class #

The [QDir][] class provides access to directory structures and their contents. [More...][]

<table> 
 <tbody> 
 <tr> 
 <td>Header:</td> 
 <td>#include &lt;QDir&gt;</td> 
 </tr> 
 <tr> 
 <td>qmake:</td> 
 <td>QT += core</td> 
 </tr> 
 </tbody> 
</table>

*  [List of all members, including inherited members][List of all members_ including inherited members]
 *  [Obsolete members][]

**Note:** All functions in this class are [reentrant][].

## Public Types ##

<table> 
 <tbody> 
 <tr> 
 <td>enum</td> 
 <td><a href="https://doc.qt.io/archives/qt-5.13/qdir.html#Filter-enum" rel="nofollow">Filter</a>&nbsp;{ Dirs, AllDirs, Files, Drives, ..., CaseSensitive }</td> 
 </tr> 
 <tr> 
 <td>flags</td> 
 <td><a href="https://doc.qt.io/archives/qt-5.13/qdir.html#Filter-enum" rel="nofollow">Filters</a></td> 
 </tr> 
 <tr> 
 <td>enum</td> 
 <td><a href="https://doc.qt.io/archives/qt-5.13/qdir.html#SortFlag-enum" rel="nofollow">SortFlag</a>&nbsp;{ Name, Time, Size, Type, ..., LocaleAware }</td> 
 </tr> 
 <tr> 
 <td>flags</td> 
 <td><a href="https://doc.qt.io/archives/qt-5.13/qdir.html#SortFlag-enum" rel="nofollow">SortFlags</a></td> 
 </tr> 
 </tbody> 
</table>

## Public Functions ##

<table> 
 <tbody> 
 <tr> 
 <td>&nbsp;</td> 
 <td><a href="https://doc.qt.io/archives/qt-5.13/qdir.html#QDir-2" rel="nofollow">QDir</a>(const QString &amp;path, const QString &amp;nameFilter, QDir::SortFlags&nbsp;sort&nbsp;= SortFlags(Name | IgnoreCase), QDir::Filters&nbsp;filters&nbsp;= AllEntries)</td> 
 </tr> 
 <tr> 
 <td>&nbsp;</td> 
 <td><a href="https://doc.qt.io/archives/qt-5.13/qdir.html#QDir-1" rel="nofollow">QDir</a>(const QString &amp;path&nbsp;= QString())</td> 
 </tr> 
 <tr> 
 <td>&nbsp;</td> 
 <td><a href="https://doc.qt.io/archives/qt-5.13/qdir.html#QDir" rel="nofollow">QDir</a>(const QDir &amp;dir)</td> 
 </tr> 
 <tr> 
 <td>QDir &amp;</td> 
 <td><a href="https://doc.qt.io/archives/qt-5.13/qdir.html#operator-eq-2" rel="nofollow">operator=</a>(QDir &amp;&amp;other)</td> 
 </tr> 
 <tr> 
 <td>QDir &amp;</td> 
 <td><a href="https://doc.qt.io/archives/qt-5.13/qdir.html#operator-eq" rel="nofollow">operator=</a>(const QDir &amp;dir)</td> 
 </tr> 
 <tr> 
 <td>&nbsp;</td> 
 <td><a href="https://doc.qt.io/archives/qt-5.13/qdir.html#dtor.QDir" rel="nofollow">~QDir</a>()</td> 
 </tr> 
 <tr> 
 <td>QString</td> 
 <td><a href="https://doc.qt.io/archives/qt-5.13/qdir.html#absoluteFilePath" rel="nofollow">absoluteFilePath</a>(const QString &amp;fileName) const</td> 
 </tr> 
 <tr> 
 <td>QString</td> 
 <td><a href="https://doc.qt.io/archives/qt-5.13/qdir.html#absolutePath" rel="nofollow">absolutePath</a>() const</td> 
 </tr> 
 <tr> 
 <td>QString</td> 
 <td><a href="https://doc.qt.io/archives/qt-5.13/qdir.html#canonicalPath" rel="nofollow">canonicalPath</a>() const</td> 
 </tr> 
 <tr> 
 <td>bool</td> 
 <td><a href="https://doc.qt.io/archives/qt-5.13/qdir.html#cd" rel="nofollow">cd</a>(const QString &amp;dirName)</td> 
 </tr> 
 <tr> 
 <td>bool</td> 
 <td><a href="https://doc.qt.io/archives/qt-5.13/qdir.html#cdUp" rel="nofollow">cdUp</a>()</td> 
 </tr> 
 <tr> 
 <td>uint</td> 
 <td><a href="https://doc.qt.io/archives/qt-5.13/qdir.html#count" rel="nofollow">count</a>() const</td> 
 </tr> 
 <tr> 
 <td>QString</td> 
 <td><a href="https://doc.qt.io/archives/qt-5.13/qdir.html#dirName" rel="nofollow">dirName</a>() const</td> 
 </tr> 
 <tr> 
 <td>QFileInfoList</td> 
 <td><a href="https://doc.qt.io/archives/qt-5.13/qdir.html#entryInfoList" rel="nofollow">entryInfoList</a>(const QStringList &amp;nameFilters, QDir::Filters&nbsp;filters&nbsp;= NoFilter, QDir::SortFlags&nbsp;sort&nbsp;= NoSort) const</td> 
 </tr> 
 <tr> 
 <td>QFileInfoList</td> 
 <td><a href="https://doc.qt.io/archives/qt-5.13/qdir.html#entryInfoList-1" rel="nofollow">entryInfoList</a>(QDir::Filters&nbsp;filters&nbsp;= NoFilter, QDir::SortFlags&nbsp;sort&nbsp;= NoSort) const</td> 
 </tr> 
 <tr> 
 <td>QStringList</td> 
 <td><a href="https://doc.qt.io/archives/qt-5.13/qdir.html#entryList" rel="nofollow">entryList</a>(const QStringList &amp;nameFilters, QDir::Filters&nbsp;filters&nbsp;= NoFilter, QDir::SortFlags&nbsp;sort&nbsp;= NoSort) const</td> 
 </tr> 
 <tr> 
 <td>QStringList</td> 
 <td><a href="https://doc.qt.io/archives/qt-5.13/qdir.html#entryList-1" rel="nofollow">entryList</a>(QDir::Filters&nbsp;filters&nbsp;= NoFilter, QDir::SortFlags&nbsp;sort&nbsp;= NoSort) const</td> 
 </tr> 
 <tr> 
 <td>bool</td> 
 <td><a href="https://doc.qt.io/archives/qt-5.13/qdir.html#exists" rel="nofollow">exists</a>(const QString &amp;name) const</td> 
 </tr> 
 <tr> 
 <td>bool</td> 
 <td><a href="https://doc.qt.io/archives/qt-5.13/qdir.html#exists-1" rel="nofollow">exists</a>() const</td> 
 </tr> 
 <tr> 
 <td>QString</td> 
 <td><a href="https://doc.qt.io/archives/qt-5.13/qdir.html#filePath" rel="nofollow">filePath</a>(const QString &amp;fileName) const</td> 
 </tr> 
 <tr> 
 <td>QDir::Filters</td> 
 <td><a href="https://doc.qt.io/archives/qt-5.13/qdir.html#filter" rel="nofollow">filter</a>() const</td> 
 </tr> 
 <tr> 
 <td>bool</td> 
 <td><a href="https://doc.qt.io/archives/qt-5.13/qdir.html#isAbsolute" rel="nofollow">isAbsolute</a>() const</td> 
 </tr> 
 <tr> 
 <td>bool</td> 
 <td><a href="https://doc.qt.io/archives/qt-5.13/qdir.html#isEmpty" rel="nofollow">isEmpty</a>(QDir::Filters&nbsp;filters&nbsp;= Filters(AllEntries | NoDotAndDotDot)) const</td> 
 </tr> 
 <tr> 
 <td>bool</td> 
 <td><a href="https://doc.qt.io/archives/qt-5.13/qdir.html#isReadable" rel="nofollow">isReadable</a>() const</td> 
 </tr> 
 <tr> 
 <td>bool</td> 
 <td><a href="https://doc.qt.io/archives/qt-5.13/qdir.html#isRelative" rel="nofollow">isRelative</a>() const</td> 
 </tr> 
 <tr> 
 <td>bool</td> 
 <td><a href="https://doc.qt.io/archives/qt-5.13/qdir.html#isRoot" rel="nofollow">isRoot</a>() const</td> 
 </tr> 
 <tr> 
 <td>bool</td> 
 <td><a href="https://doc.qt.io/archives/qt-5.13/qdir.html#makeAbsolute" rel="nofollow">makeAbsolute</a>()</td> 
 </tr> 
 <tr> 
 <td>bool</td> 
 <td><a href="https://doc.qt.io/archives/qt-5.13/qdir.html#mkdir" rel="nofollow">mkdir</a>(const QString &amp;dirName) const</td> 
 </tr> 
 <tr> 
 <td>bool</td> 
 <td><a href="https://doc.qt.io/archives/qt-5.13/qdir.html#mkpath" rel="nofollow">mkpath</a>(const QString &amp;dirPath) const</td> 
 </tr> 
 <tr> 
 <td>QStringList</td> 
 <td><a href="https://doc.qt.io/archives/qt-5.13/qdir.html#nameFilters" rel="nofollow">nameFilters</a>() const</td> 
 </tr> 
 <tr> 
 <td>QString</td> 
 <td><a href="https://doc.qt.io/archives/qt-5.13/qdir.html#path" rel="nofollow">path</a>() const</td> 
 </tr> 
 <tr> 
 <td>void</td> 
 <td><a href="https://doc.qt.io/archives/qt-5.13/qdir.html#refresh" rel="nofollow">refresh</a>() const</td> 
 </tr> 
 <tr> 
 <td>QString</td> 
 <td><a href="https://doc.qt.io/archives/qt-5.13/qdir.html#relativeFilePath" rel="nofollow">relativeFilePath</a>(const QString &amp;fileName) const</td> 
 </tr> 
 <tr> 
 <td>bool</td> 
 <td><a href="https://doc.qt.io/archives/qt-5.13/qdir.html#remove" rel="nofollow">remove</a>(const QString &amp;fileName)</td> 
 </tr> 
 <tr> 
 <td>bool</td> 
 <td><a href="https://doc.qt.io/archives/qt-5.13/qdir.html#removeRecursively" rel="nofollow">removeRecursively</a>()</td> 
 </tr> 
 <tr> 
 <td>bool</td> 
 <td><a href="https://doc.qt.io/archives/qt-5.13/qdir.html#rename" rel="nofollow">rename</a>(const QString &amp;oldName, const QString &amp;newName)</td> 
 </tr> 
 <tr> 
 <td>bool</td> 
 <td><a href="https://doc.qt.io/archives/qt-5.13/qdir.html#rmdir" rel="nofollow">rmdir</a>(const QString &amp;dirName) const</td> 
 </tr> 
 <tr> 
 <td>bool</td> 
 <td><a href="https://doc.qt.io/archives/qt-5.13/qdir.html#rmpath" rel="nofollow">rmpath</a>(const QString &amp;dirPath) const</td> 
 </tr> 
 <tr> 
 <td>void</td> 
 <td><a href="https://doc.qt.io/archives/qt-5.13/qdir.html#setFilter" rel="nofollow">setFilter</a>(QDir::Filters&nbsp;filters)</td> 
 </tr> 
 <tr> 
 <td>void</td> 
 <td><a href="https://doc.qt.io/archives/qt-5.13/qdir.html#setNameFilters" rel="nofollow">setNameFilters</a>(const QStringList &amp;nameFilters)</td> 
 </tr> 
 <tr> 
 <td>void</td> 
 <td><a href="https://doc.qt.io/archives/qt-5.13/qdir.html#setPath" rel="nofollow">setPath</a>(const QString &amp;path)</td> 
 </tr> 
 <tr> 
 <td>void</td> 
 <td><a href="https://doc.qt.io/archives/qt-5.13/qdir.html#setSorting" rel="nofollow">setSorting</a>(QDir::SortFlags&nbsp;sort)</td> 
 </tr> 
 <tr> 
 <td>QDir::SortFlags</td> 
 <td><a href="https://doc.qt.io/archives/qt-5.13/qdir.html#sorting" rel="nofollow">sorting</a>() const</td> 
 </tr> 
 <tr> 
 <td>void</td> 
 <td><a href="https://doc.qt.io/archives/qt-5.13/qdir.html#swap" rel="nofollow">swap</a>(QDir &amp;other)</td> 
 </tr> 
 <tr> 
 <td>bool</td> 
 <td><a href="https://doc.qt.io/archives/qt-5.13/qdir.html#operator-not-eq" rel="nofollow">operator!=</a>(const QDir &amp;dir) const</td> 
 </tr> 
 <tr> 
 <td>bool</td> 
 <td><a href="https://doc.qt.io/archives/qt-5.13/qdir.html#operator-eq-eq" rel="nofollow">operator==</a>(const QDir &amp;dir) const</td> 
 </tr> 
 <tr> 
 <td>QString</td> 
 <td><a href="https://doc.qt.io/archives/qt-5.13/qdir.html#operator-5b-5d" rel="nofollow">operator[]</a>(int&nbsp;pos) const</td> 
 </tr> 
 </tbody> 
</table>

## Static Public Members ##

<table> 
 <tbody> 
 <tr> 
 <td>void</td> 
 <td><a href="https://doc.qt.io/archives/qt-5.13/qdir.html#addSearchPath" rel="nofollow">addSearchPath</a>(const QString &amp;prefix, const QString &amp;path)</td> 
 </tr> 
 <tr> 
 <td>QString</td> 
 <td><a href="https://doc.qt.io/archives/qt-5.13/qdir.html#cleanPath" rel="nofollow">cleanPath</a>(const QString &amp;path)</td> 
 </tr> 
 <tr> 
 <td>QDir</td> 
 <td><a href="https://doc.qt.io/archives/qt-5.13/qdir.html#current" rel="nofollow">current</a>()</td> 
 </tr> 
 <tr> 
 <td>QString</td> 
 <td><a href="https://doc.qt.io/archives/qt-5.13/qdir.html#currentPath" rel="nofollow">currentPath</a>()</td> 
 </tr> 
 <tr> 
 <td>QFileInfoList</td> 
 <td><a href="https://doc.qt.io/archives/qt-5.13/qdir.html#drives" rel="nofollow">drives</a>()</td> 
 </tr> 
 <tr> 
 <td>QString</td> 
 <td><a href="https://doc.qt.io/archives/qt-5.13/qdir.html#fromNativeSeparators" rel="nofollow">fromNativeSeparators</a>(const QString &amp;pathName)</td> 
 </tr> 
 <tr> 
 <td>QDir</td> 
 <td><a href="https://doc.qt.io/archives/qt-5.13/qdir.html#home" rel="nofollow">home</a>()</td> 
 </tr> 
 <tr> 
 <td>QString</td> 
 <td><a href="https://doc.qt.io/archives/qt-5.13/qdir.html#homePath" rel="nofollow">homePath</a>()</td> 
 </tr> 
 <tr> 
 <td>bool</td> 
 <td><a href="https://doc.qt.io/archives/qt-5.13/qdir.html#isAbsolutePath" rel="nofollow">isAbsolutePath</a>(const QString &amp;path)</td> 
 </tr> 
 <tr> 
 <td>bool</td> 
 <td><a href="https://doc.qt.io/archives/qt-5.13/qdir.html#isRelativePath" rel="nofollow">isRelativePath</a>(const QString &amp;path)</td> 
 </tr> 
 <tr> 
 <td>QChar</td> 
 <td><a href="https://doc.qt.io/archives/qt-5.13/qdir.html#listSeparator" rel="nofollow">listSeparator</a>()</td> 
 </tr> 
 <tr> 
 <td>bool</td> 
 <td><a href="https://doc.qt.io/archives/qt-5.13/qdir.html#match" rel="nofollow">match</a>(const QString &amp;filter, const QString &amp;fileName)</td> 
 </tr> 
 <tr> 
 <td>bool</td> 
 <td><a href="https://doc.qt.io/archives/qt-5.13/qdir.html#match-1" rel="nofollow">match</a>(const QStringList &amp;filters, const QString &amp;fileName)</td> 
 </tr> 
 <tr> 
 <td>QDir</td> 
 <td><a href="https://doc.qt.io/archives/qt-5.13/qdir.html#root" rel="nofollow">root</a>()</td> 
 </tr> 
 <tr> 
 <td>QString</td> 
 <td><a href="https://doc.qt.io/archives/qt-5.13/qdir.html#rootPath" rel="nofollow">rootPath</a>()</td> 
 </tr> 
 <tr> 
 <td>QStringList</td> 
 <td><a href="https://doc.qt.io/archives/qt-5.13/qdir.html#searchPaths" rel="nofollow">searchPaths</a>(const QString &amp;prefix)</td> 
 </tr> 
 <tr> 
 <td>QChar</td> 
 <td><a href="https://doc.qt.io/archives/qt-5.13/qdir.html#separator" rel="nofollow">separator</a>()</td> 
 </tr> 
 <tr> 
 <td>bool</td> 
 <td><a href="https://doc.qt.io/archives/qt-5.13/qdir.html#setCurrent" rel="nofollow">setCurrent</a>(const QString &amp;path)</td> 
 </tr> 
 <tr> 
 <td>void</td> 
 <td><a href="https://doc.qt.io/archives/qt-5.13/qdir.html#setSearchPaths" rel="nofollow">setSearchPaths</a>(const QString &amp;prefix, const QStringList &amp;searchPaths)</td> 
 </tr> 
 <tr> 
 <td>QDir</td> 
 <td><a href="https://doc.qt.io/archives/qt-5.13/qdir.html#temp" rel="nofollow">temp</a>()</td> 
 </tr> 
 <tr> 
 <td>QString</td> 
 <td><a href="https://doc.qt.io/archives/qt-5.13/qdir.html#tempPath" rel="nofollow">tempPath</a>()</td> 
 </tr> 
 <tr> 
 <td>QString</td> 
 <td><a href="https://doc.qt.io/archives/qt-5.13/qdir.html#toNativeSeparators" rel="nofollow">toNativeSeparators</a>(const QString &amp;pathName)</td> 
 </tr> 
 </tbody> 
</table>

## Macros ##

<table> 
 <tbody> 
 <tr> 
 <td>void</td> 
 <td><a href="https://doc.qt.io/archives/qt-5.13/qdir.html#Q_CLEANUP_RESOURCE" rel="nofollow">Q_CLEANUP_RESOURCE</a>(name)</td> 
 </tr> 
 <tr> 
 <td>void</td> 
 <td><a href="https://doc.qt.io/archives/qt-5.13/qdir.html#Q_INIT_RESOURCE" rel="nofollow">Q_INIT_RESOURCE</a>(name)</td> 
 </tr> 
 </tbody> 
</table>

## 详细说明 ##

一[的QDir][QDir]用来操作路径名称，关于路径和文件的访问信息和操作底层文件系统。它也可以用来访问Qt的[资源系统][Link 1]。

Qt使用“ /”作为通用目录分隔符，就像使用“ /”作为URL中的路径分隔符一样。如果您始终使用“ /”作为目录分隔符，则Qt将转换您的路径以符合基础操作系统。

甲[的QDir][QDir]可以指向使用相对或绝对路径的文件。绝对路径以目录分隔符（在Windows下可选地以驱动器规范开头）开头。相对文件名以目录名或文件名开头，并指定相对于当前目录的路径。

绝对路径的示例：

QDir("/home/user/Documents")
    QDir("C:/Documents and Settings")

在Windows上，上面的第二个示例`C:\Documents and Settings`在用于访问文件时将转换为。

相对路径的示例：

QDir("images/landscape.png")

您可以使用[isRelative][]（）或[isAbsolute][]（）函数来检查[QDir][]是使用相对还是绝对文件路径。调用[makeAbsolute][]（）将相对的[QDir][]转换为绝对的[QDir][]。

### 导航和目录操作 ###

可以使用[path][]（）函数获取目录的路径，并使用[setPath][]（）函数获取新路径。目录的绝对路径可通过调用[absolutePath][]（）找到。

使用[dirName][]（）函数可以找到目录的名称。这通常会返回绝对路径中的最后一个元素，该元素指定目录的位置。但是，它也可以返回“。” 如果[QDir][]代表当前目录。

QDir("Documents/Letters/Applications").dirName() // "Applications"
    QDir().dirName()                                 // "."

目录的路径也可以使用[cd][]（）和[cdUp][]（）函数进行更改，这两个函数的作用类似于熟悉的Shell命令。当使用现有目录的名称调用[cd][]（）时，[QDir][]对象将更改目录，使其代替该目录。所述[CDUP][cdUp]（）函数改变的目录[的QDir][QDir]对象，以便它是指它的父目录; 即cd（“ ..”）等效于[cdUp][]（）。

可以使用[mkdir][]（）创建目录，使用[rename][]（）[重命名目录][rename]，并使用[rmdir][]（）删除目录。

可以通过使用测试目录的存在下与一个给定的名称[存在][Link 2]（），和一个目录的属性可以与被测试[isReadable][]（），[isAbsolute][]（），[而isRelative][isRelative]（），和[isRoot][]（）。

在[刷新][Link 3]（）函数从磁盘重新读取目录中的数据。

### 文件和目录内容 ###

目录包含许多条目，代表文件，目录和符号链接。目录中的条目数由[count][]（）返回。可以使用[entryList][]（）获得目录中所有条目名称的字符串列表。如果需要有关每个条目的信息，请使用[entryInfoList][]（）获得[QFileInfo][]对象的列表。

可以使用[filePath][]（）和[absoluteFilePath][]（）构造目录中文件和目录的路径。的[文件路径][filePath]（）函数返回到指定的文件或目录相对于所述的路径的路径[的QDir][QDir]对象; [absoluteFilePath][]（）返回指定文件或目录的绝对路径。这些功能都不检查文件或目录的存在。他们只构造路径。

QDir directory("Documents/Letters");
    QString path = directory.filePath("contents.txt");
    QString absolutePath = directory.absoluteFilePath("contents.txt");

可以使用[remove][]（）函数[删除][remove]文件。目录不能以与文件相同的方式删除；使用[rmdir][]（）删除它们。

通过将过滤器应用于[QDir][]对象，可以减少由[entryList][]（）和[entryInfoList][]（）返回的条目数。您可以应用名称过滤器来指定带有文件名需要匹配的通配符的模式，用于选择条目属性并可以区分文件和目录的属性过滤器以及排序顺序。

名称过滤器是传递给[setNameFilters][]（）的字符串列表。属性过滤器由过滤器的按位或组合组成，这些在调用[setFilter][]（）时指定。排序顺序指定使用[setSorting][]（）具有一个按位或组合[SortFlags][]。

您可以使用[match][]（）函数测试文件名是否与过滤器[匹配][match]。

当调用[entryList][]（）和[entryInfoList][]（）时，也可以指定过滤器和排序顺序标志，以覆盖先前定义的行为。

### 当前目录和其他特殊路径 ###

提供了一些返回[QDir][]对象的静态函数来访问某些公共目录。这些还具有返回字符串的相应函数：

<table> 
 <thead> 
 <tr> 
 <th><a href="https://doc.qt.io/archives/qt-5.13/qdir.html" rel="nofollow">QDir</a></th> 
 <th><a href="https://doc.qt.io/archives/qt-5.13/qstring.html" rel="nofollow">QString</a></th> 
 <th>Return Value</th> 
 </tr> 
 </thead> 
 <tbody> 
 <tr> 
 <td><a href="https://doc.qt.io/archives/qt-5.13/qdir.html#current" rel="nofollow">current</a>()</td> 
 <td><a href="https://doc.qt.io/archives/qt-5.13/qdir.html#currentPath" rel="nofollow">currentPath</a>()</td> 
 <td>The application's working directory</td> 
 </tr> 
 <tr> 
 <td><a href="https://doc.qt.io/archives/qt-5.13/qdir.html#home" rel="nofollow">home</a>()</td> 
 <td><a href="https://doc.qt.io/archives/qt-5.13/qdir.html#homePath" rel="nofollow">homePath</a>()</td> 
 <td>The user's home directory</td> 
 </tr> 
 <tr> 
 <td><a href="https://doc.qt.io/archives/qt-5.13/qdir.html#root" rel="nofollow">root</a>()</td> 
 <td><a href="https://doc.qt.io/archives/qt-5.13/qdir.html#rootPath" rel="nofollow">rootPath</a>()</td> 
 <td>The root directory</td> 
 </tr> 
 <tr> 
 <td><a href="https://doc.qt.io/archives/qt-5.13/qdir.html#temp" rel="nofollow">temp</a>()</td> 
 <td><a href="https://doc.qt.io/archives/qt-5.13/qdir.html#tempPath" rel="nofollow">tempPath</a>()</td> 
 <td>The system's temporary directory</td> 
 </tr> 
 </tbody> 
</table>

该[的setCurrent][setCurrent]（）静态函数也可用于设置应用程序的工作目录。

如果要查找包含应用程序可执行文件的目录，请参见[QCoreApplication :: applicationDirPath][QCoreApplication _ applicationDirPath]（）。

所述[驱动器][Link 4]（）静态函数提供根目录的列表对包含文件系统的每个设备。在Unix系统上，这将返回一个包含单个根目录“ /”的列表。在Windows上，取决于用户系统的配置，该列表通常将包含`C:/`，并可能包含其他驱动器号，例如`D:/`。

### 路径操作和字符串 ###

包含“。”的路径 使用路径[canonicalPath][]（）将引用当前目录的元素，引用父目录的“ ..”元素和符号链接简化为规范形式。

也可以通过使用[cleanPath][]（）删除多余的“ /”和“ ..”元素来简化路径。

有时需要能够以本机表示形式显示用户平台的路径。静态的[toNativeSeparators][]（）函数返回指定路径的副本，在该副本中，每个目录分隔符都被基础操作系统的适当分隔符替换。

### 例子 ###

检查目录是否存在：

QDir dir("example");
    if (!dir.exists())
        qWarning("Cannot find the example directory");

(We could also use the static convenience function [QFile::exists][QFile_exists]().)

Traversing directories and reading a file:

QDir dir = QDir::root();                 // "/"
    if (!dir.cd("tmp")) {                    // "/tmp"
        qWarning("Cannot find the \"/tmp\" directory");
    } else {
        QFile file(dir.filePath("ex1.txt")); // "/tmp/ex1.txt"
        if (!file.open(QIODevice::ReadWrite))
            qWarning("Cannot create the file %s", file.name());
    }

A program that lists all the files in the current directory (excluding symbolic links), sorted by size, smallest first:

#include <QDir>
 #include <iostream>
 
 int main(int argc, char *argv[])
 {
 QCoreApplication app(argc, argv);
 QDir dir;
 dir.setFilter(QDir::Files | QDir::Hidden | QDir::NoSymLinks);
 dir.setSorting(QDir::Size | QDir::Reversed);
 
 QFileInfoList list = dir.entryInfoList();
 std::cout << " Bytes Filename" << std::endl;
 for (int i = 0; i < list.size(); ++i) {
 QFileInfo fileInfo = list.at(i);
 std::cout << qPrintable(QString("%1 %2").arg(fileInfo.size(), 10)
 .arg(fileInfo.fileName()));
 std::cout << std::endl;
 }
 return 0;
 }

**See also** [QFileInfo][], [QFile][], [QFileDialog][], [QCoreApplication::applicationDirPath][QCoreApplication _ applicationDirPath](), and [Find Files Example][].

## Member Type Documentation ##

### enum QDir::Filter   flags QDir::Filters ###

This enum describes the filtering options available to [QDir][]; e.g. for [entryList][]() and [entryInfoList][](). The filter value is specified by combining values from the following list using the bitwise OR operator:

<table> 
 <tbody> 
 <tr> 
 <th>Constant</th> 
 <th>Value</th> 
 <th>Description</th> 
 </tr> 
 <tr> 
 <td><code>QDir::Dirs</code></td> 
 <td><code>0x001</code></td> 
 <td>List directories that match the filters.</td> 
 </tr> 
 <tr> 
 <td><code>QDir::AllDirs</code></td> 
 <td><code>0x400</code></td> 
 <td>List all directories; i.e. don't apply the filters to directory names.</td> 
 </tr> 
 <tr> 
 <td><code>QDir::Files</code></td> 
 <td><code>0x002</code></td> 
 <td>List files.</td> 
 </tr> 
 <tr> 
 <td><code>QDir::Drives</code></td> 
 <td><code>0x004</code></td> 
 <td>List disk drives (ignored under Unix).</td> 
 </tr> 
 <tr> 
 <td><code>QDir::NoSymLinks</code></td> 
 <td><code>0x008</code></td> 
 <td>Do not list symbolic links (ignored by operating systems that don't support symbolic links).</td> 
 </tr> 
 <tr> 
 <td><code>QDir::NoDotAndDotDot</code></td> 
 <td><code>NoDot | NoDotDot</code></td> 
 <td>Do not list the special entries "." and "..".</td> 
 </tr> 
 <tr> 
 <td><code>QDir::NoDot</code></td> 
 <td><code>0x2000</code></td> 
 <td>Do not list the special entry ".".</td> 
 </tr> 
 <tr> 
 <td><code>QDir::NoDotDot</code></td> 
 <td><code>0x4000</code></td> 
 <td>Do not list the special entry "..".</td> 
 </tr> 
 <tr> 
 <td><code>QDir::AllEntries</code></td> 
 <td><code>Dirs | Files | Drives</code></td> 
 <td>List directories, files, drives and symlinks (this does not list broken symlinks unless you specify System).</td> 
 </tr> 
 <tr> 
 <td><code>QDir::Readable</code></td> 
 <td><code>0x010</code></td> 
 <td>List files for which the application has read access. The Readable value needs to be combined with Dirs or Files.</td> 
 </tr> 
 <tr> 
 <td><code>QDir::Writable</code></td> 
 <td><code>0x020</code></td> 
 <td>List files for which the application has write access. The Writable value needs to be combined with Dirs or Files.</td> 
 </tr> 
 <tr> 
 <td><code>QDir::Executable</code></td> 
 <td><code>0x040</code></td> 
 <td>List files for which the application has execute access. The Executable value needs to be combined with Dirs or Files.</td> 
 </tr> 
 <tr> 
 <td><code>QDir::Modified</code></td> 
 <td><code>0x080</code></td> 
 <td>Only list files that have been modified (ignored on Unix).</td> 
 </tr> 
 <tr> 
 <td><code>QDir::Hidden</code></td> 
 <td><code>0x100</code></td> 
 <td>List hidden files (on Unix, files starting with a ".").</td> 
 </tr> 
 <tr> 
 <td><code>QDir::System</code></td> 
 <td><code>0x200</code></td> 
 <td>List system files (on Unix, FIFOs, sockets and device files are included; on Windows,&nbsp;<code>.lnk</code>&nbsp;files are included)</td> 
 </tr> 
 <tr> 
 <td><code>QDir::CaseSensitive</code></td> 
 <td><code>0x800</code></td> 
 <td>The filter should be case sensitive.</td> 
 </tr> 
 </tbody> 
</table>

Functions that use Filter enum values to filter lists of files and directories will include symbolic links to files and directories unless you set the NoSymLinks value.

A default constructed [QDir][] will not filter out files based on their permissions, so [entryList][]() and [entryInfoList][]() will return all files that are readable, writable, executable, or any combination of the three. This makes the default easy to write, and at the same time useful.

For example, setting the `Readable`, `Writable`, and `Files` flags allows all files to be listed for which the application has read access, write access or both. If the `Dirs` and `Drives` flags are also included in this combination then all drives, directories, all files that the application can read, write, or execute, and symlinks to such files/directories can be listed.

To retrieve the permissons for a directory, use the [entryInfoList][]() function to get the associated [QFileInfo][] objects and then use the QFileInfo::permissons() to obtain the permissions and ownership for each file.

The Filters type is a typedef for [QFlags][]<Filter>. It stores an OR combination of Filter values.

### enum QDir::SortFlag   flags QDir::SortFlags ###

This enum describes the sort options available to [QDir][], e.g. for [entryList][]() and [entryInfoList][](). The sort value is specified by OR-ing together values from the following list:

<table> 
 <tbody> 
 <tr> 
 <th>Constant</th> 
 <th>Value</th> 
 <th>Description</th> 
 </tr> 
 <tr> 
 <td><code>QDir::Name</code></td> 
 <td><code>0x00</code></td> 
 <td>Sort by name.</td> 
 </tr> 
 <tr> 
 <td><code>QDir::Time</code></td> 
 <td><code>0x01</code></td> 
 <td>Sort by time (modification time).</td> 
 </tr> 
 <tr> 
 <td><code>QDir::Size</code></td> 
 <td><code>0x02</code></td> 
 <td>Sort by file size.</td> 
 </tr> 
 <tr> 
 <td><code>QDir::Type</code></td> 
 <td><code>0x80</code></td> 
 <td>Sort by file type (extension).</td> 
 </tr> 
 <tr> 
 <td><code>QDir::Unsorted</code></td> 
 <td><code>0x03</code></td> 
 <td>Do not sort.</td> 
 </tr> 
 <tr> 
 <td><code>QDir::NoSort</code></td> 
 <td><code>-1</code></td> 
 <td>Not sorted by default.</td> 
 </tr> 
 <tr> 
 <td><code>QDir::DirsFirst</code></td> 
 <td><code>0x04</code></td> 
 <td>Put the directories first, then the files.</td> 
 </tr> 
 <tr> 
 <td><code>QDir::DirsLast</code></td> 
 <td><code>0x20</code></td> 
 <td>Put the files first, then the directories.</td> 
 </tr> 
 <tr> 
 <td><code>QDir::Reversed</code></td> 
 <td><code>0x08</code></td> 
 <td>Reverse the sort order.</td> 
 </tr> 
 <tr> 
 <td><code>QDir::IgnoreCase</code></td> 
 <td><code>0x10</code></td> 
 <td>Sort case-insensitively.</td> 
 </tr> 
 <tr> 
 <td><code>QDir::LocaleAware</code></td> 
 <td><code>0x40</code></td> 
 <td>Sort items appropriately using the current locale settings.</td> 
 </tr> 
 </tbody> 
</table>

You can only specify one of the first four.

If you specify both DirsFirst and Reversed, directories are still put first, but in reverse order; the files will be listed after the directories, again in reverse order.

The SortFlags type is a typedef for [QFlags][]<SortFlag>. It stores an OR combination of SortFlag values.

## Member Function Documentation ##

### QDir::QDir(const [QString][] &*path*, const [QString][] &*nameFilter*, [QDir::SortFlags][SortFlags] *sort* = SortFlags(Name | IgnoreCase), [QDir::Filters][QDir_Filters] *filters* = AllEntries) ###

Constructs a [QDir][] with path *path*, that filters its entries by name using *nameFilter* and by attributes using *filters*. It also sorts the names using *sort*.

The default *nameFilter* is an empty string, which excludes nothing; the default *filters* is [AllEntries][QDir_Filters], which also means exclude nothing. The default *sort* is [Name][SortFlags] | [IgnoreCase][SortFlags], i.e. sort by name case-insensitively.

If *path* is an empty string, [QDir][] uses "." (the current directory). If *nameFilter* is an empty string, [QDir][] uses the name filter "\*" (all files).

Note that *path* need not exist.

**See also** [exists][Link 2](), [setPath][](), [setNameFilters][](), [setFilter][](), and [setSorting][]().

### QDir::QDir(const [QString][] &*path* = QString()) ###

Constructs a [QDir][] pointing to the given directory *path*. If path is empty the program's working directory, ("."), is used.

**See also** [currentPath][]().

### QDir::QDir(const [QDir][QDir 1] &*dir*) ###

Constructs a [QDir][] object that is a copy of the [QDir][] object for directory *dir*.

**See also** [operator=][operator]().

### [QDir][QDir 1] &QDir::operator=([QDir][QDir 1] &&*other*) ###

Move-assigns *other* to this [QDir][] instance.

This function was introduced in Qt 5.2.

### [QDir][QDir 1] &QDir::operator=(const [QDir][QDir 1] &*dir*) ###

Makes a copy of the *dir* object and assigns it to this [QDir][] object.

### QDir::~QDir() ###

Destroys the [QDir][] object frees up its resources. This has no effect on the underlying directory in the file system.

### [QString][] QDir::absoluteFilePath(const [QString][] &*fileName*) const ###

Returns the absolute path name of a file in the directory. Does *not* check if the file actually exists in the directory; but see [exists][Link 2](). Redundant multiple separators or "." and ".." directories in *fileName* are not removed (see [cleanPath][]()).

**See also** [relativeFilePath][](), [filePath][](), and [canonicalPath][]().

### [QString][] QDir::absolutePath() const ###

Returns the absolute path (a path that starts with "/" or with a drive specification), which may contain symbolic links, but never contains redundant ".", ".." or multiple separators.

**See also** [setPath][](), [canonicalPath][](), [exists][Link 2](), [cleanPath][](), [dirName][](), and [absoluteFilePath][]().

### `[static]`void QDir::addSearchPath(const [QString][] &*prefix*, const [QString][] &*path*) ###

Adds *path* to the search path for *prefix*.

This function was introduced in Qt 4.3.

**See also** [setSearchPaths][]().

### [QString][] QDir::canonicalPath() const ###

Returns the canonical path, i.e. a path without symbolic links or redundant "." or ".." elements.

On systems that do not have symbolic links this function will always return the same string that [absolutePath][]() returns. If the canonical path does not exist (normally due to dangling symbolic links) canonicalPath() returns an empty string.

Example:

QString bin = "/local/bin";         // where /local/bin is a symlink to /usr/bin
    QDir binDir(bin);
    QString canonicalBin = binDir.canonicalPath();
    // canonicalBin now equals "/usr/bin"
    
    QString ls = "/local/bin/ls";       // where ls is the executable "ls"
    QDir lsDir(ls);
    QString canonicalLs = lsDir.canonicalPath();
    // canonicalLS now equals "/usr/bin/ls".

**See also** [path][](), [absolutePath][](), [exists][Link 2](), [cleanPath][](), [dirName][](), and [absoluteFilePath][]().

### bool QDir::cd(const [QString][] &*dirName*) ###

Changes the [QDir][]'s directory to *dirName*.

Returns `true` if the new directory exists; otherwise returns `false`. Note that the logical cd() operation is not performed if the new directory does not exist.

Calling cd("..") is equivalent to calling [cdUp][]().

**See also** [cdUp][](), [isReadable][](), [exists][Link 2](), and [path][]().

### bool QDir::cdUp() ###

Changes directory by moving one directory up from the [QDir][]'s current directory.

Returns `true` if the new directory exists; otherwise returns `false`. Note that the logical cdUp() operation is not performed if the new directory does not exist.

**See also** [cd][](), [isReadable][](), [exists][Link 2](), and [path][]().

### `[static]`[QString][] QDir::cleanPath(const [QString][] &*path*) ###

Returns *path* with directory separators normalized (converted to "/") and redundant ones removed, and "."s and ".."s resolved (as far as possible).

Symbolic links are kept. This function does not return the canonical path, but rather the simplest version of the input. For example, "./local" becomes "local", "local/../bin" becomes "bin" and "/local/usr/../bin" becomes "/local/bin".

**See also** [absolutePath][]() and [canonicalPath][]().

### [uint][] QDir::count() const ###

Returns the total number of directories and files in the directory.

Equivalent to [entryList][]().count().

**See also** [operator\[\]][operator 1]() and [entryList][]().

### `[static]`[QDir][QDir 1] QDir::current() ###

Returns the application's current directory.

The directory is constructed using the absolute path of the current directory, ensuring that its [path][]() will be the same as its [absolutePath][]().

**See also** [currentPath][](), [setCurrent][](), [home][](), [root][](), and [temp][]().

### `[static]`[QString][] QDir::currentPath() ###

Returns the absolute path of the application's current directory. The current directory is the last directory set with [QDir::setCurrent][setCurrent]() or, if that was never called, the directory at which this application was started at by the parent process.

**See also** [current][](), [setCurrent][](), [homePath][](), [rootPath][](), [tempPath][](), and [QCoreApplication::applicationDirPath][QCoreApplication _ applicationDirPath]().

### [QString][] QDir::dirName() const ###

Returns the name of the directory; this is *not* the same as the path, e.g. a directory with the name "mail", might have the path "/var/spool/mail". If the directory has no name (e.g. it is the root directory) an empty string is returned.

No check is made to ensure that a directory with this name actually exists; but see [exists][Link 2]().

**See also** [path][](), [filePath][](), [absolutePath][](), and [absoluteFilePath][]().

### `[static]`[QFileInfoList][] QDir::drives() ###

Returns a list of the root directories on this system.

On Windows this returns a list of [QFileInfo][] objects containing "C:/", "D:/", etc. On other operating systems, it returns a list containing just one root directory (i.e. "/").

**See also** [root][]() and [rootPath][]().

### [QFileInfoList][] QDir::entryInfoList(const [QStringList][] &*nameFilters*, [QDir::Filters][QDir_Filters] *filters* = NoFilter, [QDir::SortFlags][SortFlags] *sort* = NoSort) const ###

Returns a list of [QFileInfo][] objects for all the files and directories in the directory, ordered according to the name and attribute filters previously set with [setNameFilters][]() and [setFilter][](), and sorted according to the flags set with [setSorting][]().

The name filter, file attribute filter, and sorting specification can be overridden using the *nameFilters*, *filters*, and *sort* arguments.

Returns an empty list if the directory is unreadable, does not exist, or if nothing matches the specification.

**See also** [entryList][](), [setNameFilters][](), [setSorting][](), [setFilter][](), [isReadable][](), and [exists][Link 2]().

### [QFileInfoList][] QDir::entryInfoList([QDir::Filters][QDir_Filters] *filters* = NoFilter, [QDir::SortFlags][SortFlags] *sort* = NoSort) const ###

This is an overloaded function.

The attribute filter and sorting specifications can be overridden using the *filters* and *sort* arguments.

Returns an empty list if the directory is unreadable, does not exist, or if nothing matches the specification.

**See also** [entryList][](), [setNameFilters][](), [setSorting][](), [setFilter][](), [isReadable][](), and [exists][Link 2]().

### [QStringList][] QDir::entryList(const [QStringList][] &*nameFilters*, [QDir::Filters][QDir_Filters] *filters* = NoFilter, [QDir::SortFlags][SortFlags] *sort* = NoSort) const ###

Returns a list of the names of all the files and directories in the directory, ordered according to the name and attribute filters previously set with [setNameFilters][]() and [setFilter][](), and sorted according to the flags set with [setSorting][]().

The name filter, file attribute filter, and sorting specification can be overridden using the *nameFilters*, *filters*, and *sort* arguments.

Returns an empty list if the directory is unreadable, does not exist, or if nothing matches the specification.

**See also** [entryInfoList][](), [setNameFilters][](), [setSorting][](), and [setFilter][]().

### [QStringList][] QDir::entryList([QDir::Filters][QDir_Filters] *filters* = NoFilter, [QDir::SortFlags][SortFlags] *sort* = NoSort) const ###

This is an overloaded function.

The attribute filter and sorting specifications can be overridden using the *filters* and *sort* arguments.

Returns an empty list if the directory is unreadable, does not exist, or if nothing matches the specification.

**Note:** To list symlinks that point to non existing files, [System][QDir_Filters] must be passed to the filter.

**See also** [entryInfoList][](), [setNameFilters][](), [setSorting][](), and [setFilter][]().

### bool QDir::exists(const [QString][] &*name*) const ###

Returns `true` if the file called *name* exists; otherwise returns false.

Unless *name* contains an absolute file path, the file name is assumed to be relative to the directory itself, so this function is typically used to check for the presence of files within a directory.

**See also** [QFileInfo::exists][QFileInfo_exists]() and [QFile::exists][QFile_exists]().

### bool QDir::exists() const ###

This is an overloaded function.

Returns `true` if the directory exists; otherwise returns `false`. (If a file with the same name is found this function will return false).

The overload of this function that accepts an argument is used to test for the presence of files and directories within a directory.

**See also** [QFileInfo::exists][QFileInfo_exists]() and [QFile::exists][QFile_exists]().

### [QString][] QDir::filePath(const [QString][] &*fileName*) const ###

Returns the path name of a file in the directory. Does *not* check if the file actually exists in the directory; but see [exists][Link 2](). If the [QDir][] is relative the returned path name will also be relative. Redundant multiple separators or "." and ".." directories in *fileName* are not removed (see [cleanPath][]()).

**See also** [dirName][](), [absoluteFilePath][](), [isRelative][](), and [canonicalPath][]().

### [QDir::Filters][QDir_Filters] QDir::filter() const ###

Returns the value set by [setFilter][]()

**See also** [setFilter][]().

### `[static]`[QString][] QDir::fromNativeSeparators(const [QString][] &*pathName*) ###

Returns *pathName* using '/' as file separator. On Windows, for instance, fromNativeSeparators("`c:\\winnt\\system32`") returns "c:/winnt/system32".

The returned string may be the same as the argument on some operating systems, for example on Unix.

This function was introduced in Qt 4.2.

**See also** [toNativeSeparators][]() and [separator][]().

### `[static]`[QDir][QDir 1] QDir::home() ###

Returns the user's home directory.

The directory is constructed using the absolute path of the home directory, ensuring that its [path][]() will be the same as its [absolutePath][]().

See [homePath][]() for details.

**See also** [drives][Link 4](), [current][](), [root][](), and [temp][]().

### `[static]`[QString][] QDir::homePath() ###

Returns the absolute path of the user's home directory.

Under Windows this function will return the directory of the current user's profile. Typically, this is:

C:/Documents and Settings/Username

Use the [toNativeSeparators][]() function to convert the separators to the ones that are appropriate for the underlying operating system.

If the directory of the current user's profile does not exist or cannot be retrieved, the following alternatives will be checked (in the given order) until an existing and available path is found:

1.  The path specified by the `USERPROFILE` environment variable.
2.  The path formed by concatenating the `HOMEDRIVE` and `HOMEPATH` environment variables.
3.  The path specified by the `HOME` environment variable.
4.  The path returned by the [rootPath][]() function (which uses the `SystemDrive` environment variable)
5.  The `C:/` directory.

Under non-Windows operating systems the `HOME` environment variable is used if it exists, otherwise the path returned by the [rootPath][]().

**See also** [home][](), [currentPath][](), [rootPath][](), and [tempPath][]().

### bool QDir::isAbsolute() const ###

Returns `true` if the directory's path is absolute; otherwise returns `false`. See [isAbsolutePath][]().

**See also** [isRelative][](), [makeAbsolute][](), and [cleanPath][]().

### `[static]`bool QDir::isAbsolutePath(const [QString][] &*path*) ###

Returns `true` if *path* is absolute; returns `false` if it is relative.

**See also** [isAbsolute][](), [isRelativePath][](), [makeAbsolute][](), and [cleanPath][]().

### bool QDir::isEmpty([QDir::Filters][QDir_Filters] *filters* = Filters(AllEntries | NoDotAndDotDot)) const ###

Returns whether the directory is empty.

Equivalent to `count() == 0` with filters `QDir::AllEntries | QDir::NoDotAndDotDot`, but faster as it just checks whether the directory contains at least one entry.

**Note:** Unless you set the *filters* flags to include `QDir::NoDotAndDotDot` (as the default value does), no directory is empty.

This function was introduced in Qt 5.9.

**See also** [count][](), [entryList][](), and [setFilter][]().

### bool QDir::isReadable() const ###

Returns `true` if the directory is readable *and* we can open files by name; otherwise returns `false`.

**Warning:** A false value from this function is not a guarantee that files in the directory are not accessible.

**See also** [QFileInfo::isReadable][QFileInfo_isReadable]().

### bool QDir::isRelative() const ###

Returns `true` if the directory path is relative; otherwise returns false. (Under Unix a path is relative if it does not start with a "/").

**See also** [makeAbsolute][](), [isAbsolute][](), [isAbsolutePath][](), and [cleanPath][]().

### `[static]`bool QDir::isRelativePath(const [QString][] &*path*) ###

Returns `true` if *path* is relative; returns `false` if it is absolute.

**See also** [isRelative][](), [isAbsolutePath][](), and [makeAbsolute][]().

### bool QDir::isRoot() const ###

Returns `true` if the directory is the root directory; otherwise returns `false`.

Note: If the directory is a symbolic link to the root directory this function returns `false`. If you want to test for this use [canonicalPath][](), e.g.

QDir dir("/tmp/root_link");
    dir = dir.canonicalPath();
    if (dir.isRoot())
        qWarning("It is a root link");

**See also** [root][]() and [rootPath][]().

### `[static]`[QChar][] QDir::listSeparator() ###

Returns the native path list separator: ':' under Unix and ';' under Windows.

This function was introduced in Qt 5.6.

**See also** [separator][]().

### bool QDir::makeAbsolute() ###

Converts the directory path to an absolute path. If it is already absolute nothing happens. Returns `true` if the conversion succeeded; otherwise returns `false`.

**See also** [isAbsolute][](), [isAbsolutePath][](), [isRelative][](), and [cleanPath][]().

### `[static]`bool QDir::match(const [QString][] &*filter*, const [QString][] &*fileName*) ###

Returns `true` if the *fileName* matches the wildcard (glob) pattern *filter*; otherwise returns `false`. The *filter* may contain multiple patterns separated by spaces or semicolons. The matching is case insensitive.

**See also** [QRegularExpression Wildcard Matching][], [entryList][](), and [entryInfoList][]().

### `[static]`bool QDir::match(const [QStringList][] &*filters*, const [QString][] &*fileName*) ###

This is an overloaded function.

Returns `true` if the *fileName* matches any of the wildcard (glob) patterns in the list of *filters*; otherwise returns `false`. The matching is case insensitive.

**See also** [QRegularExpression Wildcard Matching][], [entryList][](), and [entryInfoList][]().

### bool QDir::mkdir(const [QString][] &*dirName*) const ###

Creates a sub-directory called *dirName*.

Returns `true` on success; otherwise returns `false`.

If the directory already exists when this function is called, it will return false.

**See also** [rmdir][]().

### bool QDir::mkpath(const [QString][] &*dirPath*) const ###

Creates the directory path *dirPath*.

The function will create all parent directories necessary to create the directory.

Returns `true` if successful; otherwise returns `false`.

If the path already exists when this function is called, it will return true.

**See also** [rmpath][]().

### [QStringList][] QDir::nameFilters() const ###

Returns the string list set by [setNameFilters][]()

**See also** [setNameFilters][]().

### [QString][] QDir::path() const ###

Returns the path. This may contain symbolic links, but never contains redundant ".", ".." or multiple separators.

The returned path can be either absolute or relative (see [setPath][]()).

**See also** [setPath][](), [absolutePath][](), [exists][Link 2](), [cleanPath][](), [dirName][](), [absoluteFilePath][](), [toNativeSeparators][](), and [makeAbsolute][]().

### void QDir::refresh() const ###

Refreshes the directory information.

### [QString][] QDir::relativeFilePath(const [QString][] &*fileName*) const ###

Returns the path to *fileName* relative to the directory.

QDir dir("/home/bob");
    QString s;
    
    s = dir.relativeFilePath("images/file.jpg");     // s is "images/file.jpg"
    s = dir.relativeFilePath("/home/mary/file.txt"); // s is "../mary/file.txt"

**See also** [absoluteFilePath][](), [filePath][](), and [canonicalPath][]().

### bool QDir::remove(const [QString][] &*fileName*) ###

Removes the file, *fileName*.

Returns `true` if the file is removed successfully; otherwise returns `false`.

### bool QDir::removeRecursively() ###

Removes the directory, including all its contents.

Returns `true` if successful, otherwise false.

If a file or directory cannot be removed, removeRecursively() keeps going and attempts to delete as many files and sub-directories as possible, then returns `false`.

If the directory was already removed, the method returns `true` (expected result already reached).

Note: this function is meant for removing a small application-internal directory (such as a temporary directory), but not user-visible directories. For user-visible operations, it is rather recommended to report errors more precisely to the user, to offer solutions in case of errors, to show progress during the deletion since it could take several minutes, etc.

This function was introduced in Qt 5.0.

### bool QDir::rename(const [QString][] &*oldName*, const [QString][] &*newName*) ###

Renames a file or directory from *oldName* to *newName*, and returns true if successful; otherwise returns `false`.

On most file systems, rename() fails only if *oldName* does not exist, or if a file with the new name already exists. However, there are also other reasons why rename() can fail. For example, on at least one file system rename() fails if *newName* points to an open file.

If *oldName* is a file (not a directory) that can't be renamed right away, Qt will try to copy *oldName* to *newName* and remove *oldName*.

**See also** [QFile::rename][QFile_rename]().

### bool QDir::rmdir(const [QString][] &*dirName*) const ###

Removes the directory specified by *dirName*.

The directory must be empty for rmdir() to succeed.

Returns `true` if successful; otherwise returns `false`.

**See also** [mkdir][]().

### bool QDir::rmpath(const [QString][] &*dirPath*) const ###

Removes the directory path *dirPath*.

The function will remove all parent directories in *dirPath*, provided that they are empty. This is the opposite of mkpath(dirPath).

Returns `true` if successful; otherwise returns `false`.

**See also** [mkpath][]().

### `[static]`[QDir][QDir 1] QDir::root() ###

Returns the root directory.

The directory is constructed using the absolute path of the root directory, ensuring that its [path][]() will be the same as its [absolutePath][]().

See [rootPath][]() for details.

**See also** [drives][Link 4](), [current][](), [home][](), and [temp][]().

### `[static]`[QString][] QDir::rootPath() ###

Returns the absolute path of the root directory.

For Unix operating systems this returns "/". For Windows file systems this normally returns "c:/".

**See also** [root][](), [drives][Link 4](), [currentPath][](), [homePath][](), and [tempPath][]().

### `[static]`[QStringList][] QDir::searchPaths(const [QString][] &*prefix*) ###

Returns the search paths for *prefix*.

This function was introduced in Qt 4.3.

**See also** [setSearchPaths][]() and [addSearchPath][]().

### `[static]`[QChar][] QDir::separator() ###

Returns the native directory separator: "/" under Unix and "\\" under Windows.

You do not need to use this function to build file paths. If you always use "/", Qt will translate your paths to conform to the underlying operating system. If you want to display paths to the user using their operating system's separator use [toNativeSeparators][]().

**See also** [listSeparator][]().

### `[static]`bool QDir::setCurrent(const [QString][] &*path*) ###

Sets the application's current working directory to *path*. Returns `true` if the directory was successfully changed; otherwise returns `false`.

**See also** [current][](), [currentPath][](), [home][](), [root][](), and [temp][]().

### void QDir::setFilter([QDir::Filters][QDir_Filters] *filters*) ###

Sets the filter used by [entryList][]() and [entryInfoList][]() to *filters*. The filter is used to specify the kind of files that should be returned by [entryList][]() and [entryInfoList][](). See [QDir::Filter][QDir_Filters].

**See also** [filter][]() and [setNameFilters][]().

### void QDir::setNameFilters(const [QStringList][] &*nameFilters*) ###

Sets the name filters used by [entryList][]() and [entryInfoList][]() to the list of filters specified by *nameFilters*.

Each name filter is a wildcard (globbing) filter that understands `*` and `?` wildcards. See [QRegularExpression Wildcard Matching][].

For example, the following code sets three name filters on a [QDir][] to ensure that only files with extensions typically used for C++ source files are listed:

QStringList filters;
 filters << "*.cpp" << "*.cxx" << "*.cc";
 dir.setNameFilters(filters);

**See also** [nameFilters][]() and [setFilter][]().

### void QDir::setPath(const [QString][] &*path*) ###

Sets the path of the directory to *path*. The path is cleaned of redundant ".", ".." and of multiple separators. No check is made to see whether a directory with this path actually exists; but you can check for yourself using [exists][Link 2]().

The path can be either absolute or relative. Absolute paths begin with the directory separator "/" (optionally preceded by a drive specification under Windows). Relative file names begin with a directory name or a file name and specify a path relative to the current directory. An example of an absolute path is the string "/tmp/quartz", a relative path might look like "src/fatlib".

**See also** [path][](), [absolutePath][](), [exists][Link 2](), [cleanPath][](), [dirName][](), [absoluteFilePath][](), [isRelative][](), and [makeAbsolute][]().

### `[static]`void QDir::setSearchPaths(const [QString][] &*prefix*, const [QStringList][] &*searchPaths*) ###

Sets or replaces Qt's search paths for file names with the prefix *prefix* to *searchPaths*.

To specify a prefix for a file name, prepend the prefix followed by a single colon (e.g., "images:undo.png", "xmldocs:books.xml"). *prefix* can only contain letters or numbers (e.g., it cannot contain a colon, nor a slash).

Qt uses this search path to locate files with a known prefix. The search path entries are tested in order, starting with the first entry.

QDir::setSearchPaths("icons", QStringList(QDir::homePath() + "/images"));
    QDir::setSearchPaths("docs", QStringList(":/embeddedDocuments"));
    ...
    QPixmap pixmap("icons:undo.png"); // will look for undo.png in QDir::homePath() + "/images"
    QFile file("docs:design.odf"); // will look in the :/embeddedDocuments resource path

File name prefix must be at least 2 characters long to avoid conflicts with Windows drive letters.

Search paths may contain paths to [The Qt Resource System][Link 1].

This function was introduced in Qt 4.3.

**See also** [searchPaths][]().

### void QDir::setSorting([QDir::SortFlags][SortFlags] *sort*) ###

Sets the sort order used by [entryList][]() and [entryInfoList][]().

The *sort* is specified by OR-ing values from the enum [QDir::SortFlag][SortFlags].

**See also** [sorting][]() and [SortFlag][SortFlags].

### [QDir::SortFlags][SortFlags] QDir::sorting() const ###

Returns the value set by [setSorting][]()

**See also** [setSorting][]() and [SortFlag][SortFlags].

### void QDir::swap([QDir][QDir 1] &*other*) ###

Swaps this [QDir][] instance with *other*. This function is very fast and never fails.

This function was introduced in Qt 5.0.

### `[static]`[QDir][QDir 1] QDir::temp() ###

Returns the system's temporary directory.

The directory is constructed using the absolute canonical path of the temporary directory, ensuring that its [path][]() will be the same as its [absolutePath][]().

See [tempPath][]() for details.

**See also** [drives][Link 4](), [current][](), [home][](), and [root][]().

### `[static]`[QString][] QDir::tempPath() ###

Returns the absolute canonical path of the system's temporary directory.

On Unix/Linux systems this is the path in the `TMPDIR` environment variable or `/tmp` if `TMPDIR` is not defined. On Windows this is usually the path in the `TEMP` or `TMP` environment variable. The path returned by this method doesn't end with a directory separator unless it is the root directory (of a drive).

**See also** [temp][](), [currentPath][](), [homePath][](), and [rootPath][]().

### `[static]`[QString][] QDir::toNativeSeparators(const [QString][] &*pathName*) ###

Returns *pathName* with the '/' separators converted to separators that are appropriate for the underlying operating system.

On Windows, toNativeSeparators("c:/winnt/system32") returns "c:\\winnt\\system32".

The returned string may be the same as the argument on some operating systems, for example on Unix.

This function was introduced in Qt 4.2.

**See also** [fromNativeSeparators][]() and [separator][]().

### bool QDir::operator!=(const [QDir][QDir 1] &*dir*) const ###

Returns `true` if directory *dir* and this directory have different paths or different sort or filter settings; otherwise returns false.

Example:

// The current directory is "/usr/local"
    QDir d1("/usr/local/bin");
    d1.setFilter(QDir::Executable);
    QDir d2("bin");
    if (d1 != d2)
        qDebug("They differ");

### bool QDir::operator==(const [QDir][QDir 1] &*dir*) const ###

Returns `true` if directory *dir* and this directory have the same path and their sort and filter settings are the same; otherwise returns `false`.

Example:

// The current directory is "/usr/local"
    QDir d1("/usr/local/bin");
    QDir d2("bin");
    if (d1 == d2)
        qDebug("They're the same");

### [QString][] QDir::operator\[\](int *pos*) const ###

Returns the file name at position *pos* in the list of file names. Equivalent to [entryList][]().at(index). *pos* must be a valid index position in the list (i.e., 0 <= pos < [count][]()).

**See also** [count][]() and [entryList][]().

## Macro Documentation ##

### void Q\_CLEANUP\_RESOURCE(*name*) ###

Unloads the resources specified by the `.qrc` file with the base name *name*.

Normally, Qt resources are unloaded automatically when the application terminates, but if the resources are located in a plugin that is being unloaded, call Q\_CLEANUP\_RESOURCE() to force removal of your resources.

Note: This macro cannot be used in a namespace. Please see the [Q\_INIT\_RESOURCE][Q_INIT_RESOURCE] documentation for a workaround.

Example:

Q_CLEANUP_RESOURCE(myapp);

This function was introduced in Qt 4.1.

**See also** [Q\_INIT\_RESOURCE][Q_INIT_RESOURCE]() and [The Qt Resource System][Link 1].

### void Q\_INIT\_RESOURCE(*name*) ###

Initializes the resources specified by the `.qrc` file with the specified base *name*. Normally, when resources are built as part of the application, the resources are loaded automatically at startup. The Q\_INIT\_RESOURCE() macro is necessary on some platforms for resources stored in a static library.

For example, if your application's resources are listed in a file called `myapp.qrc`, you can ensure that the resources are initialized at startup by adding this line to your `main()` function:

Q_INIT_RESOURCE(myapp);

If the file name contains characters that cannot be part of a valid C++ function name (such as '-'), they have to be replaced by the underscore character ('\_').

Note: This macro cannot be used in a namespace. It should be called from main(). If that is not possible, the following workaround can be used to init the resource `myapp` from the function `MyNamespace::myFunction`:

inline void initMyResource() { Q_INIT_RESOURCE(myapp); }
    
    namespace MyNamespace
    {
        ...
    
        void myFunction()
        {
            initMyResource();
        }
    }

**See also** [Q\_CLEANUP\_RESOURCE][Q_CLEANUP_RESOURCE]() and [The Qt Resource System][Link 1].

[QDir]: https://doc.qt.io/archives/qt-5.13/qdir.html
[More...]: https://doc.qt.io/archives/qt-5.13/qdir.html#details
[List of all members_ including inherited members]: https://doc.qt.io/archives/qt-5.13/qdir-members.html
[Obsolete members]: https://doc.qt.io/archives/qt-5.13/qdir-obsolete.html
[reentrant]: https://doc.qt.io/archives/qt-5.13/threads-reentrancy.html
[Link 1]: https://doc.qt.io/archives/qt-5.13/resources.html
[isRelative]: https://doc.qt.io/archives/qt-5.13/qdir.html#isRelative
[isAbsolute]: https://doc.qt.io/archives/qt-5.13/qdir.html#isAbsolute
[makeAbsolute]: https://doc.qt.io/archives/qt-5.13/qdir.html#makeAbsolute
[path]: https://doc.qt.io/archives/qt-5.13/qdir.html#path
[setPath]: https://doc.qt.io/archives/qt-5.13/qdir.html#setPath
[absolutePath]: https://doc.qt.io/archives/qt-5.13/qdir.html#absolutePath
[dirName]: https://doc.qt.io/archives/qt-5.13/qdir.html#dirName
[cd]: https://doc.qt.io/archives/qt-5.13/qdir.html#cd
[cdUp]: https://doc.qt.io/archives/qt-5.13/qdir.html#cdUp
[mkdir]: https://doc.qt.io/archives/qt-5.13/qdir.html#mkdir
[rename]: https://doc.qt.io/archives/qt-5.13/qdir.html#rename
[rmdir]: https://doc.qt.io/archives/qt-5.13/qdir.html#rmdir
[Link 2]: https://doc.qt.io/archives/qt-5.13/qdir.html#exists-1
[isReadable]: https://doc.qt.io/archives/qt-5.13/qdir.html#isReadable
[isRoot]: https://doc.qt.io/archives/qt-5.13/qdir.html#isRoot
[Link 3]: https://doc.qt.io/archives/qt-5.13/qdir.html#refresh
[count]: https://doc.qt.io/archives/qt-5.13/qdir.html#count
[entryList]: https://doc.qt.io/archives/qt-5.13/qdir.html#entryList
[entryInfoList]: https://doc.qt.io/archives/qt-5.13/qdir.html#entryInfoList
[QFileInfo]: https://doc.qt.io/archives/qt-5.13/qfileinfo.html
[filePath]: https://doc.qt.io/archives/qt-5.13/qdir.html#filePath
[absoluteFilePath]: https://doc.qt.io/archives/qt-5.13/qdir.html#absoluteFilePath
[remove]: https://doc.qt.io/archives/qt-5.13/qdir.html#remove
[setNameFilters]: https://doc.qt.io/archives/qt-5.13/qdir.html#setNameFilters
[setFilter]: https://doc.qt.io/archives/qt-5.13/qdir.html#setFilter
[setSorting]: https://doc.qt.io/archives/qt-5.13/qdir.html#setSorting
[SortFlags]: https://doc.qt.io/archives/qt-5.13/qdir.html#SortFlag-enum
[match]: https://doc.qt.io/archives/qt-5.13/qdir.html#match
[setCurrent]: https://doc.qt.io/archives/qt-5.13/qdir.html#setCurrent
[QCoreApplication _ applicationDirPath]: https://doc.qt.io/archives/qt-5.13/qcoreapplication.html#applicationDirPath
[Link 4]: https://doc.qt.io/archives/qt-5.13/qdir.html#drives
[canonicalPath]: https://doc.qt.io/archives/qt-5.13/qdir.html#canonicalPath
[cleanPath]: https://doc.qt.io/archives/qt-5.13/qdir.html#cleanPath
[toNativeSeparators]: https://doc.qt.io/archives/qt-5.13/qdir.html#toNativeSeparators
[QFile_exists]: https://doc.qt.io/archives/qt-5.13/qfile.html#exists-1
[QFile]: https://doc.qt.io/archives/qt-5.13/qfile.html
[QFileDialog]: https://doc.qt.io/archives/qt-5.13/qfiledialog.html
[Find Files Example]: https://doc.qt.io/archives/qt-5.13/qtwidgets-dialogs-findfiles-example.html
[QFlags]: https://doc.qt.io/archives/qt-5.13/qflags.html
[QString]: https://doc.qt.io/archives/qt-5.13/qstring.html
[QDir_Filters]: https://doc.qt.io/archives/qt-5.13/qdir.html#Filter-enum
[currentPath]: https://doc.qt.io/archives/qt-5.13/qdir.html#currentPath
[QDir 1]: https://doc.qt.io/archives/qt-5.13/qdir.html#QDir
[operator]: https://doc.qt.io/archives/qt-5.13/qdir.html#operator-eq
[relativeFilePath]: https://doc.qt.io/archives/qt-5.13/qdir.html#relativeFilePath
[setSearchPaths]: https://doc.qt.io/archives/qt-5.13/qdir.html#setSearchPaths
[uint]: https://doc.qt.io/archives/qt-5.13/qtglobal.html#uint-typedef
[operator 1]: https://doc.qt.io/archives/qt-5.13/qdir.html#operator-5b-5d
[home]: https://doc.qt.io/archives/qt-5.13/qdir.html#home
[root]: https://doc.qt.io/archives/qt-5.13/qdir.html#root
[temp]: https://doc.qt.io/archives/qt-5.13/qdir.html#temp
[current]: https://doc.qt.io/archives/qt-5.13/qdir.html#current
[homePath]: https://doc.qt.io/archives/qt-5.13/qdir.html#homePath
[rootPath]: https://doc.qt.io/archives/qt-5.13/qdir.html#rootPath
[tempPath]: https://doc.qt.io/archives/qt-5.13/qdir.html#tempPath
[QFileInfoList]: https://doc.qt.io/archives/qt-5.13/qfileinfo.html#QFileInfoList-typedef
[QStringList]: https://doc.qt.io/archives/qt-5.13/qstringlist.html
[QFileInfo_exists]: https://doc.qt.io/archives/qt-5.13/qfileinfo.html#exists
[separator]: https://doc.qt.io/archives/qt-5.13/qdir.html#separator
[isAbsolutePath]: https://doc.qt.io/archives/qt-5.13/qdir.html#isAbsolutePath
[isRelativePath]: https://doc.qt.io/archives/qt-5.13/qdir.html#isRelativePath
[QFileInfo_isReadable]: https://doc.qt.io/archives/qt-5.13/qfileinfo.html#isReadable
[QChar]: https://doc.qt.io/archives/qt-5.13/qchar.html
[QRegularExpression Wildcard Matching]: https://doc.qt.io/archives/qt-5.13/qregularexpression.html#wildcard-matching
[rmpath]: https://doc.qt.io/archives/qt-5.13/qdir.html#rmpath
[QFile_rename]: https://doc.qt.io/archives/qt-5.13/qfile.html#rename
[mkpath]: https://doc.qt.io/archives/qt-5.13/qdir.html#mkpath
[addSearchPath]: https://doc.qt.io/archives/qt-5.13/qdir.html#addSearchPath
[listSeparator]: https://doc.qt.io/archives/qt-5.13/qdir.html#listSeparator
[filter]: https://doc.qt.io/archives/qt-5.13/qdir.html#filter
[nameFilters]: https://doc.qt.io/archives/qt-5.13/qdir.html#nameFilters
[searchPaths]: https://doc.qt.io/archives/qt-5.13/qdir.html#searchPaths
[sorting]: https://doc.qt.io/archives/qt-5.13/qdir.html#sorting
[fromNativeSeparators]: https://doc.qt.io/archives/qt-5.13/qdir.html#fromNativeSeparators
[Q_INIT_RESOURCE]: https://doc.qt.io/archives/qt-5.13/qdir.html#Q_INIT_RESOURCE
[Q_CLEANUP_RESOURCE]: https://doc.qt.io/archives/qt-5.13/qdir.html#Q_CLEANUP_RESOURCE