PySide6.QtGui.QTextDocumentFragment

class QTextDocumentFragment

QTextDocumentFragment 类表示来自 QTextDocument 的一段格式化文本。更多…

概要

方法

静态函数

注意

本文档可能包含从C++自动翻译到Python的代码片段。我们始终欢迎对代码片段翻译的贡献。如果您发现翻译问题，您也可以通过在我们的https:/bugreports.qt.io/projects/PYSIDE上创建工单来告知我们。

详细描述

一个QTextDocumentFragment是一个富文本片段，可以插入到QTextDocument中。文档片段可以从QTextDocument、QTextCursor的选择或另一个文档片段创建。文档片段也可以通过静态函数fromPlainText()和fromHtml()创建。

文档片段的内容可以通过使用toRawText()函数获取为原始文本，通过toPlainText()获取为ASCII文本，通过toHtml()获取为HTML，或通过toMarkdown()获取为Markdown。

__init__()

构造一个空的 QTextDocumentFragment 。

另请参阅

isEmpty()

__init__(range)
Parameters:

范围 – QTextCursor

从cursor的选择中创建一个QTextDocumentFragment。如果光标没有选择，创建的片段将是空的。

另请参阅

isEmpty() selection()

__init__(document)
Parameters:

文档 – QTextDocument

将给定的document转换为QTextDocumentFragment。请注意，QTextDocumentFragment仅存储文档内容，不存储文档的元信息，如文档标题。

__init__(rhs)
Parameters:

rhs – QTextDocumentFragment

复制构造函数。创建other片段的副本。

static fromHtml(html[, resourceProvider=None])
Parameters:
Return type:

QTextDocumentFragment

返回一个基于给定text中任意HTML片段的QTextDocumentFragment。格式尽可能保留；例如，“bold”将变成一个包含文本“bold”并带有粗体字符格式的文档片段。

如果提供的HTML包含对外部资源（如导入的样式表）的引用，则它们将通过resourceProvider加载。

static fromMarkdown(markdown[, features=QTextDocument.MarkdownDialectGitHub])
Parameters:
Return type:

QTextDocumentFragment

返回基于给定markdown文本的QTextDocumentFragment，并带有指定的features。默认为GitHub方言。

格式尽可能保留；例如，**bold** 将变成一个包含文本“bold”并带有粗体字符样式的文档片段。

注意

不支持加载外部资源。

static fromPlainText(plainText)
Parameters:

plainText – str

Return type:

QTextDocumentFragment

返回一个包含给定plainText的文档片段。

当将这样的片段插入到QTextDocument时，用于插入的QTextCursor的当前字符格式将用作文本的格式。

isEmpty()
Return type:

布尔

如果片段为空，则返回true；否则返回false。

toHtml()
Return type:

字符串

返回文档片段的内容为HTML。

toMarkdown([features=QTextDocument.MarkdownDialectGitHub])
Parameters:

特性 – MarkdownFeature 的组合

Return type:

字符串

返回文档片段的内容为Markdown格式，使用指定的features。默认为GitHub方言。

toPlainText()
Return type:

字符串

此函数返回与toRawText()相同的内容，但会将一些Unicode字符替换为ASCII替代字符。特别是，不间断空格（U+00A0）被替换为常规空格（U+0020），段落（U+2029）和行（U+2028）分隔符被替换为换行符（U+000A）。如果您需要文档的精确内容，请改用toRawText()。

toRawText()
Return type:

字符串

返回文档片段的文本为原始文本（即没有格式化信息）。