Dtk::Search::DSearch类 参考

用于文件和文件内容搜索的类 更多...

#include <dsearch.h>

类 Dtk::Search::DSearch 继承关系图:

Dtk::Search::DSearch 的协作图:

信号
void	matched ()
void	completed ()
void	stoped ()

Public 成员函数
	DSearch (QObject *parent=nullptr)
	DSearch (quint32 maxResultCount, SearchFlags flags, QObject *parent=nullptr)
bool	search (const QString &path, const QString &keyword)
	发起搜索
bool	stop ()
	停止搜索
QStringList	matchedResults () const
	获取当前搜索结果
void	setResultFilter (const ResultFilterFunc &filter)
	设置搜索结果过滤器
void	setMaxResultCount (quint32 maxResultCount)
	设置最大搜索结果数量，应用与各搜索模式
quint32	maxResultCount () const
	获取最大搜索结果数
void	setSearchFlags (SearchFlags flags)
	设置搜索模式
SearchFlags	searchFlags () const
	获取当前搜索模式
void	setIndexPath (const QString &path)
	设置索引文件存储路径
QString	indexPath () const
	获取索引存储路径

属性
quint32	maxResultCount
SearchFlags	searchFlags
QString	indexPath

详细描述

用于文件和文件内容搜索的类

成员函数说明

indexPath()

QString DSearch::indexPath

(

)

const

获取索引存储路径

返回

存储路径

参见

void DSearch::setIndexPath(const QString &path)

matchedResults()

QStringList DSearch::matchedResults

(

)

const

获取当前搜索结果

返回

搜索结果列表

参见

void DSearch::matched()

maxResultCount()

quint32 DSearch::maxResultCount

(

)

const

获取最大搜索结果数

返回

最大搜索结果数

参见

void DSearch::setMaxResultCount(quint32 maxResultCount)

search()

bool DSearch::search	(	const QString &	path,
		const QString &	keyword
	)

发起搜索

参数

[in]	path	搜索目录
[in]	keyword	搜索关键词

返回

搜索任务是否创建成功

参见

bool DSearch::stop()

searchFlags()

SearchFlags DSearch::searchFlags

(

)

const

获取当前搜索模式

返回

搜索模式

参见

void DSearch::setSearchFlags(SearchFlags flags)

setIndexPath()

void DSearch::setIndexPath

(

const QString &

path

)

设置索引文件存储路径

参数

[in]

存储路径

参见

QString DSearch::indexPath() const

setMaxResultCount()

void DSearch::setMaxResultCount

(

quint32

maxResultCount

)

设置最大搜索结果数量，应用与各搜索模式

参数

[in]

maxResultCount

最大数量

参见

quint32 DSearch::maxResultCount() const

setResultFilter()

void DSearch::setResultFilter

(

const ResultFilterFunc &

filter

)

设置搜索结果过滤器

参数

[in]

filter

过滤函数

注解

将过滤掉 filter 返回为 true 的搜索结果

setSearchFlags()

void DSearch::setSearchFlags

(

SearchFlags

flags

)

设置搜索模式

参数

[in]

flags

搜索模式

参见

SearchFlags DSearch::searchFlags() const

stop()

bool DSearch::stop

(

)

停止搜索

返回

搜索停止任务是否发起成功

参见

bool DSearch::search(const QString &path, const QString &keyword)

void DSearch::stoped()

---

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

• include/dtksearch/dsearch.h
• docs/dtksearch/dsearch.zh_CN.dox