跳到正文
Yayin Story Studio Yayin Story Studio 项目文档

Visindigo::Utility::ConsoleFormat Class

class Visindigo::Utility::ConsoleFormat

ConsoleFormat是一个以非PIMPL值类形式表示控制台文本格式的类. 详情...

头文件: #include <ConsoleFormat>
自以下版本: Visindigo 0.17.0

公开成员函数

(自 Visindigo 0.17.0 引入) QString toString() const

静态公开成员

(自 Visindigo 0.17.0 引入) QString resetFormatStr()

详细说明

ConsoleFormat用一段文本及其前景色、背景色与样式表示一段控制台内容。 颜色统一以真彩QColor保存;通过Color枚举设置时,会映射为近似的真彩。 toString()输出带ANSI控制字符的文本(以 ESC 字符开头,形如 ESC[38;2;r;g;b 的前景色、ESC[48;2;r;g;b 的背景色与样式码,结尾用 ESC[0m 复位),输出格式与 Console::getColorString(rgb, styleList) 一致,并可由 Console::cmdColorToHtmlString() 正确解析为HTML。

此类从0.17.0开始,取代Visindigo::Utility::Console类中有关控制台文本格式的功能。

成员函数文档

[static, since Visindigo 0.17.0] QString ConsoleFormat::resetFormatStr()

返回固定的SGR复位控制码,用于结束一段带格式的文本。

这个function 从 Visindigo 0.17.0 开始支持。

[since Visindigo 0.17.0] QString ConsoleFormat::toString() const

转为带ANSI控制字符的文本。无任何颜色与样式时原样返回文本,不附加控制字符; 否则以前景38;2、背景48;2与各样式码组成SGR序列,并以 resetFormatStr() 复位结尾。

这个function 从 Visindigo 0.17.0 开始支持。