class QTextDocument#

QTextDocument 类包含格式化文本。《更多》…

Inheritance diagram of PySide6.QtGui.QTextDocument

概述#

属性#

方法#

虚方法#

槽函数#

信号#

备注

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

详细说明#

QTextDocument是一个结构化富文本文档的容器，提供了支持样式文本和多种类型的文档元素，如列表、表格、框架和图像。它们可以用于QTextEdit中，也可以独立使用。

每个文档元素由一个相关的格式对象描述。QTextDocuments会将每个格式对象视为一个独特的对象，并将其传递给objectForFormat()方法以获取应用于该文档元素的内容。

QTextDocument可以使用QTextCursor进行程序性编辑，并可以通过遍历文档结构来检查其内容。整个文档结构以根框架下的文档元素层次结构存储，可通过rootFrame()函数找到。或者，如果您只是想遍历文档的文本内容，可以使用begin()、end()和findBlock()来检索您可以检查和遍历的文本块。

文档布局由documentLayout()函数确定；如果要使用自定义布局逻辑，可以创建自己的QAbstractTextDocumentLayout子类，并使用setDocumentLayout()设置它。可以通过调用metaInformation()函数来获取文档的标题和其他元信息。对于通过QTextEdit类向用户暴露的文档，还可以通过QTextEdit::documentTitle()函数获取文档标题。

方便函数toPlainText()和toHtml()允许您以纯文本和HTML格式检索文档内容。可以使用find()函数在文档的文本中进行搜索。

可以使用setUndoRedoEnabled()函数控制对文档执行的操作的撤销/重做。可以通过编辑小部件的undo()和redo()槽来控制撤销/重做系统；文档还提供了contentsChanged()、undoAvailable()和redoAvailable()信号，以通知连接的编辑小部件撤销/重做系统的状态。以下是一个QTextDocument的撤销/重做操作：

  • 插入或删除字符。同一文本块内的一系列插入或删除被视为一个撤销/重做操作。

  • 插入或删除文本块。单个操作中的一系列插入或删除（例如，通过选择然后删除文本）被视为一个撤销/重做操作。

  • 文本字符格式更改。

  • 文本块格式更改。

  • 文本块组格式更改。

另请参阅

QTextCursor 富文本处理

class MetaInformation#

此枚举描述可以添加到文档中的不同类型的元信息。

常量

描述

QTextDocument.DocumentTitle

文档的标题。

QTextDocument.DocumentUrl

文档的URL。当调用loadResource() 函数时，将使用此 URL 作为加载相对资源的基准。

QTextDocument.CssMedia

在调用 setHtml() 时，此值用于从指定的 CSS 样式表中选择相应的

另请参阅

metaInformation() setMetaInformation() setHtml()

class MarkdownFeature#
class FindFlag#

(继承 enum.Flag) 此枚举描述了 QTextDocument 寻找函数可用的选项。这些选项可以是从以下列表中 OR 操作得出的：

常量

描述

QTextDocument.FindBackward

反向查找而不是正向查找。

QTextDocument.FindCaseSensitively

默认情况下，查找是不区分大小写的。指定此选项会将行为更改为区分大小写的查找操作。

QTextDocument.FindWholeWords

使查找匹配完整的单词。
class ResourceType#

(继承 enum.IntEnum) 此枚举描述了 QTextDocument 的 loadResource() 函数或 QTextBrowser::setSource() 可以加载的资源类型。

常量

描述

QTextDocument.UnknownResource

未加载任何资源，或者未知资源类型。

QTextDocument.HtmlResource

资源包含 HTML。

QTextDocument.ImageResource

资源包含图像数据。目前支持的数据类型是 QMetaType::QPixmap 和 QMetaType::QImage。如果相应的变体类型为 QMetaType::QByteArray，则 Qt 尝试使用 loadFromData 加载图像。目前不支持 QMetaType::QIcon。图标需要首先转换为支持的类型，例如使用 pixmap 。

QTextDocument.StyleSheetResource

资源包含 CSS。

QTextDocument.MarkdownResource

资源包含 Markdown。

QTextDocument.UserResource

用户定义资源类型的第一可访问值。

另请参阅

loadResource() sourceType()

class Stacks#

常量

描述

QTextDocument.UndoStack

撤销堆栈。

QTextDocument.RedoStack

