QTextDocument 类

成员函数文档

[显式] QTextDocument::QTextDocument(QObject *parent = nullptr)

使用提供的parent构造一个空的QTextDocument。

[显式] QTextDocument::QTextDocument(const QString &text, QObject *parent = nullptr)

使用指定的text构造一个包含纯文本（未格式化）的QTextDocument，并提供parent。

[虚拟 noexcept] QTextDocument::~QTextDocument()

销毁文档。

void QTextDocument::addResource(int type, const QUrl &name, const QVariant &resource)

使用type和name作为标识符将资源resource添加到资源缓存中。应从QTextDocument::ResourceType中获取类型值。

例如，您可以添加一个图像作为资源，以便在文档中引用它。

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

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

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

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

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

void QTextDocument::adjustSize()

调整文档到最后合理的大小。

另请参阅idealWidth()，textWidth和size。

QList<QTextFormat> QTextDocument::allFormats() const

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

int QTextDocument::availableRedoSteps() const

返回可用的重做步骤数。

另请参阅isRedoAvailable()。

int QTextDocument::availableUndoSteps() const

返回可用的撤销步骤数。

另请参阅isUndoAvailable()。

[since 6.0] qreal QTextDocument::baselineOffset() const

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

此函数从Qt 6.0版开始引入。

另请参阅setBaselineOffset，setSubScriptBaseline，subScriptBaseline，setSuperScriptBaseline和superScriptBaseline。

QTextBlock QTextDocument::begin() const

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

另请参阅firstBlock。

[信号] void QTextDocument::blockCountChanged(int newBlockCount)

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

QChar QTextDocument::characterAt(int pos) const

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

另请参阅characterCount。

int QTextDocument::characterCount() const

返回该文档的字符数。

另请参阅blockCount()和characterAt()。

[虚函数] void QTextDocument::clear()

清除文档。

void QTextDocument::clearUndoRedoStacks(QTextDocument::Stacks stacksToClear = UndoAndRedoStacks)

清除指定的stacksToClear堆栈。

此方法清除撤销栈、重做栈或两者（默认）上的所有命令。如果命令被清除，将发出适当的信号，QTextDocument::undoAvailable() 或 QTextDocument::redoAvailable()。

另请参阅 QTextDocument::undoAvailable() 和 QTextDocument::redoAvailable()。

QTextDocument *QTextDocument::clone(QObject *parent = nullptr) const

创建一个新的 QTextDocument 对象，它是该文本文档的一个副本。 parent 是返回的文本文档的父对象。

[信号] void QTextDocument::contentsChange(int position, int charsRemoved, int charsAdded)

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

提供了关于发生更改的字符在文档中的 位置、移除的字符数（《i translate="no">charsRemoved》）以及添加的字符数（《i translate="no">charsAdded”）的信息。

在文档的布局管理器被通知更改之前发出信号。此钩子允许您实现文档的语法高亮显示。

另请参阅 QAbstractTextDocumentLayout::documentChanged() 和 contentsChanged()。

[信号] void QTextDocument::contentsChanged()

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

另请参阅 contentsChange()。

[虚拟保护] QTextObject *QTextDocument::createObject(const QTextFormat &format)

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

QTextObjects 将始终通过此方法创建，因此如果您在使用文档内的自定义文本对象，则必须重新实现它。

[信号] void QTextDocument::cursorPositionChanged(const QTextCursor &cursor)

每当编辑操作导致光标位置变化时都会发出此信号。变化的光标通过 cursor 传入。如果与 QTextEdit 类一起使用文档并且需要当光标用箭头键移动时的信号，可以在 QTextEdit 中使用 cursorPositionChanged() 信号。

Qt::CursorMoveStyle QTextDocument::defaultCursorMoveStyle() const

默认光标移动样式由从文档创建的所有 QTextCursor 对象使用。默认值为 Qt::LogicalMoveStyle。

另请参阅 setDefaultCursorMoveStyle()。

QFont QTextDocument::defaultFont() const

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

另请参阅 setDefaultFont()。

[静态，自6.1版本起] QTextDocument::ResourceProvider QTextDocument::defaultResourceProvider()

返回默认的资源提供者。

此函数是在Qt 6.1版本中引入的。

