YSSCore::Editor::DocumentMessageManager Class
class YSSCore::Editor::DocumentMessageManager此类负责收集TextEdit在SyntaxHighligher着色过程中产生的DocumentMessage，并提供接口供外部查询这些消息. 详情...
| 头文件： | #include <DocumentMessageManager> |
| 自以下版本： | YSS 0.13.0 |
公开成员函数
(自 YSS 0.13.0 引入) | ~DocumentMessageManager() |
(自 YSS 0.13.0 引入) QMap<qint32, QList<YSSCore::Editor::DocumentMessage>> | getAllMessages(const QString &filePath) |
(自 YSS 0.16.0 引入) std::tuple<qint32, qint32, qint32> | getMessageCount(const QString &filePath) |
(自 YSS 0.13.0 引入) QList<YSSCore::Editor::DocumentMessage> | getMessages(const QString &filePath, qint32 lineNumber) |
(自 YSS 0.13.0 引入) bool | hasMessage(const QString &filePath) |
(自 YSS 0.13.0 引入) bool | hasMessage(const QString &filePath, qint32 lineNumber) |
静态公开成员
(自 YSS 0.13.0 引入) YSSCore::Editor::DocumentMessageManager * | getInstance() |
详细说明
DocumentMessageManager负责收集TextEdit在SyntaxHighligher着色过程中产生的DocumentMessage， 并提供接口供外部查询这些消息。它是一个单例类，可以通过getInstance()方法获取实例。
这个类目前不提供任何设置类API，其只提供查询功能。其内部与各TextEdit及其 SyntaxHighlighter的交互均被隐藏。
成员函数文档
[noexcept, since YSS 0.13.0] DocumentMessageManager::~DocumentMessageManager()
析构函数
这个function 从 YSS 0.13.0 开始支持。
[since YSS 0.13.0] QMap<qint32, QList<YSSCore::Editor::DocumentMessage>> DocumentMessageManager::getAllMessages(const QString &filePath)
filePath 要查询文件的绝对路径
return 指定文档的全部文档消息，键为行号，值为消息列表
如果整个文档都没有消息，则返回一个空的QMap。如果有文档消息，则只会包括那些有消息的行。
这个function 从 YSS 0.13.0 开始支持。
[static, since YSS 0.13.0] YSSCore::Editor::DocumentMessageManager *DocumentMessageManager::getInstance()
return 此类的单例
这个function 从 YSS 0.13.0 开始支持。
[since YSS 0.16.0] std::tuple<qint32, qint32, qint32> DocumentMessageManager::getMessageCount(const QString &filePath)
filePath 要查询文件的绝对路径
return 指定文件的消息计数。
返回值是一个元组，第一个值为错误，第二个值为警告，第三个值为消息
这个function 从 YSS 0.16.0 开始支持。
[since YSS 0.13.0] QList<YSSCore::Editor::DocumentMessage> DocumentMessageManager::getMessages(const QString &filePath, qint32 lineNumber)
filePath 要查询文件的绝对路径 lineNumber 要查询的行号，从0开始
return 指定的行的全部文档消息
如果这一行没有消息，则返回一个空的QList。
这个function 从 YSS 0.13.0 开始支持。
[since YSS 0.13.0] bool DocumentMessageManager::hasMessage(const QString &filePath)
filePath 要查询文件的绝对路径
return 指定的文件是否有文档消息
这个function 从 YSS 0.13.0 开始支持。
[since YSS 0.13.0] bool DocumentMessageManager::hasMessage(const QString &filePath, qint32 lineNumber)
filePath 要查询文件的绝对路径 lineNumber 要查询文件的行号，从0开始
return 指定的文件在指定的行是否有文档消息
这个function 从 YSS 0.13.0 开始支持。