QPlainTextEdit 类

成员函数文档

[显式] QPlainTextEdit::QPlainTextEdit(QWidget *parent = nullptr)

以父 parent 构建。空白的 QPlainTextEdit。

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

以父 parent 构建。带文本的 QPlainTextEdit。文本编辑将显示纯文本 text。

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

析构函数。

QString QPlainTextEdit::anchorAt(const QPoint &pos) const

返回指定位置pos的锚点引用，如果该点不存在锚点，则返回空字符串。

[槽函数] void QPlainTextEdit::appendHtml(const QString &html)

将具有html的新的段落添加到文本编辑器的末尾。

appendPlainText()

[槽函数] void QPlainTextEdit::appendPlainText(const QString &text)

将具有text的新段落添加到文本编辑器的末尾。

另请参阅appendHtml()。

[保护成员] QRectF QPlainTextEdit::blockBoundingGeometry(const QTextBlock &block) const

返回在内容坐标系中的文本block的边界矩形。使用contentOffset()转换矩形以获取视口中的视觉坐标。

另请参阅firstVisibleBlock()和blockBoundingRect()。

[保护成员] QRectF QPlainTextEdit::blockBoundingRect(const QTextBlock &block) const

返回文本block在其自身坐标系中的边界矩形。

另请参阅blockBoundingGeometry()。

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

每当块的数量变化时都会发出此信号。新块的数量通过newBlockCount传入。

[虚拟保护成员] bool QPlainTextEdit::canInsertFromMimeData(const QMimeData *source) const

如果由source指定的MIME数据对象的包含内容可以被解码并插入到文档中，则此函数返回true。例如，当在拖动操作中鼠标进入此小部件时调用此函数，需要确定是否可以接受拖动。

bool QPlainTextEdit::canPaste() const

返回是否可以将文本从剪贴板粘贴到文本编辑器中。

[槽函数] void QPlainTextEdit::centerCursor()

通过滚动文档来垂直居中光标。

另请参阅ensureCursorVisible()和centerOnScroll。

[覆盖虚拟保护成员] void QPlainTextEdit::changeEvent(QEvent *e)

实现了：QFrame::changeEvent(QEvent *ev)。

[槽] void QPlainTextEdit::clear()

删除文本编辑器中所有的文本。

注意

• 撤销/重做历史也会被清除。
• 当前字符格式() 被重置，除非 文本光标() 已经在文档的起始位置。

另请参阅剪切() 和 设置为纯文本。

[保护] QPointF QPlainTextEdit::contentOffset() const

返回内容在视口坐标中的原点。

纯文本编辑器内容的原点始终是第一个可见文本块的左上角。当文本水平滚动，或者第一个可见块部分滚动出屏幕（即可见文本不是从第一个可见块的第一行开始，或者第一个可见块是第一个块并且编辑器显示边距）时，内容偏移与 (0,0) 不同。

另请参阅第一个可见块()，水平滚动条 和 垂直滚动条。

[重写虚保护] void QPlainTextEdit::contextMenuEvent(QContextMenuEvent *event)

重新实现: QAbstractScrollArea::contextMenuEvent(QContextMenuEvent *e).

显示使用 createStandardContextMenu() 创建的标准上下文菜单。

如果您不希望文本编辑器具有上下文菜单，可以将其 上下文菜单策略 设置为 Qt::NoContextMenu。如果您想要自定义上下文菜单，重新实现此函数。如果您想扩展标准上下文菜单，重新实现此函数，调用 createStandardContextMenu() 并扩展返回的菜单。

事件信息通过 event 对象传递。

void MyQPlainTextEdit::contextMenuEvent(QContextMenuEvent *event)
{
    QMenu *menu = createStandardContextMenu();
    menu->addAction(tr("My Menu Item"));
    //...
    menu->exec(event->globalPos());
    delete menu;
}

[槽] void QPlainTextEdit::copy()

将任何选定的文本复制到剪贴板。

另请参阅copyAvailable。

[信号] void QPlainTextEdit::copyAvailable(bool yes)

当选定或取消选定文本编辑器中的文本时发出此信号。

当选定文本时，此信号将以 yes 设置为 true。如果没有选定任何文本或选定的文本被取消选定，则此信号将以 yes 设置为 false 发出。

如果 yes 为 true，则可以使用 copy() 将选择的项目复制到剪贴板。如果 yes 为 false，则 copy() 不会做任何事情。