另请参阅setDefaultResourceProvider、resourceProvider和loadResource。

QTextOption QTextDocument::defaultTextOption() const

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

另请参阅setDefaultTextOption。

QAbstractTextDocumentLayout *QTextDocument::documentLayout() const

返回此文档的文档布局。

另请参阅setDocumentLayout。

[信号] void QTextDocument::documentLayoutChanged()

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

另请参阅setDocumentLayout。

void QTextDocument::drawContents(QPainter *p, const QRectF &rect = QRectF())

使用画家p绘制文档内容，并裁剪至rect。如果rect是一个空矩形（默认）则文档无裁剪绘制。

QTextBlock QTextDocument::end() const

此函数返回一个块以在迭代文档时测试文档的结束。

for (QTextBlock it = doc->begin(); it != doc->end(); it = it.next())
    std::cout << it.text().toStdString() << "\n";

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

另请参阅lastBlock。

QTextCursor QTextDocument::find(const QString &subString, const QTextCursor &cursor, QTextDocument::FindFlags options = FindFlags()) const

在文档中查找字符串subString的下一个出现。搜索从给定的cursor位置开始，除非搜索选项中指定了其他方式，否则从文档的当前位置正向进行。search选项控制搜索的类型。

如果找到subString，则返回一个带有匹配选择的游标；否则返回一个空游标。

如果给定的cursor具有选择，则搜索从选择之后开始；否则从游标的位置开始。

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

QTextCursor QTextDocument::find(const QString &subString, int position = 0, QTextDocument::FindFlags options = FindFlags()) const

这是一个重载函数。

在文档中查找字符串subString的下一个出现位置。搜索从指定的position开始，除非在搜索选项中指定了其他位置。搜索选项控制搜索的类型。

如果找到subString，则返回一个带有匹配选择的游标；否则返回一个空游标。

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

QTextCursor QTextDocument::find(const QRegularExpression &expr, int from = 0, QTextDocument::FindFlags options = FindFlags()) const

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

搜索从指定的from位置开始，除非搜索选项中指定了其他位置。搜索选项控制搜索的类型。

如果找到匹配项，则返回一个选中匹配项的光标；否则返回一个空光标。

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

QTextCursor QTextDocument::find(const QRegularExpression &expr, const QTextCursor &cursor, QTextDocument::FindFlags options = FindFlags()) const

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

搜索从给定的cursor位置开始，除非搜索选项中指定了其他位置。搜索选项控制搜索的类型。

如果找到匹配项，则返回一个选中匹配项的光标；否则返回一个空光标。

如果给定的cursor具有选择，则搜索从选择之后开始；否则从游标的位置开始。

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

QTextBlock QTextDocument::findBlock(int pos) const

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

QTextBlock QTextDocument::findBlockByLineNumber(int lineNumber) const

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

另请参阅QTextBlock::firstLineNumber().

QTextBlock QTextDocument::findBlockByNumber(int blockNumber) const

返回指定blockNumber的文本块。

另请参阅QTextBlock::blockNumber().

QTextBlock QTextDocument::firstBlock() const

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

qreal QTextDocument::idealWidth() const

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

另请参阅adjustSize() 和 textWidth.

bool QTextDocument::isEmpty() const

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

bool QTextDocument::isRedoAvailable() const

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

另请参阅isUndoAvailable() 和 availableRedoSteps.

bool QTextDocument::isUndoAvailable() const

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

另请参阅isRedoAvailable() 和 availableUndoSteps.

QTextBlock QTextDocument::lastBlock() const

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

int QTextDocument::lineCount() const

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

另请参阅blockCount() 和 characterCount.

[虚保护虚叫函数] QVariant QTextDocument::loadResource(int type, const QUrl &name)

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

该函数由富文本引擎调用来请求 `QTextDocument` 直接存储但与之关联的数据。例如，图像通过 `QTextImageFormat` 对象的属性引用间接引用。

由 Qt 调用时，type 是 `QTextDocument::ResourceType` 的某个值之一。

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

另请参阅QTextDocument::ResourceProvider.

void QTextDocument::markContentsDirty(int position, int length)

将指定的 position 和 length 的内容标记为“脏”，通知文档它需要再次布局。

