Debian Codegraph @

docs/filesystem/dbasefilewatcher.zh_CN.dox

raw
1 /*!
2 @~chinese
3 @ingroup dfilesystem
4 @file include/filesystem/dbasefilewatcher.h
5
6 @class Dtk::Core::DBaseFileWatcher
7 @brief DBaseFileWatcher 类提供了一系列接口可供监视文件和目录的变动。
8 @note 建议使用 DFileWatcher 类,该类是 DBaseFileWatcher 的子类,提供了更多的功能。或者使用DFileWatcherManager类,该类提供了对文件和目录的监视功能。
9 @warning 该类是一个虚类,不应该被直接使用,而应该使用 DFileWatcher 类或者 DFileWatcherManager 类。
10
11 @fn QUrl Dtk::Core::DBaseFileWatcher::fileUrl()
12 @brief 返回文件的统一资源定位符
13 @sa [QUrl](https://doc.qt.io/qt-5/qurl.html)
14
15 @fn bool Dtk::Core::DBaseFileWatcher::startWatcher()
16 @brief 开始监视文件变动
17 @return true 成功 false 失败
18 @sa DBaseFileWatcher::stopWatcher
19
20 @fn bool Dtk::Core::DBaseFileWatcher::stopWatcher()
21 @brief 停止监视文件变动
22 @return true 成功 false 失败
23 @sa DBaseFileWatcher::startWatcher()
24
25 @fn bool Dtk::Core::DBaseFileWatcher::restartWatcher()
26 @brief 重启监视文件变动
27 @return true 成功 false 失败
28 @sa DBaseFileWatcher::startWatcher()
29
30 @fn virtual void Dtk::Core::DBaseFileWatcher::setEnabledSubfileWatcher(const QUrl &subfileUrl, bool enabled = true)
31 @brief 设置是否对`subfileUrl`目录启用文件监视
32 @param[in] subfileUrl 设置所针对的 Url
33 @param[in] enabled 是否启用文件变动监视
34
35 @fn static bool Dtk::Core::DBaseFileWatcher::ghostSignal(const QUrl &targetUrl, SignalType1 signal, const QUrl &arg1)
36 @brief 发送一个信号表示目标目录`targetUrl`得到了一个`signal`信号,包含参数`arg1`<br>
37 使用方式如下:
38 @code
39 DBaseFileWatcher::ghostSignal(QUrl("bookmark:///"), &DBaseFileWatcher::fileDeleted, QUrl("bookmark:///bookmarkFile1"));
40 @endcode
41 @return 成功发送返回 true,否则返回 false
42
43 @fn static bool Dtk::Core::DBaseFileWatcher::ghostSignal(const QUrl &targetUrl, DBaseFileWatcher::SignalType2 signal, const QUrl &arg1, const QUrl &arg2)
44 @brief 发送一个信号表示目标目录`targetUrl`得到了一个`signal`信号,包含参数`arg1`和`arg2`<br>
45 @details 示例用法:
46 @code
47 DBaseFileWatcher::ghostSignal(QUrl("bookmark:///"), &DBaseFileWatcher::fileMoved, QUrl("bookmark:///bookmarkFile1"), QUrl("bookmark:///NewNameFile1"));
48 @endcode
49
50 @var Dtk::Core::DBaseFileWatcher::fileDeleted(const QUrl &url)
51 @brief 文件被删除的信号
52
53 @var Dtk::Core::DBaseFileWatcher::fileMoved(const QUrl &fromUrl, const QUrl &toUrl)
54 @brief 文件被移动的信号
55
56 @var Dtk::Core::DBaseFileWatcher::fileAttributeChanged(const QUrl &url)
57 @brief 文件属性被改变的信号
58
59 @var Dtk::Core::DBaseFileWatcher::subfileCreated(const QUrl &url)
60 @brief 子文件被创建的信号
61
62 @var Dtk::Core::DBaseFileWatcher::fileClosed(const QUrl &url)
63 @brief 文件被关闭的信号
64
65 @var Dtk::Core::DBaseFileWatcher::fileModified(const QUrl &url)
66 @brief 文件被修改的信号
67
68 */