另请参阅selectionChanged。

[虚拟保护] QMimeData *QPlainTextEdit::createMimeDataFromSelection() const

此函数返回一个新的 MIME 数据对象来表示文本编辑器当前选择的内容。当需要将选择封装到新的 QMimeData 对象中时；例如，当开始拖放操作或复制数据到剪贴板时，会调用该函数。

如果你重新实现了这个函数，请注意，返回的 QMimeData 对象的所有权已传递给调用者。可以通过使用 textCursor() 函数来检索选择内容。

QMenu *QPlainTextEdit::createStandardContextMenu()

此函数创建在用户用鼠标右键单击文本编辑时显示的标准上下文菜单。它从默认的 contextMenuEvent() 处理程序中被调用。弹出的菜单所有权被转让给调用者。

我们建议使用 createStandardContextMenu(QPoint) 版本，这将启用对用户点击位置敏感的操作。

QMenu *QPlainTextEdit::createStandardContextMenu(const QPoint &position)

此函数创建在用户用鼠标右键单击文本编辑时显示的标准上下文菜单。它从默认的 contextMenuEvent() 处理程序中被调用，并接受鼠标点击在文档坐标中的 位置。这可以启用对用户点击位置敏感的操作。弹出的菜单所有权被转让给调用者。

QTextCharFormat QPlainTextEdit::currentCharFormat() const

返回在插入新文本时使用的字符格式。

另请参阅setCurrentCharFormat。

QTextCursor QPlainTextEdit::cursorForPosition(const QPoint &pos) const

返回一个位于 位置（视口坐标）的 QTextCursor。

[信号] void QPlainTextEdit::cursorPositionChanged()

每当光标位置改变时发射此信号。

QRect QPlainTextEdit::cursorRect(const QTextCursor &cursor) const

返回包括 光标 的矩形（视口坐标）。

QRect QPlainTextEdit::cursorRect() const

返回包括文本编辑中光标的矩形（视口坐标）。

[槽] void QPlainTextEdit::cut()

将选定的文本复制到剪切板，并从文本编辑中删除它。

如果没有选定的文本，则不会发生任何操作。

另请参阅copy() 和 paste。

QTextDocument *QPlainTextEdit::document() const

返回指向底层文档的指针。

另请参阅setDocument。

[重载虚受保护] void QPlainTextEdit::dragEnterEvent(QDragEnterEvent *e)

重新实现: QAbstractScrollArea::dragEnterEvent(QDragEnterEvent *event)

[覆盖虚保护] void QPlainTextEdit::dragLeaveEvent(QDragLeaveEvent *e)

重实现: QAbstractScrollArea::dragLeaveEvent(QDragLeaveEvent *event).

[覆盖虚保护] void QPlainTextEdit::dragMoveEvent(QDragMoveEvent *e)

重实现: QAbstractScrollArea::dragMoveEvent(QDragMoveEvent *event).

[覆盖虚保护] void QPlainTextEdit::dropEvent(QDropEvent *e)

重实现: QAbstractScrollArea::dropEvent(QDropEvent *event).

void QPlainTextEdit::ensureCursorVisible()

通过必要时滚动文本编辑器来确保光标可见。

另请参阅 centerCursor() 和 centerOnScroll.

QList<QTextEdit::ExtraSelection> QPlainTextEdit::extraSelections() const

返回之前设置的额外选择。

另请参阅 setExtraSelections().

bool QPlainTextEdit::find(const QString &exp, QTextDocument::FindFlags options = QTextDocument::FindFlags())

使用给定的 options 通过查找字符串，exp 的下一个出现。如果找到 exp 并将光标移到匹配处，则返回 true；否则返回 false。

bool QPlainTextEdit::find(const QRegularExpression &exp, QTextDocument::FindFlags options = QTextDocument::FindFlags())

这是重载函数。

使用给定的 options 查找与正则表达式，exp 匹配的下一个出现。

如果找到匹配项并将光标移到匹配处，则返回 true；否则返回 false。

[保护] QTextBlock QPlainTextEdit::firstVisibleBlock() const

返回第一个可见块。

另请参阅 blockBoundingRect().

[覆盖虚保护] void QPlainTextEdit::focusInEvent(QFocusEvent *e)

重实现: QWidget::focusInEvent(QFocusEvent *event).

[覆盖虚保护] bool QPlainTextEdit::focusNextPrevChild(bool next)

