SearchResultWindow 类

class Core::SearchResultWindow

SearchResultWindow 类是常用搜索结果输出面板的实现。更多信息...

头文件	#include <coreplugin/find/searchresultwindow.h>
继承	Core::IOutputPane

包括继承成员在内的所有成员列表

公共类型

枚举	PreserveCaseMode { PreserveCaseEnabled, PreserveCaseDisabled }
枚举	SearchMode { SearchOnly, SearchAndReplace }

公共函数

void	openNewSearchPanel()
void	setTabWidth(int tabWidth)
Core::SearchResult *	startNewSearch(const QString &label, const QString &toolTip, const QString &searchTerm, Core::SearchResultWindow::SearchMode searchOrSearchAndReplace = SearchOnly, Core::SearchResultWindow::PreserveCaseMode preserveCaseMode = PreserveCaseEnabled, const QString &cfgGroup = QString())

公共槽

virtual void clearContents() override

静态公共成员

Core::SearchResultWindow * instance()

详细描述

每次你想向用户展示搜索结果列表，或者想要提供全局搜索和替换的 UI 时，请使用此类的单个实例。

除了实现输出面板，SearchResultWindow 还包含函数和枚举，使其他插件能够展示它们的搜索结果，并挂钩用户操作以选择条目和执行全局替换。

每次开始搜索时，请调用 startNewSearch(SearchMode) 来初始化 搜索结果 输出面板。参数确定是否显示替换的 GUI。该函数返回一个 SearchResult 对象，这是您连接到与该搜索相关的用户交互信号的钩子。当您生成搜索结果时，请调用 addResults() 或 addResult() 将其添加到 搜索结果 输出面板。搜索完成后再调用 finishSearch() 来通知 搜索结果 输出面板。

当用户选择搜索结果项时，您将通过您的 SearchResult 实例接收 activated() 信号。如果您使用了 SearchAndReplace 选项开始搜索，则当用户请求替换时，会发出 replaceButtonClicked() 信号。

成员类型文档

enum SearchResultWindow::PreserveCaseMode

此枚举类型指定搜索和替换是否应保留替换字符串的大小写

常量	值	描述
`Core::SearchResultWindow::PreserveCaseEnabled`	`0`	替换字符串时保存大小写。
`Core::SearchResultWindow::PreserveCaseDisabled`	`1`	替换字符串时使用给定的大小写。

枚举 SearchResultWindow::SearchMode

此枚举类型指定是否要显示替换用户界面。

常量	值	描述
`Core::SearchResultWindow::SearchOnly`	`0`	搜索不支持替换。
`Core::SearchResultWindow::SearchAndReplace`	`1`	搜索支持替换，因此显示相应的用户界面。

成员函数文档

`[覆盖虚槽]` void SearchResultWindow::clearContents()

重实现: IOutputPane::clearContents().

清除 搜索结果 输出窗口的当前内容。

`[静态]` Core::SearchResultWindow *SearchResultWindow::instance()

返回 搜索结果 输出窗口的单个共享实例。

void SearchResultWindow::openNewSearchPanel()

打开新的搜索面板。

void SearchResultWindow::setTabWidth(int tabWidth)

将 搜索结果 标签的宽度设置为 tabWidth。

Core::SearchResult SearchResultWindow::startNewSearch(const QString &label, const QString &toolTip, const QString &searchTerm, Core::SearchResultWindow::SearchMode searchOrSearchAndReplace* = SearchOnly, Core::SearchResultWindow::PreserveCaseMode preserveCaseMode = PreserveCaseEnabled, const QString &cfgGroup = QString())

通知 搜索结果 输出窗口启动新的搜索。

label 应该是一个描述搜索类型（即搜索过滤器以及可能的最相关的搜索选项）的字符串，后面跟着一个冒号（:）。例如：项目 'myproject': searchTerm 在冒号后面显示。

toolTip 应详细说明搜索参数，例如搜索的文件模式和查找标志。

如果 cfgGroup 不为空，它将用于存储 不要再次提出 警告的 此更改无法撤销 设置（这隐式地由传递一个非空组请求）。

searchOrSearchAndReplace 参数包含是否应显示全局搜索和替换操作的 UI。 preserveCaseMode 参数包含在替换字符串时是否应保留搜索字符串的大小写。

返回一个 SearchResult 对象，用于通知用户与此搜索结果的交互。搜索结果窗口拥有返回的 SearchResult 并可能在任何时间删除它，甚至当搜索正在运行时。例如，当用户清除 搜索结果 窗口时，或者当用户打开太多其他搜索以至于这次搜索偏离历史记录时。