重做堆栈。

QTextDocument.UndoAndRedoStacks

撤销和重做堆栈。

新出现在版本 4.7。

备注

在from __feature__ import true_property被使用的情况下可以直接使用属性，否则通过访问器函数。

property baseUrlᅟ: QUrl#

该属性持有用于解决文档中相对资源URL的基础URL。

资源URL将解析为基础URL的同一目录内，这意味着路径中最后‘/’之后的部分将被忽略。

访问函数
property blockCountᅟ: int#

该属性持有文档中文本块的数量。

在包含表格或框架的文档中，此属性的值未定义。

默认情况下，如果已定义，此属性包含值为1。

访问函数
property defaultFontᅟ: QFont#

该属性持有用于显示文档文本的默认字体。

访问函数
property defaultStyleSheetᅟ: str#

默认样式表被应用于所有新插入文档中的 HTML 格式文本，例如使用 setHtml() 或 insertHtml() 方法。

样式表需要遵循 CSS 2.1 语法。

备注

更改默认样式表不会对文档的现有内容产生影响。

另请参阅

支持的 HTML 子集

访问函数
属性documentMargin: float#

文档周围的边距。默认值为 4。

访问函数
属性indentWidth: float#

返回用于文本列表和文本块缩进的宽度。

文本列表格式 QTextListFormat 和文本块格式 QTextBlockFormat 的缩进属性指定此值的倍数。默认缩进宽度为 40。

访问函数
属性layoutEnabled: bool#

此属性表示 QTextDocument 是否应该在每次更改后重新计算布局。

如果此属性设置为 true，对文档的任何更改将触发布局，这使得一切按预期工作，但需要时间。

在执行多个更改（不仅是文本内容，还包括默认字体、默认文本选项等）时暂时禁用布局可以节省时间，这样文档只会在最后进行一次布局。在文本宽度或页面大小尚不清楚的情况下，这可能很有用。

默认情况下，此属性为 true。

另请参阅

setTextWidth

访问函数
属性maximumBlockCount: int#

此属性指定文档中块的限制。

指定文档可有的最大块数。如果文档中的块数多于此属性指定的块数，则从文档开始处删除块。

负值或零值指定文档可以包含无限数量的块。

默认值为 0。

请注意，设置此属性将立即将限制应用于文档内容。

设置此属性还会禁用撤销重做历史记录。

在包含表格或框架的文档中，此属性未定义。

访问函数
属性 modified: bool#

此属性表示文档是否被用户修改过。

默认情况下，此属性为 false。

另请参阅

modificationChanged()

访问函数
属性 pageSize: QSizeF#

此属性表示用于布局文档的页面大小。

单位由底层绘图设备确定。当将图像绘制到屏幕时，大小以逻辑像素为单位；当将图像绘制到打印机时，大小以点（1/72英寸）为单位。

默认情况下，对于新建的空文档，此属性包含一个未定义的大小。

另请参阅

modificationChanged()

访问函数
属性 size: QSizeF#

此属性表示文档的实际大小。这与 documentLayout() ->documentSize(); 相等。

可以通过设置文本宽度或设置整个页面大小来更改文档的大小。

请注意，宽度始终 >= pageSize() .width()。

默认情况下，对于新建的空文档，此属性包含一个依赖于配置的尺寸。

访问函数
属性 textWidth: float#

文本宽度指定文档中文本的首选宽度。如果文本（或内容）的宽度超过指定的宽度，它将被拆分成多个行并垂直增长。如果文本不能拆分成多行以适应指定的文本宽度，它将更大，并且 size() 和 idealWidth() 属性将反映这一点。

如果将文本宽度设置为 -1，则不会将文本拆分成多行，除非通过显式的换行符或新段落来强制执行。

默认值是 -1。

设置文本宽度也将设置页面高度为-1，导致文档在垂直方向上连续增长或收缩。如果您想让文档布局在多页中拆分文本，则必须设置pageSize属性。

访问函数
property undoRedoEnabled: bool#

此属性表示是否为此文档启用撤销/重做。

默认为true。如果禁用，则撤销堆栈将被清除，且不会向其中添加任何项。

访问函数
property useDesignMetrics: bool#

此属性表示文档是否使用字体设计指标以改进文本布局的准确性。

如果此属性设置为true，则布局将使用设计指标。否则，将使用设置在setPaintDevice()上的绘制设备的指标。