重实现： QWidget::focusNextPrevChild(bool next).

[覆盖虚保护] void QPlainTextEdit::focusOutEvent(QFocusEvent *e)

重实现： QWidget::focusOutEvent(QFocusEvent *event).

[保护] QAbstractTextDocumentLayout::PaintContext QPlainTextEdit::getPaintContext() const

返回视图的绘制上下文，在重实现 paintEvent() 时很有用。

[覆盖虚保护] void QPlainTextEdit::inputMethodEvent(QInputMethodEvent *e)

重实现： QWidget::inputMethodEvent(QInputMethodEvent *event).

[覆盖虚] QVariant QPlainTextEdit::inputMethodQuery(Qt::InputMethodQuery property) const

重实现： QWidget::inputMethodQuery(Qt::InputMethodQuery query) const.

[虚保护] void QPlainTextEdit::insertFromMimeData(const QMimeData *source)

此函数将指定为source的MIME数据对象的内 容插入到文本编辑器中的当前光标位置。它会在剪纸板粘贴操作结果后插入文本时、文本编辑器接受拖放操作数据时调用。

[槽函数] void QPlainTextEdit::insertPlainText(const QString &text)

方便的槽函数，将text插入到当前光标位置。

等效于

edit->textCursor().insertText(text);

[覆盖虚保护] void QPlainTextEdit::keyPressEvent(QKeyEvent *e)

重实现： QAbstractScrollArea::keyPressEvent(QKeyEvent *e).

[覆盖虚保护] void QPlainTextEdit::keyReleaseEvent(QKeyEvent *e)

重实现： QWidget::keyReleaseEvent(QKeyEvent *event).

[虚] QVariant QPlainTextEdit::loadResource(int type, const QUrl &name)

根据给定的type和name加载资源。

此函数是QTextDocument::loadResource的扩展。

另请参阅QTextDocument::loadResource.

void QPlainTextEdit::mergeCurrentCharFormat(const QTextCharFormat &modifier)

通过在编辑器的光标上调用QTextCursor::mergeCharFormat将指定于修饰符中的属性合并到当前字符格式。如果编辑器有选区，则直接将修饰符的应用属性到选区。

另请参阅QTextCursor::mergeCharFormat()。

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

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

例如，对文档调用setModified(false)并在其中插入文本会导致信号发出。如果您撤销该操作，使文档恢复到初始未修改状态，则信号将再次发出。

[重写虚保护] void QPlainTextEdit::mouseDoubleClickEvent(QMouseEvent *e)

重写：QAbstractScrollArea::mouseDoubleClickEvent(QMouseEvent *e)。

[重写虚保护] void QPlainTextEdit::mouseMoveEvent(QMouseEvent *e)

重写：QAbstractScrollArea::mouseMoveEvent(QMouseEvent *e)。

[重写虚保护] void QPlainTextEdit::mousePressEvent(QMouseEvent *e)

重写：QAbstractScrollArea::mousePressEvent(QMouseEvent *e)。

[重写虚保护] void QPlainTextEdit::mouseReleaseEvent(QMouseEvent *e)

重写：QAbstractScrollArea::mouseReleaseEvent(QMouseEvent *e)。

void QPlainTextEdit::moveCursor(QTextCursor::MoveOperation operation, QTextCursor::MoveMode mode = QTextCursor::MoveAnchor)

通过对给定操作进行操作来移动光标。

如果模式是QTextCursor::KeepAnchor，则光标选择移过的文本。这与用户通过按下Shift键并使用光标键移动光标所达到的效果相同。

另请参阅QTextCursor::movePosition()。

[重写虚保护] void QPlainTextEdit::paintEvent(QPaintEvent *e)

重写：QAbstractScrollArea::paintEvent(QPaintEvent *event)。

[槽函数] void QPlainTextEdit::paste()

将剪贴板中的文本粘贴到当前光标位置的文本编辑中。

如果剪贴板中没有文本，则不执行任何操作。

要更改此函数的行为，例如修改QPlainTextEdit能粘贴什么，以及如何粘贴，则重写虚拟函数canInsertFromMimeData()和insertFromMimeData()。

另请参阅cut()和copy()。

void QPlainTextEdit::print(QPagedPaintDevice *printer) const

用于将文本编辑的文档打印到指定 打印机 的便捷函数。这与直接在文档上调用打印方法等价，区别是此函数还支持 QPrinter::Selection 作为打印范围。

另请参阅QTextDocument::print()。

