Sublime QuickSearchEnhanced 插件

为其他插件使用Sublime的quick_search提供API的插件。

安装

此插件是sublime-enhanced插件的组成部分。您可以安装sublime-enhanced，然后此插件将自动安装。

如果您想单独安装此插件，请检查sublime-enhanced插件的“单独安装插件”部分。

依赖项

无

API

模块中有两个可用的类

• QuickSearches - 用于打开的面板的容器；此类由“panels”变量预先实例化。

• QuickSearch - 快速搜索面板

通过“create”函数创建快速搜索面板。面板是可堆叠的（新面板在显示时隐藏之前的面板，关闭时显示之前的面板）。

请注意，在回调中运行的代码（由于其内部故障）可能导致Sublime崩溃。因此，请谨慎使用此插件。

QuickSearches.create(values = [], open = None, close = None, preview = None, text = '', callers = [], on_create = None, index = 0)

创建一个快速搜索面板。

参数

• values - values之后的列表

  • [string, string, …] - 字符串列表。
  • [[value, line1, line2, …], [value, line1, line2, …]] - 列表列表；value - 任何值；line1, line2, lineN - 字符串；注意，行数始终应该是相同的，否则预期Sublime会有意外的行为。

• open(QuickSearch) - 打开回调；当用户在列表中按下enter时会调用回调；回调接收QuickSearch实例作为参数。

• close(QuickSearch) - 关闭回调；关闭面板时会调用回调。

• preview(QuickSearch) - 预览回调；当用户在列表中选中一个项时会调用回调。

• text - 初始化时在面板中输入的文本。

• 调用者 - 当在面板上发布命令以获取面板实例时，调用者列表采用以下格式：[[名称，对象]，…]，其中名称是调用者的名称，对象 - 调用者实例；这在需要检查搜索面板是否包含特定信息或在打开了面板的实例上执行命令时很有用。

• 索引 - 初始选择的索引。

结果

快速搜索；创建面板；请注意，面板在通过.show()命令创建后必须显示出来；

示例

from QuickSearchEnhanced import quick_search
  panel = quick_search.panels.create(
    ['a', 'b', 'c'],
    lambda panel: print(panel.get_current_value())
  )

QuickSearches.close_all()

关闭所有面板。

QuickSearches.remove面板)

从堆栈中删除给定的面板。

参数

• 面板 - QuickSearch；要删除的面板

QuickSearches.get_current()

返回当前打开的面板（QuickSearch）。

QuickSearch.show()

显示面板。请注意，它将隐藏当前打开的面板。

QuickSearch.get_values()

获取搜索面板中所有值。

QuickSearch.set_values(values)

设置面板的新值。

QuickSearch.set_text(text)

设置面板的新文本。

QuickSearch.get_callers()

获取搜索面板的所有调用者。有关信息，请参阅上方QuickSearches.create()中的“调用者”参数。返回调用者列表。

QuickSearch.get_caller(name)

返回具有指定名称的调用者。如果没有找到调用者，则返回None。

QuickSearch.get_current_index()

返回当前选择的索引。

QuickSearch.get_current_value()

返回当前选择的价值。如果没有选择值，则返回None。

QuickSearch.get_current_description()

返回当前选择的描述列表（行）。

QuickSearch.get_current_text()

返回当前文本。

QuickSearch.get_panel()

返回打开面板的底层视图。

QuickSearch.get_opener()

返回面板显示时聚焦的视图。

QuickSearch.is_visible()

指示面板是否可见。

QuickSearch.close(index = -1, call = True)

关闭面板。面板将从当前面板栈中删除。

参数

index - 整数；值的索引；如果index == -1，则使用最后选择的索引。

call - 布尔值；如果为True，则调用打开回调。

QuickSearch.hide()

隐藏面板。可以使用show()方法稍后再次显示面板。面板将不会从面板栈中删除。

QuickSearch.refresh()

刷新面板内容。如果其中一个调用者响应“refresh”方法，则将在面板重新绘制之前首先调用栈中较早的调用者的“refresh”方法。