QResource Class

成员函数文档

QResource::QResource(const QString &file = QString(), const QLocale &locale = QLocale())

创建一个指向file 的 QResource。locale 用于加载资源数据的特定本地化版本。

另请参阅 QFileInfo 、QDir::searchPaths()、setFileName() 以及setLocale()。

[noexcept] QResource::~QResource()

释放QResource 对象占用的资源。

QString QResource::absoluteFilePath() const

返回该QResource 所表示的实际路径；如果该资源是通过QDir::searchPaths() 找到的，则路径中会予以标注。

另请参阅 fileName()。

[protected] QStringList QResource::children() const

返回该目录下所有资源的列表；如果资源表示一个文件，则该列表为空。

另请参阅 isDir()。

QResource::Compression QResource::compressionAlgorithm() const

返回该资源所使用的压缩类型（如有）。如果未进行压缩，则该函数返回QResource::NoCompression 。

如果该函数返回QResource::ZlibCompression ，您可以使用qUncompress()函数对数据进行解压。在Qt 5.13之前，这是唯一可用的压缩算法。

如果该函数返回QResource::ZstdCompression ，则需要使用 Zstandard 库函数（<zstd.h> 头文件）。Qt 不提供封装函数。

请参阅Zstandard 手册。

另请参阅 data() 和isFile()。

const uchar *QResource::data() const

返回对该资源所代表的只读数据段的直接访问权限。如果该资源经过压缩，则返回的数据也是压缩的。调用方必须对数据进行解压，或者使用uncompressedData()。如果该资源是一个目录，则返回nullptr 。

另请参阅 uncompressedData()、size() 和isFile()。

QString QResource::fileName() const

返回该QResource 所表示的文件的完整路径（即传入时的路径）。

另请参阅 setFileName() 和absoluteFilePath()。

[protected] bool QResource::isDir() const

如果该资源表示一个目录（因此可能包含 `children()`），则返回 `true `；如果表示一个文件，则返回 `false`。

另请参阅 isFile()。

[protected] bool QResource::isFile() const

如果资源表示一个文件且因此有数据支持，则返回 `true `；如果表示一个目录，则返回 `false`。

另请参阅 isDir()。

bool QResource::isValid() const

如果该资源确实存在于资源层次结构中，则返回true ；否则返回false。

QDateTime QResource::lastModified() const

返回文件在打包为资源之前最后一次被修改的日期和时间。

QLocale QResource::locale() const

返回用于查找QResource 相关数据的区域设置。

另请参阅 setLocale()。

[static] bool QResource::registerResource(const QString &rccFileName, const QString &mapRoot = QString())

将资源注册到指定的rccFileName 中，位置由mapRoot 指定；如果文件成功打开，则返回true ；否则返回false 。

另请参阅 unregisterResource()。

[static] bool QResource::registerResource(const uchar *rccData, const QString &mapRoot = QString())

将资源注册到指定的rccData 中，位置为资源树中由mapRoot 指定的位置，如果文件成功打开，则返回true ；否则返回false 。

另请参阅 unregisterResource()。

void QResource::setFileName(const QString &file)

将QResource 设置为指向file 。file 可以是绝对路径，此时文件将直接打开；若是相对路径，则会尝试通过QDir::searchPaths()查找该文件。

另请参阅 fileName() 和absoluteFilePath()。

void QResource::setLocale(const QLocale &locale)

将QResource 设置为仅加载locale 对应资源的本地化版本。如果未找到特定语言环境的资源，则使用C语言环境。

另请参阅 locale() 和setFileName()。

qint64 QResource::size() const

返回资源所对应存储数据的大小。

如果资源经过压缩，则此函数返回压缩后数据的大小。有关未压缩数据的大小，请参阅uncompressedSize()。

另请参阅 data()、uncompressedSize() 和isFile()。

QByteArray QResource::uncompressedData() const

如果资源数据以压缩形式存储，则先对其进行解压缩，然后返回资源数据。如果资源是一个目录，或者在解压缩过程中发生错误，则返回空的QByteArray 。

另请参阅 uncompressedSize()、size()、compressionAlgorithm() 和isFile()。

qint64 QResource::uncompressedSize() const

返回此资源中数据的大小。如果数据未经过压缩，则该函数的返回结果与size()相同；如果数据经过压缩，则该函数会从存储的流中提取原始未压缩数据的大小。

另请参阅 size()、uncompressedData() 和isFile()。

[static] bool QResource::unregisterResource(const QString &rccFileName, const QString &mapRoot = QString())

取消在资源树中由mapRoot 指定的位置处，针对给定rccFileName 的资源的注册；如果资源成功卸载且不存在对该资源的引用，则返回true ；否则返回false 。

另请参阅 registerResource()。

[static] bool QResource::unregisterResource(const uchar *rccData, const QString &mapRoot = QString())

取消在资源树中由mapRoot 指定的位置对指定rccData 的资源的注册，如果资源已成功卸载且不存在对该资源的引用，则返回true ；否则返回false 。

另请参阅 registerResource()。