使用设计指标使布局宽度不再依赖于光照和像素舍入。这意味着，因为宽度根据绘制设备指标进行线性缩放的程度要大得多，所以所见即所得（WYSIWYG）文本布局成为可能。

默认情况下，此属性为 false。

访问函数
__init__(text[, parent=None])#
参数:

构建一个包含指定的说明（未格式化）的QTextDocument，并具有指定的parent。

__init__([parent=None])
参数:

parent – QObject

构建一个空的QTextDocument，并具有给定的parent。

addResource(type, name, resource)#
参数:

  • type – int

  • name – QUrl

  • resource – 对象

警告：

本节包含从C++自动翻译到Python的代码片段，可能包含错误。

使用 type 和 name 作为标识符将资源 resource 添加到资源缓存中。type 应该是来自 ResourceType 的值。

例如，可以将图像作为资源添加以在文档内部引用

document.addResource(QTextDocument.ImageResource,
    QUrl("mydata://image.png"), QVariant(image))

您可以使用 QTextCursor API 将图像插入到文档中

imageFormat = QTextImageFormat()
imageFormat.setName("mydata://image.png")
cursor.insertImage(imageFormat)

或者，您可以使用HTML img 标签插入图像

editor.append("<img src=\"mydata://image.png\" />")
adjustSize()#

调整文档到合理的大小。

另请参阅

idealWidth() textWidth size

allFormats()#
返回类型：

QTextFormat 列表

返回文档中使用的所有文本格式的列表。

availableRedoSteps()#
返回类型：

int

返回可用的重做步骤数量。

另请参阅

isRedoAvailable()

availableUndoSteps()#
返回类型：

int

返回可用的撤销步骤数量。

另请参阅

isUndoAvailable()

baseUrl()#
返回类型：

QUrl

另请参阅

setBaseUrl()

baseUrl 属性的getter。

baseUrlChanged(url)#
参数:

url – QUrl

baseUrl 属性的属性变更通知信号。

baselineOffset()#
返回类型：

float

返回文档布局中使用的基准偏移量（%）。

begin()#
返回类型：

QTextBlock

返回文档的第一个文本块。

另请参阅

firstBlock()

blockCount()#
返回类型：

int

属性 blockCount 的获取器。

blockCountChanged(newBlockCount)#
参数:

newBlockCount - int

当文档中文本块的总数发生变化时，会发出此信号。传入 newBlockCount 中的值是新的总数。

characterAt(pos)#
参数:

pos - int

返回类型：

QChar

返回位置 pos 处的字符，如果位置超出范围，则返回一个空字符。

另请参阅

characterCount()

characterCount()#
返回类型：

int

返回文档中字符的数量。

备注

由于 QTextDocument 总是包含至少一个 QChar::ParagraphSeparator，该方法将返回至少 1。

另请参阅

blockCount() characterAt()

clear()#

清除文档。

clearUndoRedoStacks([historyToClear=QTextDocument.Stacks.UndoAndRedoStacks])#
参数:

历史记录清除 – Stacks

清除由 stacksToClear 指定的栈。

此方法将清除撤消栈、重做栈上的任何命令，或二者都清除（默认）。如果清除命令，将发出合适的信号，undoAvailable() 或 redoAvailable() 。

clone([parent=None])#
参数:

parent – QObject

返回类型：

QTextDocument

创建一个与文本文档完全相同的新的 QTextDocument 实例。 parent 是返回文本文档的父级。

contentsChange(from, charsRemoved, charsAdded)#
参数:

  • from – int

  • charsRemoved – int

  • charsAdded – int

每当文档内容发生变化时，就会发出此信号；例如，当文本被插入或删除，或者应用格式化时。

提供有关变化发生位置的字符在文档中的 position，删除的字符数（charsRemoved）和添加的字符数（charsAdded）的信息。

此信号是在通知文档布局管理人员之前发出的。此钩子允许实现文档的语法高亮。

contentsChanged()#

每当文档内容发生变化时，就会发出此信号；例如，当文本被插入或删除，或者应用格式化时。

另请参阅

contentsChange()

createObject(f)#
参数:

f – QTextFormat

返回类型：

QTextObject

创建并返回一个新的文档对象（一个 QTextObject ），基于给定的 format。

