YSSCore::Editor::DocumentMessage Class
class YSSCore::Editor::DocumentMessageDocumentMessage代表文档特定位置的消息,如错误、警告或信息提示. 详情...
| 头文件: | #include <DocumentMessage> |
| 自以下版本: | YSS 0.13.0 |
公开类型
(自 YSS 0.13.0 引入) enum | MessageType { Error, Warning, Info } |
公开成员函数
| DocumentMessage(YSSCore::Editor::DocumentMessage::MessageType type, const QString &message, qint32 lineNumber = -1, qint32 columnNumber = -1, qint32 length = -1, const QString &code = "", const QUrl &helpUrl = QUrl(), const QString &fixeAdvice = "") | |
| DocumentMessage(const YSSCore::Editor::DocumentMessage &other) | |
| DocumentMessage(YSSCore::Editor::DocumentMessage &&other) | |
(自 YSS 0.13.0 引入) | ~DocumentMessage() |
(自 YSS 0.13.0 引入) QString | getCode() const |
(自 YSS 0.13.0 引入) int | getColumnNumber() const |
(自 YSS 0.13.0 引入) QString | getFixAdvice() const |
(自 YSS 0.13.0 引入) QUrl | getHelpUrl() const |
(自 YSS 0.13.0 引入) int | getLength() const |
(自 YSS 0.13.0 引入) int | getLineNumber() const |
(自 YSS 0.13.0 引入) QString | getMessage() const |
(自 YSS 0.13.0 引入) YSSCore::Editor::DocumentMessage::MessageType | getType() const |
(自 YSS 0.13.0 引入) QString | toString() const |
| YSSCore::Editor::DocumentMessage & | operator=(YSSCore::Editor::DocumentMessage &&other) |
| YSSCore::Editor::DocumentMessage & | operator=(const YSSCore::Editor::DocumentMessage &other) |
详细说明
DocumentMessage是个数据类,包含消息类型、文本、位置(行号、列号和长度)、 代码标识符、帮助链接和修复建议等信息。它被SyntaxHighlighter用于表示语法分析过程中发现的问题,并自动 收集到YSSCore::Editor::DocumentMessageManager中,供编辑器界面显示和用户交互使用。
成员类型文档
[since YSS 0.13.0] enum DocumentMessage::MessageType
| Constant | Value | Description |
|---|---|---|
YSSCore::Editor::DocumentMessage::Error | 0 | 错误消息,表示代码中的错误。 |
YSSCore::Editor::DocumentMessage::Warning | 1 | 警告消息,表示代码中的潜在问题或不推荐的用法。 |
YSSCore::Editor::DocumentMessage::Info | 2 | 信息消息,表示代码中的提示或建议。 |
这个enum 从 YSS 0.13.0 开始支持。
成员函数文档
DocumentMessage::DocumentMessage(YSSCore::Editor::DocumentMessage::MessageType type, const QString &message, qint32 lineNumber = -1, qint32 columnNumber = -1, qint32 length = -1, const QString &code = "", const QUrl &helpUrl = QUrl(), const QString &fixeAdvice = "")
构造一个DocumentMessage对象。 type 消息类型,如错误、警告或信息。 message 消息文本内容。 lineNumber 消息所在的行号(从0开始),默认为-1表示未知。 columnNumber 消息所在的列号(从0开始),默认为-1表示未知。 length 消息相关文本的长度,默认为-1表示未知。 code 消息的代码标识符,默认为空字符串。 helpUrl 与消息相关的帮助链接,默认为空URL。 fixeAdvice 修复建议文本,默认为空字符串。
DocumentMessage::DocumentMessage(const YSSCore::Editor::DocumentMessage &other)
复制构造函数
[noexcept] DocumentMessage::DocumentMessage(YSSCore::Editor::DocumentMessage &&other)
移动构造函数
[noexcept, since YSS 0.13.0] DocumentMessage::~DocumentMessage()
析构函数
这个function 从 YSS 0.13.0 开始支持。
[since YSS 0.13.0] QString DocumentMessage::getCode() const
获取消息的代码标识符。如果没有代码标识符,则返回空字符串。
这个function 从 YSS 0.13.0 开始支持。
[since YSS 0.13.0] int DocumentMessage::getColumnNumber() const
获取消息所在的列号(从0开始)。如果列号未知,则返回-1。
这个function 从 YSS 0.13.0 开始支持。
[since YSS 0.13.0] QString DocumentMessage::getFixAdvice() const
获取修复建议文本。如果没有修复建议,则返回空字符串。
这个function 从 YSS 0.13.0 开始支持。
[since YSS 0.13.0] QUrl DocumentMessage::getHelpUrl() const
获取与消息相关的帮助链接。如果没有帮助链接,则返回空URL。
这个function 从 YSS 0.13.0 开始支持。
[since YSS 0.13.0] int DocumentMessage::getLength() const
获取消息相关文本的长度。如果长度未知,则返回-1。
这个function 从 YSS 0.13.0 开始支持。
[since YSS 0.13.0] int DocumentMessage::getLineNumber() const
获取消息所在的行号(从0开始)。如果行号未知,则返回-1。
这个function 从 YSS 0.13.0 开始支持。
[since YSS 0.13.0] QString DocumentMessage::getMessage() const
获取消息文本内容。
这个function 从 YSS 0.13.0 开始支持。
[since YSS 0.13.0] YSSCore::Editor::DocumentMessage::MessageType DocumentMessage::getType() const
获取消息类型。
这个function 从 YSS 0.13.0 开始支持。
[since YSS 0.13.0] QString DocumentMessage::toString() const
将DocumentMessage对象转换为字符串表示形式,包含消息类型、位置、文本、代码和帮助链接等信息。 这是个辅助调试函数。
这个function 从 YSS 0.13.0 开始支持。
[noexcept] YSSCore::Editor::DocumentMessage &DocumentMessage::operator=(YSSCore::Editor::DocumentMessage &&other)
移动赋值运算符
other 要移动的源对象。
YSSCore::Editor::DocumentMessage &DocumentMessage::operator=(const YSSCore::Editor::DocumentMessage &other)
复制赋值运算符