QString QTextDocument::metaInformation(QTextDocument::MetaInformation info) const

返回关于文档的指定类型 info 的元信息。

另请参阅setMetaInformation().

[信号] void QTextDocument::modificationChanged(bool changed)

每当文档内容以影响修改状态的方式发生更改时，都会发出此信号。如果 changed 为 true，则表示文档已更改；否则为 false。

例如，在对文档调用setModified(false)之后插入文本会导致信号被发出。如果您撤销该操作，使文档返回原始未更改状态，信号将再次被发出。

QTextObject *QTextDocument::object(int objectIndex) const

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

QTextObject *QTextDocument::objectForFormat(const QTextFormat &f) const

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

int QTextDocument::pageCount() const

返回此文档中的页数。

void QTextDocument::print(QPagedPaintDevice *printer) const

将文档打印到指定的 printer。在与此函数一起使用之前，必须设置 QPagedPaintDevice。

这是一个方便的方法，用于将整个文档打印到打印机。

如果文档在 pageSize() 属性中已通过指定高度分页，则按原样打印。

如果文档没有分页，例如在 QTextEdit 中使用的文档，则创建文档的临时副本，并根据绘图设备纸张矩形的尺寸将副本拆分为多页。默认情况下，文档内容周围设置2厘米的边距。此外，当前页码打印在每个页面的底部。

另请参阅 QTextEdit::print。

void QTextDocument::redo(QTextCursor *cursor)

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

提供的 cursor 被置于重做编辑操作位置的最结尾。

[slot] void QTextDocument::redo()

这是一个重载函数。

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

[signal] void QTextDocument::redoAvailable(bool available)

每次重做操作可用（available 为 true）或不可用（available 为 false）时，都会发出此信号。

QVariant QTextDocument::resource(int type, const QUrl &name) const

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

该函数由富文本引擎调用来请求 `QTextDocument` 直接存储但与之关联的数据。例如，图像通过 `QTextImageFormat` 对象的属性引用间接引用。

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

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

相关内容QTextDocument::ResourceType 和 resourceProvider。

[since 6.1] QTextDocument::ResourceProvider QTextDocument::resourceProvider() const

返回此文本文档的资源提供者。

此函数是在Qt 6.1版本中引入的。

相关内容setResourceProvider()、defaultResourceProvider() 和 loadResource。

int QTextDocument::revision() const

返回文档的版本（如果启用了撤销）。

在没有修改的文档编辑时，版本将保证增加。

相关内容QTextBlock::revision() 和 isModified。

QTextFrame *QTextDocument::rootFrame() const

返回文档的根框架。

[since 6.0] void QTextDocument::setBaselineOffset(qreal baseline)

将基线设置为相对于字体高度的百分比，用于文档布局的基线为 baseline。默认值是0。正值将文本向上移动相应的%；负值将文本向下移动。

此函数从Qt 6.0版开始引入。

相关内容baselineOffset、setSubScriptBaseline、subScriptBaseline、setSuperScriptBaseline 和 superScriptBaseline。

void QTextDocument::setDefaultCursorMoveStyle(Qt::CursorMoveStyle style)

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

相关内容defaultCursorMoveStyle。

void QTextDocument::setDefaultFont(const QFont &font)

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

相关内容defaultFont。

[static, since 6.1] void QTextDocument::setDefaultResourceProvider(const QTextDocument::ResourceProvider &provider)

将默认资源提供者设置为 provider。

默认提供者将由没有显式设置提供者的所有 QTextDocuments 使用。

此函数是在Qt 6.1版本中引入的。

相关内容defaultResourceProvider、setResourceProvider 和 loadResource。

void QTextDocument::setDefaultTextOption(const QTextOption &option)

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

参见：defaultTextOption。

void QTextDocument::setDocumentLayout(QAbstractTextDocumentLayout *layout)

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

参见：documentLayoutChanged。

void QTextDocument::setHtml(const QString &html)

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

尽可能尊重HTML格式；例如，“<b>粗体</b> 文本”将生成文本，其中第一个单词具有使它显示为粗体的字体粗细：“粗体 文本”。

要选择除默认的 "screen" 规则之外的其他CSS媒体规则，请使用带有 'info' 参数为 'CssMedia' 的 setMetaInformation()。