QTextObjects 将始终通过此方法创建，所以如果你在文档中使用自定义文本对象，你必须重写它。

cursorPositionChanged(cursor)#
参数:

cursor – QTextCursor

每当由于编辑操作而导致光标位置改变时，都会发出此信号。改变的光标通过 cursor 传递。如果你使用 QTextEdit 类并需要当箭头键移动光标时的信号，可以使用 QTextEdit 中的 cursorPositionChanged() 信号。

defaultCursorMoveStyle()#
返回类型：

CursorMoveStyle

默认光标移动样式被用于所有从文档创建的 QTextCursor 对象。默认是 Qt::LogicalMoveStyle。

defaultFont()#
返回类型：

QFont

返回文档布局中使用的默认字体。

另请参阅

setDefaultFont()

getter 属性 defaultFont 。

defaultStyleSheet()#
返回类型：

str

另请参阅

setDefaultStyleSheet()

getter 属性 defaultStyleSheet 。

defaultTextOption()#
返回类型：

QTextOption

默认文本选项用于文档中的所有 QTextLayout 对象。这允许为文档设置全局属性，如默认的段落格式。

另请参阅

setDefaultTextOption()

documentLayout()#
返回类型：

QAbstractTextDocumentLayout

返回此文档的文档布局。

另请参阅

setDocumentLayout()

documentLayoutChanged()#

当设置新的文档布局时，会发出此信号。

另请参阅

setDocumentLayout()

documentMargin()#
返回类型：

float

另请参阅

setDocumentMargin()

getter 属性 documentMargin 。

drawContents(painter[, rect=QRectF()])#
参数:

使用 painter p 在矩形区域 rect 内绘制文档内容。如果 rect 是空矩形（默认）则文档内容将无裁剪地绘制。

end()#
返回类型：

QTextBlock

警告：

本节包含从C++自动翻译到Python的代码片段，可能包含错误。

此函数返回一个用于测试文档结尾的块，在迭代文档时使用。

for it in doc:
    print(it.text().toStdString(), "\n")

返回的块无效，代表文档中最后一个块之后的块。您可以使用 lastBlock() 来检索文档的最后一个有效块。

另请参阅

lastBlock()

find(expr, cursor[, options=QTextDocument.FindFlags()])#
参数:
返回类型：

QTextCursor

在文档的同一段落内查找与给定正则表达式 expr 匹配的下一个出现。

搜索从给定的 cursor 位置开始，除非在搜索选项中指定了其他方式，否则按文档顺序向前搜索。选项 options 控制搜索的类型。

如果找到了匹配项，返回带有选择的光标；否则返回空光标。

如果在给定的 cursor 有选择的情况下，搜索从选择之后开始；否则从光标的位置开始。

默认情况下，搜索区分大小写，并可以在文档的任何位置匹配文本。

find(expr[, from=0[, options=QTextDocument.FindFlags()]])
参数:
返回类型：

QTextCursor

在文档的同一段落内查找与给定正则表达式 expr 匹配的下一个出现。

搜索从给定的 from 位置开始，除非在搜索选项中指定了其他方式，否则按文档顺序向前搜索。选项 options 控制搜索的类型。

如果找到了匹配项，返回带有选择的光标；否则返回空光标。

如果 from 位置为0（默认值），则搜索从文档开头开始；否则从指定位置开始。

警告：

由于历史原因，在 expr 中设置的区分大小写的选项被忽略。相反，使用 options 来确定搜索是否区分大小写。

find(subString, cursor[, options=QTextDocument.FindFlags()])
参数:
返回类型：

QTextCursor

在文档中查找字符串 subString 的下一个出现位置。搜索从给定的 cursor 位置开始，并通过文档的前面进行搜索，除非搜索选项中指定了其他情况。选项控制执行搜索的类型。

如果在文档中找到 subString，则返回选择匹配的游标；否则返回一个空游标。

如果在给定的 cursor 有选择的情况下，搜索从选择之后开始；否则从光标的位置开始。

默认情况下，搜索区分大小写，并可以在文档的任何位置匹配文本。

find(subString[, from=0[, options=QTextDocument.FindFlags()]])
参数:

  • subString – 字符串

  • from – int

  • options – FindFlag 组合

返回类型：

QTextCursor

这是一个重载函数。

