Visindigo::General::PlaceholderProvider Class
class Visindigo::General::PlaceholderProviderPlaceholderProvider是占位符提供者的基类，插件可以通过继承这个类来创建自己的占位符提供者. 详情...
| 头文件： | #include <PlaceholderProvider> |
| 自以下版本： | Visindigo 0.13.0 |
| 继承自： | Visindigo::General::PluginModule |
公开成员函数
(自 Visindigo 0.13.0 引入) | PlaceholderProvider(Visindigo::General::Plugin *plugin, const QString &moduleID, const QString &providerName = "") |
(自 Visindigo 0.13.0 引入) virtual | ~PlaceholderProvider() |
(自 Visindigo 0.13.0 引入) QString | getPlaceholderName() const |
(自 Visindigo 0.13.0 引入) virtual QString | onPlaceholderRequest(const QString &name, const QString ¶m) = 0 |
详细说明
占位符提供者是一个插件模块，插件可以通过继承PlaceholderProvider来创建自己的占位符提供者。 每个占位符提供者都有一个唯一的ID，用于在占位符中引用。占位符的格式为$(ID::Name::Param)， 其中ID是占位符提供者的ID，Name是占位符的名称，Param是可选的参数。
成员函数文档
[since Visindigo 0.13.0] PlaceholderProvider::PlaceholderProvider(Visindigo::General::Plugin *plugin, const QString &moduleID, const QString &providerName = "")
plugin 插件实例指针，必须传入所属插件的实例。 moduleID 占位符提供者的模块ID，在本插件内唯一。当providerName不设置时，moduleID也将作为占位符提供者的ID使用。 providerName 占位符提供者的名称，用于在占位符中引用。如果不设置，则使用moduleID作为占位符提供者的ID。 构造函数。
这个function 从 Visindigo 0.13.0 开始支持。
[virtual noexcept, since Visindigo 0.13.0] PlaceholderProvider::~PlaceholderProvider()
析构函数
这个function 从 Visindigo 0.13.0 开始支持。
[since Visindigo 0.13.0] QString PlaceholderProvider::getPlaceholderName() const
return 占位符提供者的ID
这个function 从 Visindigo 0.13.0 开始支持。
[pure virtual, since Visindigo 0.13.0] QString PlaceholderProvider::onPlaceholderRequest(const QString &name, const QString ¶m)
当占位符被请求解析时，这个函数会被调用。 name 是占位符的名称， param 是占位符的参数。插件需要重写这个函数来返回占位符的值。
在编写这个函数时，不需要考虑嵌套和递归，它对这个函数屏蔽。只需要根据name和param返回正确的值即可。占位符解析系统会负责处理嵌套和递归的部分。
这个function 从 Visindigo 0.13.0 开始支持。