QPlainTextEdit Class

成员函数文档

[explicit] QPlainTextEdit::QPlainTextEdit(QWidget *parent = nullptr)

使用父parent 构建一个空的 QPlainTextEdit。

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

构造一个 QPlainTextEdit，其父级parent 。文本编辑器将显示纯文本text 。

[virtual noexcept] QPlainTextEdit::~QPlainTextEdit()

毁灭者

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

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

[slot] void QPlainTextEdit::appendHtml(const QString &html)

在文本编辑末尾添加一个新段落（html ）。

appendPlainText()

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

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

另请参阅 appendHtml()。

[protected] QRectF QPlainTextEdit::blockBoundingGeometry(const QTextBlock &block) const

以内容坐标返回文本block 的边界矩形。使用contentOffset() 对矩形进行平移，以获得视口中的视觉坐标。

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

[protected] QRectF QPlainTextEdit::blockBoundingRect(const QTextBlock &block) const

以块自身坐标返回文本block 的边界矩形。

另请参见 blockBoundingGeometry()。

[signal] void QPlainTextEdit::blockCountChanged(int newBlockCount)

每当块计数发生变化时，就会发出该信号。新的块计数通过newBlockCount 传递。

[virtual protected] bool QPlainTextEdit::canInsertFromMimeData(const QMimeData *source) const

如果source 所指定的 MIME 数据对象的内容可以解码并插入到文档中，则该函数返回true 。例如，在拖动操作过程中，鼠标进入该 widget 时，需要确定是否可以接受拖动，这时就会调用该函数。

bool QPlainTextEdit::canPaste() const

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

[slot] void QPlainTextEdit::centerCursor()

滚动文档，使光标垂直居中。

另请参阅 ensureCursorVisible() 和centerOnScroll 。

[override virtual protected] void QPlainTextEdit::changeEvent(QEvent *e)

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

[slot] void QPlainTextEdit::clear()

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

备注

• 撤销/重做历史记录也会被清除。
• currentCharFormat除非textCursor() 已经位于文档开头，否则 () 将被重置。

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

[protected] QPointF QPlainTextEdit::contentOffset() const

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

纯文本编辑内容的原点总是第一个可见文本块的左上角。如果文本已水平滚动，或第一个可见文本块已部分滚动离开屏幕，即可见文本不是从第一个可见文本块的第一行开始，或第一个可见文本块是第一个文本块且编辑器显示了边距，则内容偏移量与（0,0）不同。

另请参见 firstVisibleBlock()、horizontalScrollBar() 和verticalScrollBar()。

[override virtual protected] void QPlainTextEdit::contextMenuEvent(QContextMenuEvent *event)

重实现：QAbstractScrollArea::contextMenuEvent(QContextMenuEvent *e)。

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

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

有关事件的信息将在event 对象中传递。

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

[slot] void QPlainTextEdit::copy()

将选中的文本复制到剪贴板。

另请参阅 copyAvailable().

[signal] void QPlainTextEdit::copyAvailable(bool yes)

在文本编辑器中选中或取消选中文本时会发出该信号。

当文本被选中时，该信号将在yes 设置为 true 时发出。如果没有文本被选中或选中的文本被取消选中，则会发出此信号，同时yes 设置为 false。

如果yes 为 true，则可以使用copy() 将选中内容复制到剪贴板。如果yes 为假，则copy() 不会执行任何操作。

另请参见 selectionChanged()。

[virtual protected] QMimeData *QPlainTextEdit::createMimeDataFromSelection() const

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

如果重新实现该函数，请注意返回的QMimeData 对象的所有权将传递给调用者。可以使用textCursor() 函数检索选区。

QMenu *QPlainTextEdit::createStandardContextMenu()

该函数用于创建标准上下文菜单，当用户用鼠标右键单击文本编辑器时，菜单就会显示出来。该函数从默认的contextMenuEvent() 处理程序中调用。弹出菜单的所有权将转移给调用者。

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

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

该函数用于创建标准上下文菜单，当用户用鼠标右键单击文本编辑器时，菜单就会显示出来。它从默认的contextMenuEvent() 处理程序中调用，并以文档坐标中鼠标点击的位置为position 。这样就可以执行对用户点击位置敏感的操作。弹出菜单的所有权将转移给调用者。

QTextCharFormat QPlainTextEdit::currentCharFormat() const

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

另请参阅 setCurrentCharFormat()。

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

返回QTextCursor ，位置为pos （视口坐标）。

[signal] void QPlainTextEdit::cursorPositionChanged()

每当光标位置发生变化时，就会发出该信号。

QRect QPlainTextEdit::cursorRect() const

返回一个包含文本编辑光标的矩形（以视口坐标表示）。

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

返回一个包含cursor 的矩形（以视口坐标表示）。

[slot] void QPlainTextEdit::cut()

将选中的文本复制到剪贴板，并从文本编辑器中删除。

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

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

QTextDocument *QPlainTextEdit::document() const

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

另请参阅 setDocument()。

[override virtual protected] void QPlainTextEdit::dragEnterEvent(QDragEnterEvent *e)

重实现：QAbstractScrollArea::dragEnterEvent(QDragEnterEvent *event).

[override virtual protected] void QPlainTextEdit::dragLeaveEvent(QDragLeaveEvent *e)

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

[override virtual protected] void QPlainTextEdit::dragMoveEvent(QDragMoveEvent *e)

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

[override virtual protected] 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 。

[protected] QTextBlock QPlainTextEdit::firstVisibleBlock() const

返回第一个可见区块。

另请参见 blockBoundingRect()。

[override virtual protected] void QPlainTextEdit::focusInEvent(QFocusEvent *e)

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

[override virtual protected] bool QPlainTextEdit::focusNextPrevChild(bool next)

重实现：QWidget::focusNextPrevChild(bool next）。

[override virtual protected] void QPlainTextEdit::focusOutEvent(QFocusEvent *e)

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

[protected] QAbstractTextDocumentLayout::PaintContext QPlainTextEdit::getPaintContext() const

返回viewport() 的绘制上下文，仅在重新实现paintEvent() 时有用。

[override virtual protected] void QPlainTextEdit::inputMethodEvent(QInputMethodEvent *e)

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

[override virtual] QVariant QPlainTextEdit::inputMethodQuery(Qt::InputMethodQuery property) const

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

[virtual protected] void QPlainTextEdit::insertFromMimeData(const QMimeData *source)

该函数将source 指定的 MIME 数据对象的内容插入当前光标位置的文本编辑器中。当插入的文本是剪贴板粘贴操作的结果，或文本编辑器接受了拖放操作的数据时，都会调用该函数。

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

在当前光标位置插入text 的方便槽。

它等同于

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

[override virtual protected] void QPlainTextEdit::keyPressEvent(QKeyEvent *e)

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

[override virtual protected] void QPlainTextEdit::keyReleaseEvent(QKeyEvent *e)

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

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

加载由给定的type 和name 指定的资源。

该函数是QTextDocument::loadResource() 的扩展。

另请参阅 QTextDocument::loadResource()。

void QPlainTextEdit::mergeCurrentCharFormat(const QTextCharFormat &modifier)

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

另请参见 QTextCursor::mergeCharFormat().

[signal] void QPlainTextEdit::modificationChanged(bool changed)

每当文档内容发生影响修改状态的变化时，就会发出该信号。如果changed 为 true，则表示文档已被修改；否则为 false。

例如，在文档上调用 setModified(false)，然后插入文本，就会触发该信号。如果撤销该操作，使文档返回到原始的未修改状态，则信号将再次发出。

[override virtual protected] void QPlainTextEdit::mouseDoubleClickEvent(QMouseEvent *e)

重实现：QAbstractScrollArea::mouseDoubleClickEvent(QMouseEvent *e)。

[override virtual protected] void QPlainTextEdit::mouseMoveEvent(QMouseEvent *e)

重实现：QAbstractScrollArea::mouseMoveEvent(QMouseEvent *e)。

[override virtual protected] void QPlainTextEdit::mousePressEvent(QMouseEvent *e)

重实现：QAbstractScrollArea::mousePressEvent(QMouseEvent *e)。

[override virtual protected] void QPlainTextEdit::mouseReleaseEvent(QMouseEvent *e)

重实现：QAbstractScrollArea::mouseReleaseEvent(QMouseEvent *e)。

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

通过执行给定的operation 移动光标。

如果mode 是QTextCursor::KeepAnchor ，则光标会选择其移动过的文本。这与用户按住 Shift 键并使用光标键移动光标时的效果相同。

另请参阅 QTextCursor::movePosition() 。

[override virtual protected] void QPlainTextEdit::paintEvent(QPaintEvent *e)

重实现：QAbstractScrollArea::paintEvent(QPaintEvent *event).

[slot] void QPlainTextEdit::paste()

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

如果剪贴板中没有文本，则不会发生任何操作。

要改变该函数的行为，即修改QPlainTextEdit 可以粘贴的内容和粘贴方式，请重新实现虚拟的canInsertFromMimeData() 和insertFromMimeData() 函数。

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

void QPlainTextEdit::print(QPagedPaintDevice *printer) const

方便函数，用于将文本编辑器的文档打印到给定的printer 。这等同于直接调用文档的打印方法，只是该函数还支持将 QPrinter::Selection 作为打印范围。

另请参阅 QTextDocument::print() 。

[slot] void QPlainTextEdit::redo()

重做最后一个操作。

如果没有要重做的操作，即撤销/重做历史中没有重做步骤，则不会发生任何操作。

另请参见 undo()。

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

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

[override virtual protected] void QPlainTextEdit::resizeEvent(QResizeEvent *e)

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

[override virtual protected] void QPlainTextEdit::scrollContentsBy(int dx, int dy)

重实现：QAbstractScrollArea::scrollContentsBy(int dx, int dy）。

[slot] void QPlainTextEdit::selectAll()

选择所有文本。

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

[signal] 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)

该函数允许在文档中使用指定颜色临时标记某些区域，指定颜色为selections 。例如，在编程编辑器中，可以用给定的背景颜色标记整行文本，以表示存在断点。

另请参阅 QTextEdit::ExtraSelection 和extraSelections() 。

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

将文本编辑器的文本更改为字符串text 。之前的文本将被删除。

text 被解释为纯文本。

备注

• 撤销/重做历史记录也会被清除。
• currentCharFormat() 将被重置，除非textCursor() 已经位于文档开头。

另请参阅 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 为 true）或不可用（available 为 false）时，都会发出该信号。

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

当文本文档需要更新指定的rect 时，就会发出该信号。如果文本是滚动的，rect 将覆盖整个视口区域。如果文本是垂直滚动的，dy 会显示视口滚动的像素数。

该信号的目的是支持纯文本编辑子类中的额外部件，例如显示行号、断点或其他额外信息。

[override virtual protected] void QPlainTextEdit::wheelEvent(QWheelEvent *e)

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

[slot] void QPlainTextEdit::zoomIn(int range = 1)

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

另请参见 zoomOut()。

[slot] void QPlainTextEdit::zoomOut(int range = 1)

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

另请参见 zoomIn()。