搜索结果类

班级 核心::搜索结果

SearchResult 类报告用户交互,例如搜索结果项的激活。 更多...

头文件 #include <coreplugin/find/searchresultwindow.h>
继承 QObject

公共类型

枚举添加模式 { 添加按内容排序,添加按位置排序,添加有序 }

公共函数

QWidget *附加替换小部件() const
int计数() const
void设置附加替换小部件(QWidget *widget)
void设置重新搜索支持(bool supported)
void设置用户数据(const QVariant &data)
QString要替换的文本() const
QVariant用户数据() const

公共槽

void添加结果(const Utils::SearchResultItem &item)
void添加结果(const Utils::SearchResultItems &items, Core::SearchResult::AddMode mode)
void完成搜索(bool canceled, const QString &reason = {})
void弹出()
void重新启动()
void设置替换启用(bool enabled)
void设置重新搜索启用(bool enabled)
void设置要替换的文本(const QString &textToReplace)

信号

void激活(const Utils::SearchResultItem &item)
void已取消()
void计数已更改(int count)
void暂停(bool paused)
void替换按钮单击(const QString &replaceText,const Utils::SearchResultItems &checkedItems,bool preserveCase)
void请求重新搜索()
void可见性更改(bool visible)

详细描述

每当通过 startNewSearch 启动新的搜索时,返回此类的一个实例,以向启动者提供处理用户交互的挂钩。

成员类型文档

枚举 搜索结果::添加模式

此枚举类型指定是否需要按顺序或排序搜索结果

常量描述
Core::SearchResult::AddSortedByContent0搜索结果按字母顺序排序。
Core::SearchResult::AddSortedByPosition1搜索结果按搜索结果报告的行号排序。
Core::SearchResult::AddOrdered2搜索结果按报告的顺序排序。

成员函数文档

[信号] void SearchResult::activated(const Utils::SearchResultItem &item)

表示用户通过双击激活了搜索结果 ,例如。

[槽] void SearchResult::addResult(const Utils::SearchResultItem &item)

搜索结果输出窗口添加单个结果行。

item.mainRange()指定从搜索词的开头到其长度应当可视化的区域。item.path(), item.text()将在结果行中显示。您可以将任意item.userData()附加到搜索结果,这可以在例如响应您搜索的搜索结果信号时使用。

另请参阅addResults()。

[槽] void SearchResult::addResults(const Utils::SearchResultItems &items, Core::SearchResult::AddMode mode)

使用mode将搜索结果items添加到搜索结果输出窗口。

另请参阅addResult()。

QWidget *SearchResult::additionalReplaceWidget() const

返回全局搜索和替换操作的用户界面。

另请参阅setAdditionalReplaceWidget()。

[信号] void SearchResult::canceled()

如果用户取消搜索,则发出此信号。

int SearchResult::count() const

返回搜索匹配项的数量。

[信号] void SearchResult::countChanged(int count)

当搜索匹配项的数量变为count时,发出此信号。

[槽] void SearchResult::finishSearch(bool canceled, const QString &reason = {})

通知搜索结果输出窗口当前搜索因指定reason已被取消,用户界面应反映这一点。

[信号] void SearchResult::paused(bool paused)

在搜索状态设置为paused时发出此信号。

使用此搜索打开搜索结果输出窗口。

[信号] void SearchResult::replaceButtonClicked(const QString &replaceText, const Utils::SearchResultItems &checkedItems, bool preserveCase)

表示用户通过选择全部替换等操作启动了文本替换。

信号报告用于替换的文本,供replaceText使用,列表中的搜索结果项由用户在checkedItems中选择,以及搜索和替换是否应在preserveCase中保留替换字符串的大小写。此信号的处理程序应仅在所选项上应用替换。

[slot] void SearchResult::restart()

删除所有搜索结果。

[signal] void SearchResult::searchAgainRequested()

当选择再次搜索按钮时,发出此信号。

void SearchResult::setAdditionalReplaceWidget(QWidget *widget)

widget设置为全局搜索和替换操作的UI。

另请参阅additionalReplaceWidget().

[slot] void SearchResult::setReplaceEnabled(bool enabled)

设置替换是否启用以及是否可以被用户触发。

[slot] void SearchResult::setSearchAgainEnabled(bool enabled)

设置能否启用再次搜索按钮。

void SearchResult::setSearchAgainSupported(bool supported)

设置能否启用再次搜索按钮。

[slot] void SearchResult::setTextToReplace(const QString &textToReplace)

将用户可以输入替换搜索结果中文本的UI元素的值设置为textToReplace

另请参阅textToReplace().

void SearchResult::setUserData(const QVariant &data)

将一些随机数据附加到此搜索中,供以后使用。

另请参阅userData().

QString SearchResult::textToReplace() const

返回应替换搜索结果中文本的文本。

另请参阅setTextToReplace().

QVariant SearchResult::userData() const

返回调用setUserData时附加到此搜索的数据。

另请参阅setUserData().

[signal] void SearchResult::visibilityChanged(bool visible)

当搜索结果的可视性变为visible时发出此信号。

©2024 年 The Qt Company Ltd. 本文档中包含的贡献归各自所有者版权所有。本提供的文档在免费软件基金会的 GNU 自由文档许可(版本 1.3)下授权使用。Qt 及其相关标志为芬兰及全球其他地区的 The Qt Company Ltd. 的商标。所有其他商标均为各自所有者的财产。