ILocatorFilter 类

成员函数文档

ILocatorFilter::ILocatorFilter(QObject *parent = nullptr)

使用父对象构建定位器过滤器。从子类调用。

Utils::Id ILocatorFilter::actionId() const

返回过滤器的操作ID。

[静态] Qt::CaseSensitivity ILocatorFilter::caseSensitivity(const QString &str)

返回是否应对搜索项str进行大小写敏感或大小写不敏感的搜索。

[静态] QRegularExpression ILocatorFilter::createRegExp(const QString &text, Qt::CaseSensitivity caseSensitivity = Qt::CaseInsensitive, bool multiWord = false)

使用给定的caseSensitivity创建搜索项text作为正则表达式。如果模式预期包含空格，则传递true到multiWord。

QString ILocatorFilter::description() const

返回关于过滤器所做工作的更长的、可读性更强的描述。

另请参阅setDescription()。

QString ILocatorFilter::displayName() const

返回过滤器的翻译后显示名称。

另请参阅 setDisplayName。

[静态] Core::LocatorFilterEntry::HighlightInfo ILocatorFilter::highlightInfo(const QRegularExpressionMatch &match, Core::LocatorFilterEntry::HighlightInfo::DataType dataType = LocatorFilterEntry::HighlightInfo::DisplayName)

返回关于使用由match指定的正则表达式匹配结果进行高亮显示的信息，用于类型为dataType的数据。

Utils::Id ILocatorFilter::id() const

返回过滤器的唯一标识符。

另请参阅 setId。

bool ILocatorFilter::isConfigurable() const

返回此过滤器是否有可用的配置对话框。

默认值为true。

另请参阅 setConfigurable。

bool ILocatorFilter::isEnabled() const

返回过滤器目前是否可用。禁用的过滤器在菜单中不可见，也不包含在搜索中，即使搜索以它们的快捷字符串开头。

默认值为true。

另请参阅 setEnabled。

bool ILocatorFilter::isHidden() const

返回过滤器是否应在定位器过滤器过滤器、菜单和定位器设置中隐藏。

默认值为false。

另请参阅 setHidden。

bool ILocatorFilter::isIncludedByDefault() const

返回是否需要使用快捷字符串才能使用此过滤器。默认值为false。

另请参阅 shortcutString() 和 setIncludedByDefault。

[静态] QString ILocatorFilter::msgConfigureDialogTitle()

指定配置对话框的标题。

[静态] QString ILocatorFilter::msgIncludeByDefault()

指定配置对话框中默认包含输入字段的标签。

[静态] QString ILocatorFilter::msgIncludeByDefaultToolTip()

指定配置对话框中默认包含输入字段的工具提示。

[静态] QString ILocatorFilter::msgPrefixLabel()

指定配置对话框中前缀输入字段的标签。

[静态] QString ILocatorFilter::msgPrefixToolTip()

指定配置对话框中前缀输入字段的工具提示。

[虚拟] bool ILocatorFilter::openConfigDialog(QWidget *parent, bool &needsRefresh)

打开一个用于parent小部件的对话框，允许用户配置过滤器的各个方面。当用户请求配置过滤器时调用。

如果关闭对话框后需要刷新，将needsRefresh设置为true。如果用户取消了对话框，则返回false。

默认实现允许更改快捷键以及默认情况下是否包括过滤器。

另请参阅刷新配方。

[保护] bool ILocatorFilter::openConfigDialog(QWidget *parent, QWidget *additionalWidget)

显示标准配置对话框，具有用于前缀字符串和是否默认包括的选项。将additionalWidget添加到顶部。对additionalWidget的所有权仍属于调用者，但其父对象被重置为nullptr。

如果用户取消了对话框，则返回false。

Core::ILocatorFilter::Priority ILocatorFilter::priority() const

返回用于当使用多个过滤器时对结果进行排序的优先级。

默认为ILocatorFilter::Medium。

另请参阅设置优先级。

[保护] std::optional<Tasking::GroupItem> ILocatorFilter::refreshRecipe() const

返回用于刷新缓存数据的刷新配方。默认情况下，定位过滤器未设置配方，因此不会刷新。

void ILocatorFilter::restoreState(const QByteArray &state)

从以前由saveState创建的数据中还原过滤器的state。

另请参阅saveState。

[虚拟保护] void ILocatorFilter::restoreState(const QJsonObject &object)

从JSON object中读取过滤器设置和状态

默认实现不执行任何操作。

实现应从object中读取其自定义设置，并将任何缺失的设置重置为其默认值。

QByteArray ILocatorFilter::saveState() const

返回可用于还原此过滤器设置的数据（例如在启动时）。默认情况下，添加基本设置（快捷键字符串，默认包括）并将JSON对象传递给saveState()，其中子类应写入其自定义设置。

另请参阅restoreState。

[虚拟受保护] void ILocatorFilter::saveState(QJsonObject &object) const

将过滤器设置和状态保存到JSON 对象。

默认实现不执行任何操作。

实现类应将自定义设置的关键值对写入到对象中，这些设置与默认设置不同。默认值不应被保存。

[受保护] void ILocatorFilter::setConfigurable(bool configurable)

设置过滤器是否提供配置对话框供configurable使用。大多数过滤器至少应该提供默认对话框。

另请参阅isConfigurable().

void ILocatorFilter::setDefaultIncludedByDefault(bool includedByDefault)

设置默认设置，以确定是否需要使用快捷字符串才能使用此过滤器includedByDefault。

例如，从子类的构造函数中调用。

另请参阅isIncludedByDefault().

void ILocatorFilter::setDefaultShortcutString(const QString &shortcut)

设置默认的shortcut字符串，该字符串可以用于在定位器输入字段中明确选择此过滤器。例如，从子类的构造函数中调用。

另请参阅shortcutString().

void ILocatorFilter::setDescription(const QString &description)

设置描述过滤器功能的更长的、可读性更强的description。

另请参阅description().

void ILocatorFilter::setDisplayName(const QString &displayString)

设置此过滤器的翻译显示名称为displayString。

子类必须在它们的构造函数中设置显示名称。

另请参阅displayName().

[slot] void ILocatorFilter::setEnabled(bool enabled)

设置过滤器当前是否可用enabled。

另请参阅isEnabled().

[受保护] void ILocatorFilter::setHidden(bool hidden)

设置过滤器在定位器过滤器过滤器、菜单和定位器设置中为hidden。在子类的构造函数中调用。

另请参阅isHidden().

[受保护] void ILocatorFilter::setId(Utils::Id id)

设置过滤器的唯一id。子类必须在它们的构造函数中设置ID。

另请参阅id().

void ILocatorFilter::setIncludedByDefault(bool includedByDefault)

设置是否使用快捷字符串是必需的以使用此过滤器来插入includedByDefault。如果想要设置默认值，请使用setDefaultIncludedByDefault()。

另请参阅 isIncludedByDefault() 和 setDefaultIncludedByDefault。

[受保护] void ILocatorFilter::setPriority(Core::ILocatorFilter::Priority priority)

设置此过滤器在结果列表中的结果优先级。

另请参阅 priority。

void ILocatorFilter::setShortcutString(const QString &shortcut)

设置过滤器的当前快捷字符串为shortcut。如果想要设置默认快捷字符串，请使用setDefaultShortcutString()。

另请参阅 shortcutString() 和 setDefaultShortcutString。

QString ILocatorFilter::shortcutString() const

指定一个快捷字符串，可以通过在搜索词前加上快捷字符串和一个空格来显式选择此过滤器。

默认值为空字符串。

另请参阅 setShortcutString。