在文档中查找字符串 subString 的下一个出现位置。搜索从给定的 position 开始，并通过文档的前面进行搜索，除非搜索选项中指定了其他情况。选项控制执行搜索的类型。

如果在文档中找到 subString，则返回选择匹配的游标；否则返回一个空游标。

如果 position 的值为0（默认值），则搜索从文档开头开始；否则从指定位置开始。

findBlock(pos)#
参数:

pos - int

返回类型：

QTextBlock

返回包含第 pos 个字符的文本块。

findBlockByLineNumber(blockNumber)#
参数:

blockNumber – 整数

返回类型：

QTextBlock

返回包含指定 lineNumber 的文本块。

另请参阅

firstLineNumber()

findBlockByNumber(blockNumber)#
参数:

blockNumber – 整数

返回类型：

QTextBlock

返回具有指定 blockNumber 的文本块。

另请参阅

blockNumber()

firstBlock()#
返回类型：

QTextBlock

返回文档的第一个文本块。

frameAt(pos)#
参数:

pos - int

返回类型：

QTextFrame

idealWidth()#
返回类型：

float

返回文本文档的理想宽度。理想宽度是指文档实际使用的宽度，不考虑可选的对齐方式。它始终 <= `size().width()`。

indentWidth()#
返回类型：

float

另请参阅

setIndentWidth()

属性 `indentWidth` 的获取器。

isEmpty()#
返回类型：

bool

如果文档为空则返回 true；否则返回 false。

isLayoutEnabled()#
返回类型：

bool

属性 `layoutEnabled` 的获取器。

isModified()#
返回类型：

bool

属性 `modified` 的获取器。

isRedoAvailable()#
返回类型：

bool

如果可以重做，则返回 true；否则返回 false。

isUndoAvailable()#
返回类型：

bool

如果可以撤销，则返回 true；否则返回 false。

isUndoRedoEnabled()#
返回类型：

bool

属性 `undoRedoEnabled` 的获取器。

lastBlock()#
返回类型：

QTextBlock

返回文档的最后一个（有效的）文本块。

lineCount()#
返回类型：

int

返回此文档的行数（如果布局支持此功能）。否则，这与块的数目相同。

loadResource(type, name)#
参数:

  • type – int

  • name – QUrl

返回类型：

对象

从具有给定 name 的资源中加载指定 type 的数据。

此函数由富文本引擎调用，以请求那些未直接由 QTextDocument 存储但与之相关联的数据。例如，图像通过 QTextImageFormat 对象的名称属性间接引用。

当 Qt 调用时，type 是 ResourceType 值之一。

如果 QTextDocument 是具有可调用 loadResource 方法的 QObject 的子对象（如 QTextEdit、QTextBrowser 或 QTextDocument 本身），则默认实现尝试从父对象检索数据。

markContentsDirty(from, length)#
参数:

  • from – int

  • length – int

将特定于给定 position 和 length 的内容标记为“脏”，告知文档需要再次进行布局。

maximumBlockCount()#
返回类型：

int

另请参阅

setMaximumBlockCount()

获取 maximumBlockCountᅟ 属性的值。

metaInformation(info)#
参数:

info – MetaInformation

返回类型：

str

返回关于文档的元信息，该信息由 info 指定。

另请参阅

setMetaInformation()

modificationChanged(m)#
参数:

m – 布尔型

当文档内容发生更改并且影响修改状态时，将发出此信号。如果 changed 为真，则文档已被修改；否则为假。

例如，在文档上调用 setModified (false) 并插入文本将引发信号。如果您撤销此操作，使文档恢复到原始未修改状态，该信号将再次发出。

object(objectIndex)#
参数:

objectIndex – 整数

返回类型：

QTextObject

返回与给定 objectIndex 关联的文本对象。

objectForFormat(arg__1)#
参数:

arg__1 – QTextFormat

返回类型：

QTextObject

返回与格式 f 关联的文本对象。

pageCount()#
返回类型：

int

返回此文档中的页数。

pageSize()#
返回类型：

QSizeF

另请参阅

setPageSize()

属性 pageSizeᅟ 的获取器。

print_(printer)#
参数:

printer – QPagedPaintDevice

redo()#

这是一个重载函数。

如果 redo is available 可用，则重做文档上的最后编辑操作。

redo(cursor)
参数:

cursor – QTextCursor

