YSSCore::Editor::HoverInfoProvider Class
class YSSCore::Editor::HoverInfoProviderHoverInfoProvider使用户可以向TextEdit提供鼠标悬停提示信息. 详情...
| 头文件： | #include <HoverInfoProvider> |
| 自以下版本： | YSS 0.13.0 |
- 所有成员列表（包含继承成员）
- HoverInfoProvider 是该集合的一部分：语言服务框架.
公开类型
(自 YSS 0.13.0 引入) enum | Format { PlainText, Markdown, Html } |
公开成员函数
(自 YSS 0.13.0 引入) | HoverInfoProvider(YSSCore::Editor::TextEdit *textEdit) |
(自 YSS 0.13.0 引入) void | setContent(const QString &content, YSSCore::Editor::HoverInfoProvider::Format format) |
(自 YSS 0.13.0 引入) void | setHtml(const QString &html) |
(自 YSS 0.13.0 引入) void | setMarkdown(const QString &md) |
(自 YSS 0.13.0 引入) void | setPlainText(const QString &text) |
(自 YSS 0.13.0 引入) bool | triggerFromHover() |
详细说明
HoverInfoProvider使用户可以向TextEdit提供鼠标悬停提示信息。当用户在TextEdit中悬停鼠标、 或正在编辑中时，就会调用该类的onMouseHover函数，并传入当前鼠标所在位置的行列号以及该位置的文本内容。 用户可以在该函数中根据需要设置悬停提示信息的内容和格式。
在实现onMouseHover函数时，你可以调用setContent、setPlainText、setMarkdown或setHtml函数来设置悬停提示信息的内容和格式。
此外，还可以通过triggerFromHover函数来判断当前的悬停提示信息是否是由鼠标悬停触发的，还是由编辑操作触发的。 这对于一些需要区分这两种情况的功能实现可能会有帮助。
如果你决定不进行任何提示，只需要在onMouseHover函数中不调用任何设置内容的函数即可。TextEdit会根据是否设置了内容来决定是否显示悬停提示信息。
成员类型文档
[since YSS 0.13.0] enum HoverInfoProvider::Format
| Constant | Value | Description |
|---|---|---|
YSSCore::Editor::HoverInfoProvider::PlainText | 0 | 纯文本格式 |
YSSCore::Editor::HoverInfoProvider::Markdown | 1 | Markdown格式 |
YSSCore::Editor::HoverInfoProvider::Html | 2 | HTML格式 |
这个enum 从 YSS 0.13.0 开始支持。
成员函数文档
[since YSS 0.13.0] HoverInfoProvider::HoverInfoProvider(YSSCore::Editor::TextEdit *textEdit)
textEdit 要提供悬停提示信息的TextEdit对象。
构造函数
这个function 从 YSS 0.13.0 开始支持。
[since YSS 0.13.0] void HoverInfoProvider::setContent(const QString &content, YSSCore::Editor::HoverInfoProvider::Format format)
content 要设置的悬停提示信息内容。 format 要设置的悬停提示信息格式。
设置悬停提示信息的内容和格式。你可以在onMouseHover函数中调用该函数来设置悬停提示信息。
这个function 从 YSS 0.13.0 开始支持。
[since YSS 0.13.0] void HoverInfoProvider::setHtml(const QString &html)
html 要设置的HTML内容。
用于设置悬停提示信息的内容为HTML格式。你可以在onMouseHover函数中调用该函数来设置悬停提示信息。
这个function 从 YSS 0.13.0 开始支持。
[since YSS 0.13.0] void HoverInfoProvider::setMarkdown(const QString &md)
md 要设置的Markdown内容。
用于设置悬停提示信息的内容为Markdown格式。你可以在onMouseHover函数中调用该函数来设置悬停提示信息。
这个function 从 YSS 0.13.0 开始支持。
[since YSS 0.13.0] void HoverInfoProvider::setPlainText(const QString &text)
text 要设置的纯文本内容。
用于设置悬停提示信息的内容为纯文本格式。你可以在onMouseHover函数中调用该函数来设置悬停提示信息。
这个function 从 YSS 0.13.0 开始支持。
[since YSS 0.13.0] bool HoverInfoProvider::triggerFromHover()
return 当前的悬停提示信息是否是由鼠标悬停触发的，还是由编辑操作触发的。
这个function 从 YSS 0.13.0 开始支持。