DBaseFileWatcher 类提供了一系列接口可供监视文件和目录的变动。更多...

类 Dtk::Core::DBaseFileWatcher 继承关系图:

Public 类型
using	SignalType1 = void(DBaseFileWatcher::*)(const QUrl &)

using	SignalType2 = void(DBaseFileWatcher::*)(const QUrl &, const QUrl &)

信号
void	fileDeleted (const QUrl &url)
	文件被删除的信号

void	fileAttributeChanged (const QUrl &url)
	文件属性被改变的信号

void	fileMoved (const QUrl &fromUrl, const QUrl &toUrl)
	文件被移动的信号

void	subfileCreated (const QUrl &url)
	子文件被创建的信号

void	fileModified (const QUrl &url)
	文件被修改的信号

void	fileClosed (const QUrl &url)
	文件被关闭的信号

Public 成员函数
QUrl	fileUrl () const
	返回文件的统一资源定位符

bool	startWatcher ()
	开始监视文件变动

bool	stopWatcher ()
	停止监视文件变动

bool	restartWatcher ()
	重启监视文件变动

virtual void	setEnabledSubfileWatcher (const QUrl &subfileUrl, bool enabled=true)
	设置是否对`subfileUrl`目录启用文件监视

静态 Public 成员函数
static bool	ghostSignal (const QUrl &targetUrl, SignalType1 signal, const QUrl &arg1)
	发送一个信号表示目标目录`targetUrl`得到了一个`signal`信号，包含参数`arg1` 使用方式如下:

static bool	ghostSignal (const QUrl &targetUrl, SignalType2 signal, const QUrl &arg1, const QUrl &arg2)
	发送一个信号表示目标目录`targetUrl`得到了一个`signal`信号，包含参数`arg1`和`arg2`

Protected 成员函数
	DBaseFileWatcher (DBaseFileWatcherPrivate &dd, const QUrl &url, QObject *parent=0)

Protected 成员函数继承自 Dtk::Core::DObject
	DObject (DObject *parent=nullptr)

	DObject (DObjectPrivate &dd, DObject *parent=nullptr)

额外继承的成员函数
Protected 属性继承自 Dtk::Core::DObject
QScopedPointer< DObjectPrivate >	d_d_ptr

详细描述

DBaseFileWatcher 类提供了一系列接口可供监视文件和目录的变动。

注解: 建议使用 DFileWatcher 类，该类是 DBaseFileWatcher 的子类，提供了更多的功能。或者使用DFileWatcherManager类，该类提供了对文件和目录的监视功能。

警告: 该类是一个虚类，不应该被直接使用，而应该使用 DFileWatcher 类或者 DFileWatcherManager 类。

成员函数说明

◆ fileUrl()

QUrl Dtk::Core::DBaseFileWatcher::fileUrl ( ) const

返回文件的统一资源定位符

参见: QUrl

◆ ghostSignal() [1/2]

static bool Dtk::Core::DBaseFileWatcher::ghostSignal	(	const QUrl &	targetUrl,
		SignalType1	signal,
		const QUrl &	arg1
	)

static

发送一个信号表示目标目录targetUrl得到了一个signal信号，包含参数arg1
使用方式如下:

DBaseFileWatcher::ghostSignal(QUrl("bookmark:///"), &DBaseFileWatcher::fileDeleted, QUrl("bookmark:///bookmarkFile1"));

Dtk::Core::DBaseFileWatcher::ghostSignal

static bool ghostSignal(const QUrl &targetUrl, SignalType1 signal, const QUrl &arg1)

发送一个信号表示目标目录targetUrl得到了一个signal信号，包含参数arg1 使用方式如下:

Dtk::Core::DBaseFileWatcher::fileDeleted

void fileDeleted(const QUrl &url)

文件被删除的信号

返回: 成功发送返回 true,否则返回 false

◆ ghostSignal() [2/2]

static bool Dtk::Core::DBaseFileWatcher::ghostSignal	(	const QUrl &	targetUrl,
		DBaseFileWatcher::SignalType2	signal,
		const QUrl &	arg1,
		const QUrl &	arg2
	)

static

发送一个信号表示目标目录targetUrl得到了一个signal信号，包含参数arg1和arg2

示例用法:

DBaseFileWatcher::ghostSignal(QUrl("bookmark:///"), &DBaseFileWatcher::fileMoved, QUrl("bookmark:///bookmarkFile1"), QUrl("bookmark:///NewNameFile1"));

Dtk::Core::DBaseFileWatcher::fileMoved

void fileMoved(const QUrl &fromUrl, const QUrl &toUrl)

文件被移动的信号

◆ restartWatcher()

bool Dtk::Core::DBaseFileWatcher::restartWatcher ( )

重启监视文件变动

返回: true 成功 false 失败

参见: DBaseFileWatcher::startWatcher()

◆ setEnabledSubfileWatcher()

void Dtk::Core::DBaseFileWatcher::setEnabledSubfileWatcher	(	const QUrl &	subfileUrl,
		bool	enabled = `true`
	)

virtual

设置是否对subfileUrl目录启用文件监视

参数

[in]	subfileUrl	设置所针对的 Url
[in]	enabled	是否启用文件变动监视

◆ startWatcher()

bool Dtk::Core::DBaseFileWatcher::startWatcher ( )

开始监视文件变动

返回: true 成功 false 失败

参见: DBaseFileWatcher::stopWatcher

◆ stopWatcher()

bool Dtk::Core::DBaseFileWatcher::stopWatcher ( )

停止监视文件变动

返回: true 成功 false 失败

参见: DBaseFileWatcher::startWatcher()

该类的文档由以下文件生成:

include/filesystem/dbasefilewatcher.h
docs/filesystem/dbasefilewatcher.zh_CN.dox

Public 类型

信号

Public 成员函数

静态 Public 成员函数

Protected 成员函数

额外继承的成员函数