如果 redo is available 可用，则重做文档上的最后编辑操作。

提供的 cursor 将置于重做编辑操作位置的末尾。

redoAvailable(arg__1)#
参数:

arg__1 – 布尔型

每次重做操作变为可用（available 为真）或不可用（available 为假）时，将发出此信号。

resource(type, name)#
参数:

  • type – int

  • name – QUrl

返回类型：

对象

从具有给定 name 的资源中返回指定 type 的数据。

此函数由富文本引擎调用，以请求那些未直接由 QTextDocument 存储但与之相关联的数据。例如，图像通过 QTextImageFormat 对象的名称属性间接引用。

资源在文档内部进行缓存。如果无法在缓存中找到资源，则调用loadResource尝试加载该资源。loadResource应使用addResource将资源添加到缓存。

如果loadResource未加载资源，则将调用resourceProvider，最后是如果设置了的话的defaultResourceProvider。请注意，来自提供者的结果将不会自动添加到缓存中。

另请参阅

ResourceType resourceProvider()

修订版()#
返回类型：

int

获取文档的修订版本（如果启用了撤销）。

未修改的文档在进行编辑时，修订版本保证会增加。

另请参阅

修订版 isModified

根框架()#
返回类型：

QTextFrame

返回文档的根框架。

setBaseUrl(url)#
参数:

url – QUrl

另请参阅

baseUrl()

属性baseUrl的设置器。

setBaselineOffset(baseline)#
参数:

基线 - float

将基线设置为字体高度的百分比，用于文档布局中的基线。默认值是0。正值使文本上移，负值使文本下移。

setDefaultCursorMoveStyle(style)#
参数:

style – CursorMoveStyle

设置默认光标移动样式为给定的 style。

setDefaultFont(font)#
参数:

font – QFont

将文档布局中使用的默认 font 设置为。

另请参阅

defaultFont()

属性 defaultFont 的设置器。

setDefaultStyleSheet(sheet)#
参数:

sheet – 字符串

另请参阅

defaultStyleSheet()

属性 defaultStyleSheet 的设置器。

setDefaultTextOption(option)#
参数:

option – QTextOption

将默认文本选项设置为 option。

另请参阅

defaultTextOption()

setDocumentLayout(layout)
参数:

layout – QAbstractTextDocumentLayout

将文档设置为使用给定的 layout。之前的布局将被删除。

setDocumentMargin(margin)
参数:

margin – 浮点数

另请参阅

documentMargin()

属性 documentMargin 的设置器。

setHtml(html)
参数:

html – 字符串

使用给定的 HTML 格式化文本替换文档的全部内容，文本在 html 字符串中。当调用此函数时，撤销/重做历史将被重置。

HTML格式尽可能得到尊重；例如，“<b>bold</b> text”将生成文本，其中第一个词的字体重量使得它看起来是加粗的：“bold text”。

要选择除默认的“screen”规则外的CSS媒体规则，请使用带有“setMetaInformation()与 CssMedia 作为“info”参数。

备注

调用者有责任确保在创建包含HTML的QString并将其传递给setHtml()时，文本被正确解码。

另请参阅

setPlainText() Supported HTML Subset setMetaInformation()

setIndentWidth(width)#
参数:

width – float

设置文本列表和文本块缩进所使用的width。

QTextListFormat和QTextBlockFormat的缩进属性指定了这个值的倍数。默认缩进宽度是40。

另请参阅

indentWidth()

属性indentWidthᅟ的设置器。

setLayoutEnabled(b)#
参数:

b – bool

另请参阅

isLayoutEnabled()

属性layoutEnabledᅟ的设置器。

setMarkdown(markdown[, features=QTextDocument.MarkdownFeature.MarkdownDialectGitHub])#
参数:

使用指定的Markdown格式化的文本markdown替换文档的全部内容，并支持给定的features。默认情况下，包括所有支持的GitHub样式Markdown功能；传递MarkdownDialectCommonMark以进行更基本的解析。

尽可能尊重Markdown格式；例如，“*bold* text”将生成具有加粗外观的文本。

markdown字符串中的HTML解析方式与setHtml中相同；但是，不支持HTML块内的Markdown格式。

解析器的某些功能可以通过 features 参数启用或禁用。

  • MarkdownNoHTML

  • Markdown文本中的任何HTML标签都将被丢弃。