[槽函数] void QPlainTextEdit::redo()

重做上一个操作。

如果没有操作可以重做，即没有可撤销/重做的历史记录中的步骤，则不会发生任何事情。

另请参阅undo()。

[信号] void QPlainTextEdit::redoAvailable(bool available)

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

[重写虚拟受保护] void QPlainTextEdit::resizeEvent(QResizeEvent *e)

重实现: QAbstractScrollArea::resizeEvent(QResizeEvent *event)

[重写虚拟受保护] void QPlainTextEdit::scrollContentsBy(int dx, int dy)

重实现: QAbstractScrollArea::scrollContentsBy(int dx, int dy)

[槽函数] void QPlainTextEdit::selectAll()

选择所有文本。

另请参阅copy()，cut() 和 textCursor()。

[信号] void QPlainTextEdit::selectionChanged()

每当选择发生变化时，都会发射此信号。

另请参阅copyAvailable。

void QPlainTextEdit::setCurrentCharFormat(const QTextCharFormat &format)

通过在编辑器的光标上调用 QTextCursor::setCharFormat()，设置用于插入新文本的字符格式为 format。如果编辑器有选择，则字符格式直接应用于选择。

另请参阅currentCharFormat()。

void QPlainTextEdit::setDocument(QTextDocument *document)

使 document 成为文本编辑器的新文档。

提供文档的父 QObject 仍然是对象的所有者。如果当前文档是文本编辑器的子项，则将其删除。

文档必须具有继承自 QPlainTextDocumentLayout 的文档布局（见 QTextDocument::setDocumentLayout）。

另请参阅document。

void QPlainTextEdit::setExtraSelections(const QList<QTextEdit::ExtraSelection> &selections)

此功能允许用指定的颜色暂时标记文档中某些区域，颜色以 选择 指定。例如，在编程编辑器中，可以用给定的背景颜色标记整行文本，以指示断点的存在。

另请参阅 QTextEdit::ExtraSelection 和 extraSelections。

[slot] void QPlainTextEdit::setPlainText(const QString &text)

将文本编辑器的文本更改为指定的 text 字符串。任何先前的文本都将被移除。

text 被解释为纯文本。

注意

• 撤销/重做历史也会被清除。
• 当前字符格式() 被重置，除非 文本光标() 已经在文档的起始位置。

另请参阅 toPlainText。

void QPlainTextEdit::setTextCursor(const QTextCursor &cursor)

设置可见的 cursor。

另请参阅 textCursor。

[override virtual protected] void QPlainTextEdit::showEvent(QShowEvent *)

重新实现了：QWidget::showEvent(QShowEvent *event)。

[signal] void QPlainTextEdit::textChanged()

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

QTextCursor QPlainTextEdit::textCursor() const

返回一个表示当前可见光标的 QTextCursor 复制品。请注意，对返回的光标所做的更改不会影响 QPlainTextEdit 的光标；使用 setTextCursor() 来更新可见光标。

另请参阅 setTextCursor。

QString QPlainTextEdit::toPlainText() const

以纯文本形式返回文本编辑器的文本。

另请参阅 QPlainTextEdit::setPlainText。

[slot] void QPlainTextEdit::undo()

撤销上一个操作。

如果没有可撤销的操作，即没有可撤销的操作步骤，则不执行任何操作。

另请参阅 redo。

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

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

[signal] void QPlainTextEdit::updateRequest(const QRect &rect, int dy)

当文本文档需要更新指定的 rect 时，此信号被触发。如果文字被滚动，rect 将覆盖整个视口区域。如果文字垂直滚动，dy 将携带视口滚动的像素数量。

此信号的目的在于支持在纯文本编辑子类中嵌入额外的控件，例如显示行号、断点或其他额外信息。

[覆盖虚保护] void QPlainTextEdit::wheelEvent(QWheelEvent *e)

重新实现：QAbstractScrollArea::wheelEvent(QWheelEvent *e).

[槽函数] void QPlainTextEdit::zoomIn(int range = 1)

通过将基本字体大小增加 range 点来放大文本，并重新计算所有字体大小为新大小。这不会改变任何图像的大小。

另请参阅 zoomOut。

[槽函数] void QPlainTextEdit::zoomOut(int range = 1)

通过将基本字体大小减少 range 点来缩小文本，并重新计算所有字体大小为新大小。这不会改变任何图像的大小。

另请参阅 zoomIn。