介绍

目录操作类，提供文件和目录操作功能

基础信息

头文件:	include <TpDir.h>
Cmake:	None
发布版本:	V0.2.1
继承类:
派生类:

Public 类型

enum TpDir::Filter

名称	值	描述
Dirs	0x001	包含目录
Files	0x002	包含文件
Drives	0x004	包含驱动器
NoSymLinks	0x008	排除符号链接
AllEntries	Dirs | Files | Drives	包含所有条目（目录、文件、驱动器）
TypeMask	0x00f	类型过滤掩码
Hidden	0x100	包含隐藏文件和目录
AccessMask	0x3F0	访问权限过滤掩码
AllDirs	0x400	包含所有目录（包括.和..）
CaseSensitive	0x800	区分大小写的过滤
NoDot	0x2000	排除当前目录(.)
NoDotDot	0x4000	排除上级目录(..)
NoDotAndDotDot	NoDot | NoDotDot	排除当前和上级目录(./..)
NoFilter	-1	无过滤条件

enum TpDir::SortFlag

名称	值	描述
Name	0x00	按名称排序
Time	0x01	按修改时间排序
Size	0x02	按文件大小排序
Unsorted	0x03	不排序（文件系统原始顺序）
DirsFirst	0x04	目录排在文件前
Reversed	0x08	反向排序
DirsLast	0x20	目录排在文件后
Type	0x80	按文件类型排序
NoSort	-1	无排序

Public 成员函数

	TpDir()	默认构造函数，创建空目录对象
	TpDir(const TpString &path)	构造函数，指定初始路径
	~TpDir()	析构函数，清理资源
	setPath(const TpString &path)	设置目录路径
TpString	path() const	获取当前设置的目录路径
TpString	absolutePath() const	获取目录的绝对路径
TpString	canonicalPath() const	获取目录的规范路径（解析所有符号链接和相对路径）
TpString	dirName() const	获取目录名称
TpString	filePath(const TpString &fileName) const	获取指定文件在目录中的完整路径
TpString	absoluteFilePath(const TpString &fileName) const	获取指定文件的绝对路径
TpString	relativeFilePath(const TpString &fileName) const	获取相对于当前目录的相对路径
	entryInfoList(Filters filters=NoFilter, SortFlags sort=NoSort) const	获取目录下的文件信息列表
	mkdir(const TpString &dirName) const	在当前目录下创建子目录
	exists() const	检查目录是否存在
	remove(const TpString &fileName)	删除目录下的文件
	removeRecursively()	递归删除目录及其所有内容
	mkpath(const TpString &dirPath)	静态方法：递归创建目录

成员函数说明

TpDir::TpDir()

默认构造函数，创建空目录对象...

默认构造函数，创建空目录对象

TpDir::TpDir(const TpString &path)

构造函数，指定初始路径...

构造函数，指定初始路径
参数：path: 初始目录路径

TpDir::~TpDir()

析构函数，清理资源...

析构函数，清理资源

void TpDir::setPath(const TpString &path)

设置目录路径...

设置目录路径
参数：path: 新的目录路径

TpString TpDir::path() const

获取当前设置的目录路径...

获取当前设置的目录路径
返回值：目录路径

TpString TpDir::absolutePath() const

获取目录的绝对路径...

获取目录的绝对路径
返回值：绝对路径

TpString TpDir::canonicalPath() const

获取目录的规范路径（解析所有符号链接和相对路径）...

获取目录的规范路径（解析所有符号链接和相对路径）
返回值：规范路径

TpString TpDir::dirName() const

获取目录名称...

获取目录名称
返回值：目录名称

TpString TpDir::filePath(const TpString &fileName) const

获取指定文件在目录中的完整路径...

获取指定文件在目录中的完整路径
参数：fileName: 文件名
返回值：文件在目录中的完整路径

TpString TpDir::absoluteFilePath(const TpString &fileName) const

获取指定文件的绝对路径...

获取指定文件的绝对路径
参数：fileName: 文件名
返回值：文件的绝对路径

TpString TpDir::relativeFilePath(const TpString &fileName) const

获取相对于当前目录的相对路径...

获取相对于当前目录的相对路径
参数：fileName: 目标文件的绝对路径
返回值：相对于当前目录的相对路径

TpFileInfoList TpDir::entryInfoList(Filters filters=NoFilter, SortFlags sort=NoSort) const

获取目录下的文件信息列表...

获取目录下的文件信息列表
参数：filters: 过滤条件（默认为无过滤）
参数：sort: 排序标志（默认为不排序）
返回值：文件信息列表

bool TpDir::mkdir(const TpString &dirName) const

在当前目录下创建子目录...

在当前目录下创建子目录
参数：dirName: 要创建的子目录名称
返回值：创建成功返回true，否则返回false

bool TpDir::exists() const

检查目录是否存在...

检查目录是否存在
返回值：存在返回true，否则返回false

bool TpDir::remove(const TpString &fileName)

删除目录下的文件...

删除目录下的文件
参数：fileName: 要删除的文件名
返回值：删除成功返回true，否则返回false

bool TpDir::removeRecursively()

递归删除目录及其所有内容...

递归删除目录及其所有内容
返回值：删除成功返回true，否则返回false

static bool TpDir::mkpath(const TpString &dirPath)

静态方法：递归创建目录...

静态方法：递归创建目录
参数：dirPath: 要创建的完整目录路径
返回值：创建成功返回true，否则返回false

版权所有

版权归属：TinyPiXOS

许可证：署名-相同方式共享 4.0 国际 (CC-BY-SA-4.0)