默认值是 MarkdownDialectGitHub。

调用此函数时，撤销/重做历史会被重置。

setMaximumBlockCount(maximum)#
参数:

maximum – int

另请参阅

maximumBlockCount()

maximumBlockCount 属性的设置器。

setMetaInformation(info, arg__2)#
参数:

设置文档指定的类型为 info 的元信息为给定的 字符串。

另请参阅

metaInformation()

setModified([m=true])#
参数:

m – 布尔型

另请参阅

isModified()

modified 属性的设置器。

setPageSize(size)#
参数:

size – QSizeF

另请参阅

pageSize()

pageSize 属性的设置器。

setPlainText(text)#
参数:

text – str

用给定的纯 text 替换文档的全部内容。调用此函数时，撤销/重做历史会被重置。

另请参阅

setHtml()

setSubScriptBaseline(baseline)#
参数:

基线 - float

将文档布局中使用默认下标的基线设为字体高度的百分比 baseline。默认值是 16.67%（高度的 1/6）。

setSuperScriptBaseline(baseline)#
参数:

基线 - float

设置默认上标的基线为字体高度的百分比，用于文档布局的基线。默认值为50%（高度的一半）。

setTextWidth(width)#
参数:

width – float

另请参阅

textWidth()

该属性的设置器 textWidthᅟ .

setUndoRedoEnabled(enable)#
参数:

enable – bool

另请参阅

isUndoRedoEnabled()

该属性的设置器 undoRedoEnabledᅟ .

setUseDesignMetrics(b)#
参数:

b – bool

另请参阅

useDesignMetrics()

该属性的设置器 useDesignMetricsᅟ .

size()#
返回类型：

QSizeF

该属性的获取器 sizeᅟ .

subScriptBaseline()#
返回类型：

float

返回文档布局中使用的字体高度的百分比作为上标的基线。

superScriptBaseline()#
返回类型：

float

返回文档布局中使用的字体高度的百分比作为上标的基线。

textWidth()#
返回类型：

float

另请参阅

setTextWidth()

属性 textWidthᅟ 的获取器。

toHtml()#
返回类型：

str

返回包含文档的HTML表示的字符串。

文档内容指定其编码为UTF-8。如果您稍后将其转换为用于网络传输或保存到磁盘的字节数组，应使用 QString::toUtf8() 将字符串转换为 QByteArray。

另请参阅

支持的 HTML 子集

toMarkdown([features=QTextDocument.MarkdownFeature.MarkdownDialectGitHub])#
参数:

features – MarkdownFeature的组合

返回类型：

str

返回包含带有给定 features 的文档的Markdown表示的字符串，或者在发生错误时返回空字符串。

另请参阅

设置Markdown

toPlainText()#
返回类型：

str

返回文档中的纯文本。如果需要格式化信息，请使用 QTextCursor。

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

备注

嵌入的对象，如图片，用Unicode值U+FFFC（对象替换字符）表示。

另请参阅

toHtml()

toRawText()#
返回类型：

str

返回包含文档中的原始文本，不包含任何格式信息。如果您需要格式信息，请使用 `QTextCursor`。

另请参阅

toPlainText()

undo()#

这是一个重载函数。

undo(cursor)
参数:

cursor – QTextCursor

如果在文档上有可撤销的操作，将撤销上一次编辑操作。提供的 cursor 被放置在撤销编辑操作的末尾位置。

有关详细信息，请参阅Qt撤销框架文档。

undoAvailable(arg__1)#
参数:

arg__1 – 布尔型

此信号在撤销操作可用（`available` 为 true）或不可用（`available` 为 false）时发出。

有关详细信息，请参阅Qt撤销框架文档。

undoCommandAdded()#

每次向 QTextDocument 中添加撤销级别时，都会发出此信号。

useDesignMetrics()#
返回类型：

bool

另请参阅

setUseDesignMetrics()

属性 useDesignMetricsᅟ 的获取器。

下一页
摘要
上一页
摘要
版权所有 © 2024 The Qt Company Ltd. 本文档中的贡献归各自所有者所有。本文档是根据自由软件基金会发布的GNU自由文档许可版1.3（https://www.gnu.org/licenses/fdl.html）许可的。Qt和相应的标志是芬兰及其它国家/地区的商标。
由Sphinx和@pradyunsg的Furo制作