参见：setPlainText，支持的HTML子集和setMetaInformation。

void QTextDocument::setIndentWidth(qreal width)

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

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

参见：indentWidth。

void QTextDocument::setMarkdown(const QString &markdown, QTextDocument::MarkdownFeatures features = MarkdownDialectGitHub)

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

尽可能尊重Markdown格式；例如，“*粗体* 文本”将生成具有强调外观的第一个单词的文本。

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

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

默认为 MarkdownDialectGitHub。

调用此函数将重置撤销/重做历史。

void QTextDocument::setMetaInformation(QTextDocument::MetaInformation info, const QString &string)

将文档的由 info 指定的元信息设置为给定的 string。

另请参阅 metaInformation()。

void QTextDocument::setPlainText(const QString &text)

用给定的普通 text 替换文档的全部内容。调用此函数将重置撤销/重做历史。

另请参阅 setHtml()。

[since 6.1] void QTextDocument::setResourceProvider(const QTextDocument::ResourceProvider &provider)

设置文本文档的资源提供者为 provider。

此函数是在Qt 6.1版本中引入的。

另请参阅 resourceProvider() 和 loadResource()。

[since 6.0] void QTextDocument::setSubScriptBaseline(qreal baseline)

将文档布局中使用的默认下标的基线设置为字体高度的百分比 baseline。默认值为 16.67%（高度六分之一）。

此函数从Qt 6.0版开始引入。

另请参阅 subScriptBaseline()、setSuperScriptBaseline()、superScriptBaseline()、setBaselineOffset() 和 baselineOffset()。

[since 6.0] void QTextDocument::setSuperScriptBaseline(qreal baseline)

将文档布局中使用的默认上标的基线设置为字体高度的百分比 baseline。默认值为 50%（高度二分之一）。

此函数从Qt 6.0版开始引入。

另请参阅 superScriptBaseline()、setSubScriptBaseline()、subScriptBaseline()、setBaselineOffset() 和 baselineOffset()。

[since 6.0] qreal QTextDocument::subScriptBaseline() const

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

此函数从Qt 6.0版开始引入。

另请参阅 setSubScriptBaseline()、setSuperScriptBaseline()、superScriptBaseline()、setBaselineOffset() 和 baselineOffset()。

[since 6.0] qreal QTextDocument::superScriptBaseline() const

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

此函数从Qt 6.0版开始引入。

另请参阅 setSuperScriptBaseline()，setSubScriptBaseline()，subScriptBaseline()，setBaselineOffset()，以及 baselineOffset。

QString QTextDocument::toHtml() const

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

文档内容指定它的编码为UTF-8。如果你之后将返回的html字符串转换为字节数组以在网络中传输或将数据保存到磁盘，你应该使用 QString::toUtf8() 将字符串转换为 QByteArray。

另请参阅支持的HTML子集。

QString QTextDocument::toMarkdown(QTextDocument::MarkdownFeatures features = MarkdownDialectGitHub) const

返回包含给定 features 的文档Markdown表示的字符串，或者在写入失败的情况下返回空字符串。

另请参阅 setMarkdown。

QString QTextDocument::toPlainText() const

返回文档中包含的纯文本。如果你想使用格式信息，则应使用 QTextCursor。

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

另请参阅 toHtml。

QString QTextDocument::toRawText() const

返回包含文档的原始文本，不包含任何格式信息。如果你想使用格式信息，请使用 QTextCursor。

另请参阅 toPlainText。

void QTextDocument::undo(QTextCursor *cursor)

如果可撤销，则撤销文档中的最后一个编辑操作。提供的 cursor 定位于撤销编辑操作的位置的末尾。

有关详情，请参阅 Qt 撤销框架 文档。

另请参阅 undoAvailable() 和 isUndoRedoEnabled。

[slot] void QTextDocument::undo()

这是一个重载函数。

[signal] void QTextDocument::undoAvailable(bool available)

每当撤销操作变得可用（available 为真）或不可用（available 为假）时，将发出此信号。

有关详情，请参阅 Qt 撤销框架 文档。

另请参阅 undo() 和 isUndoRedoEnabled。

[信号] void QTextDocument::undoCommandAdded()

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