Debian Codegraph @

docs/dci/ddcifile.zh_CN.dox

raw
1 /*!
2 @~chinese
3 @file include/dci/ddcifile.h
4 @ingroup dci
5
6 @class Dtk::Core::DDciFile ddcifile.h
7 @brief ddcifile.h 是关于dci文件相关操作的一个类,实现了 DCI 文件的逻辑。其只是对数据的打包
8 dci文件的结构路径如下:
9 ![DCI图标结构路径](@ref dciicon-tree.png )
10
11 @enum Dtk::Core::DDciFile::FileType
12 @var Dtk::Core::DDciFile::FileType Dtk::Core::DDciFile::UnknowFile
13 @brief 未知文件
14 @var Dtk::Core::DDciFile::FileType Dtk::Core::DDciFile::File
15 @brief 文件
16 @var Dtk::Core::DDciFile::FileType Dtk::Core::DDciFile::Directory
17 @brief 目录
18 @var Dtk::Core::DDciFile::FileType Dtk::Core::DDciFile::Symlink
19 @brief 软链接
20
21 @fn bool Dtk::Core::DDciFile::isValid()
22 @brief 判断读取的dci文件是否有效
23 @details 当指定的dci文件未成功加载时,此函数会返回false,一般会出现在文件格式错误(不是一个dci格式的文件),或者是dci文件数据被篡改而无法识别的情况
24 @note 本类中所有涉及文件操作的函数均会首先执行此方法,故如无必要,无需手动确保文件是否有效
25
26 @fn QString Dtk::Core::DDciFile::lastErrorString()
27 @brief 获取上一个报错信息,为人类可读字符串,可以通过此报错信息来获取错误内容,一般情况下是因为文件不存在或者文件名过长(>62个字符)导致。
28
29 @fn bool Dtk::Core::DDciFile::writeToFile(const QString &fileName)
30 @brief 写入文件,在做完对于dci文件的操作之后调用此接口,为保存的作用
31 @param[in] fileName 文件名
32
33 @fn bool Dtk::Core::DDciFile::writeToDevice(QIODevice *device)
34 @brief 写入到设备,设备指的是qt中的io设备,可以在qt文档中找到相关信息
35 @param[in] device IO设备
36 @sa [QIODevice](https://doc.qt.io/qt-6/qiodevice.html)
37
38 @fn QByteArray Dtk::Core::DDciFile::toData()
39 @brief 返回dci文件的原始数据,以QByteArray形式返回
40 @retval 如果返回为空字符串则说明读取失败
41 @sa DDciFile::writeFile
42
43 @fn static constexpr int Dtk::Core::DDciFile::metadataSizeV1()
44 @brief MAGIC_SIZE + VERSION_SIZE + FILE_COUNT_SIZE: 4+1+3 = 8
45
46 @fn QStringList Dtk::Core::DDciFile::list(const QString &dir, bool onlyFileName = false)
47 @brief 列出文件列表
48 @param[in] dir 文件夹地址
49 @param[in] onlyFileName 是否只显示文件名 默认为false
50
51 @fn int Dtk::Core::DDciFile::childrenCount(const QString &dir)
52 @brief 子文件计数
53
54 @fn bool Dtk::Core::DDciFile::exists(const QString &filePath)
55 @brief 判断文件是否存在
56 @param[in] filePath DCI图标结构路径
57
58 @fn FileType Dtk::Core::DDciFile::type(const QString &filePath)
59 @brief 判断文件类型
60 @sa DDciFile::FileType
61 @param[in] filePath DCI图标结构路径
62
63 @fn QByteArray Dtk::Core::DDciFile::dataRef(const QString &filePath)
64 @brief 获取dci内部文件的数据,以一种引用(软连接)的方式获取,不会产生数据的的复制
65 @param[in] filePath DCI图标结构路径
66 @retval 如果返回为空字符串,则说明此文件不存在或者无效
67
68 @fn QString Dtk::Core::DDciFile::name(const QString &filePath)
69 @brief 获取dci内文件的文件名
70 @param[in] filePath DCI图标结构路径
71 @retval 如果返回为空字符串,则说明此文件不存在或者无效
72
73 @fn QString Dtk::Core::DDciFile::symlinkTarget(const QString &filePath, bool originData = false)
74 @brief 获取软链目标
75 @param[in] filePath DCI图标结构路径
76 @param[in] originData
77 @retval 如果返回为空字符串,则说明此文件不存在或者无效
78 @note 链接的目标只能是“不存在的路径”、“文件”、“链接”,不可是目录
79
80 @fn bool Dtk::Core::DDciFile::mkdir(const QString &filePath)
81 @brief 创建目录(注意:此目录指的是在dci文件内部的目录,而不是指的是传统目录)
82 @param[in] filePath DCI图标结构路径
83 @return 操作是否成功
84
85 @fn bool Dtk::Core::DDciFile::writeFile(const QString &filePath, const QByteArray &data, bool override = false)
86 @brief 写入文件
87 @param[in] filePath DCI图标结构路径
88 @param[in] data 数据内容
89 @param[in] override 当文件已经存在时,是否覆盖此文件,默认状态下不执行覆盖,会在lasterror中记录"The target file is existed"错误信息。
90 如果传入为true,则会执行覆盖操作,** 此操作不可逆 **。
91 @return 操作是否成功
92 @sa QByteArray DDciFile::toData()
93
94 @fn bool Dtk::Core::DDciFile::remove(const QString &filePath)
95 @brief 移除文件
96 @param[in] filePath DCI图标结构路径
97 @return 操作是否成功
98
99 @fn bool Dtk::Core::DDciFile::rename(const QString &filePath, const QString &newFilePath, bool override = false)
100 @brief 重命名文件
101 @param[in] filePath DCI图标结构路径
102 @param[in] newFilePath 新文件的路径
103 @param[in] override 当文件已经存在时,是否覆盖此文件,默认状态下不执行覆盖,会在lasterror中记录"The target file is existed"错误信息。
104 如果传入为true,则会执行覆盖操作,** 此操作不可逆 **。
105 @return 操作是否成功
106
107 @fn bool Dtk::Core::DDciFile::link(const QString &source, const QString &to)
108 @brief 链接文件
109 @param[in] source 文件源
110 @param[in] to 链接目标
111 @return 操作是否成功
112
113 */