dtkio
dtk library for dtkio.
载入中...
搜索中...
未找到
信号 | Public 成员函数 | 所有成员列表
Dtk::IO::DFileMonitor类 参考

提供文件的监听操作 更多...

#include <dfilemonitor.h>

类 Dtk::IO::DFileMonitor 继承关系图:
Inheritance graph
[图例]
Dtk::IO::DFileMonitor 的协作图:
Collaboration graph
[图例]

信号

void fileChanged (const QUrl &url)
 监听的文件数据被改变
 
void fileDeleted (const QUrl &url)
 监听的文件被删除
 
void fileAdded (const QUrl &url)
 监听的文件下有新增的文件
 
void fileRenamed (const QUrl &fromUrl, const QUrl &toUrl)
 监听的文件被重命名（当前目录）
 

Public 成员函数

 DFileMonitor (const QUrl &url, QObject *parent=nullptr)
 构造函数, 通过 文件url 构造一个新的 DFileMonitor对象
 
DTK_CORE_NAMESPACE::DExpected< QUrl > url () const
 获取当前监听文件的url
 
DTK_CORE_NAMESPACE::DExpected< void > setTimeRate (quint32 msec)
 设置轮询间隔
 
DTK_CORE_NAMESPACE::DExpected< quint32 > timeRate () const
 获取当前轮询间隔
 
DTK_CORE_NAMESPACE::DExpected< void > setWatchType (WatchType type)
 设置监听类型
 
DTK_CORE_NAMESPACE::DExpected< WatchType > watchType () const
 获取监听类型
 
DTK_CORE_NAMESPACE::DExpected< bool > running () const
 获取当前监听状态（是否监听了文件）
 
DTK_CORE_NAMESPACE::DExpected< bool > start ()
 开始以设置的轮询间隔监听文件变化
 
DTK_CORE_NAMESPACE::DExpected< bool > start (quint32 timeRate=200)
 开始以输入的轮询间隔监听文件变化
 
bool stop ()
 停止监听
 
DTK_CORE_NAMESPACE::DError lastError () const
 获取当前文件操作的错误码
 

详细描述

提供文件的监听操作

构造及析构函数说明

◆ DFileMonitor()

DFileMonitor::DFileMonitor ( const QUrl &  url,
QObject *  parent = nullptr 
)
explicit

构造函数, 通过 文件url 构造一个新的 DFileMonitor对象

参数
[in]url文件url
[in]parent默认为空

成员函数说明

◆ fileAdded

void DFileMonitor::fileAdded ( const QUrl &  url)
signal

监听的文件下有新增的文件

参数
[out]url新增文件的url

◆ fileChanged

void DFileMonitor::fileChanged ( const QUrl &  url)
signal

监听的文件数据被改变

参数
[out]url数据被改变文件的url

◆ fileDeleted

void DFileMonitor::fileDeleted ( const QUrl &  url)
signal

监听的文件被删除

参数
[out]url被删除文件的url

◆ fileRenamed

void DFileMonitor::fileRenamed ( const QUrl &  fromUrl,
const QUrl &  toUrl 
)
signal

监听的文件被重命名（当前目录）

参数
[out]fromUrl文件被重命名前的url
[out]toUrl文件被重命名后的url

◆ lastError()

DError DFileMonitor::lastError ( ) const

获取当前文件操作的错误码

返回
当前文件操作的错误码

◆ running()

DExpected< bool > DFileMonitor::running ( ) const

获取当前监听状态（是否监听了文件）

返回
监听了文件则返回true，反之false

◆ setTimeRate()

DExpected< void > DFileMonitor::setTimeRate ( quint32  msec)

设置轮询间隔

参数
[in]msec轮询文件的时间间隔

◆ setWatchType()

DExpected< void > DFileMonitor::setWatchType ( WatchType  type)

设置监听类型

参数
[in]type监听类型枚举值（自动、目录、文件）

◆ start() [1/2]

DExpected< bool > DFileMonitor::start ( )

开始以设置的轮询间隔监听文件变化

返回
成功返回true，反之false

◆ start() [2/2]

DExpected< bool > Dtk::IO::DFileMonitor::start ( quint32  timeRate = 200)

开始以输入的轮询间隔监听文件变化

参数
[in]timeRate轮询间隔
返回
成功返回true，反之false

◆ stop()

bool DFileMonitor::stop ( )

停止监听

返回
成功返回true，反之false

◆ timeRate()

DExpected< quint32 > DFileMonitor::timeRate ( ) const

获取当前轮询间隔

返回
当前轮询的间隔时间

◆ url()

DExpected< QUrl > DFileMonitor::url ( ) const

获取当前监听文件的url

返回
监听文件的url字符串

◆ watchType()

DExpected< WatchType > DFileMonitor::watchType ( ) const

获取监听类型

返回
监听类型枚举值（自动、目录、文件）
该类的文档由以下文件生成: