QPlainTextEdit Class

成员函数文档

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

创建一个父容器为parent 的空QPlainTextEdit对象。

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

创建一个父类为parent 的QPlainTextEdit。该文本编辑框将显示纯文本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 。例如，当在拖拽操作过程中鼠标进入此控件时，若需要确定是否可以接受该拖拽操作，就会调用此函数。

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 为false，则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

返回位于坐标pos （视口坐标系）处的QTextCursor 。

[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 上。这相当于直接调用文档的print方法，不同之处在于该函数还支持将QPrinter::Selection用作打印范围。

另请参阅 QTextDocument::print()。

[slot] void QPlainTextEdit::redo()

重做上一次操作。

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

另请参阅 undo()。

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

每当重做操作可用（available 为真）或不可用（available 为假）时，都会触发此信号。

[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 为真）或不可用（available 为假）时，都会发出此信号。

[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()。