QTextEdit Class

成员函数文档

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

创建一个父对象为parent 的空QTextEdit。

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

创建一个父类为parent 的QTextEdit。该文本编辑框将显示文本text 。该文本将被解释为HTML。

[virtual noexcept] QTextEdit::~QTextEdit()

析构函数。

Qt::Alignment QTextEdit::alignment() const

返回当前段落的对齐方式。

另请参阅 setAlignment()。

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

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

[slot] void QTextEdit::append(const QString &text)

在文本编辑框末尾插入一个以“text ”开头的新段落。

另请参阅 currentCharFormat() 和QTextCursor::blockFormat()。

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

如果由 `source` 指定的 MIME 数据对象的内容能够被解码并插入到文档中，则该函数返回 `true `。例如，当在拖拽操作过程中鼠标进入此控件时，需要确定是否可以接受该拖放操作，此时会调用该函数。

重写此函数以支持其他 MIME 类型的拖放功能。

bool QTextEdit::canPaste() const

返回一个值，表示是否可以将剪贴板中的文本粘贴到文本编辑框中。

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

重写了：QFrame::changeEvent(QEvent *ev)。

[slot] void QTextEdit::clear()

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

注：

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

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

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

重写：QAbstractScrollArea::contextMenuEvent(QContextMenuEvent *e)。

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

若不希望文本编辑框具有上下文菜单，可将其contextMenuPolicy 属性设置为Qt::NoContextMenu 。若需自定义上下文菜单，请重写此函数。若需扩展标准上下文菜单，请重写此函数，调用createStandardContextMenu()并扩展返回的菜单。

有关该事件的信息将通过event 对象传递。

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

[slot] void QTextEdit::copy()

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

另请参阅 copyAvailable()。

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

当在文本编辑框中选中或取消选中文本时，会发出此信号。

当选中文本时，该信号会被触发，且yes 属性将设置为true。如果未选中任何文本，或者选中的文本被取消选中，该信号会被触发，且yes 属性将设置为false。

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

另请参阅 selectionChanged()。

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

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

如果您重写此函数，请注意，返回的QMimeData 对象的所有权将转移给调用方。可通过调用textCursor()函数来获取选区内容。

QMenu *QTextEdit::createStandardContextMenu()

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

我们建议您改用 createStandardContextMenu(QPoint) 版本，该版本将启用与用户点击位置相关的操作。

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

该函数用于创建标准上下文菜单，当用户右键单击文本编辑框时，该菜单会显示出来。该函数由默认的contextMenuEvent()处理程序调用，并接收鼠标单击位置的position （以文档坐标系表示）。这使得可以实现根据用户单击位置触发的操作。弹出菜单的所有权将转移给调用方。

QTextCharFormat QTextEdit::currentCharFormat() const

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

另请参阅 setCurrentCharFormat()。

[signal] void QTextEdit::currentCharFormatChanged(const QTextCharFormat &f)

如果当前字符格式发生变化（例如由于光标位置的改变），则会发出此信号。

新格式为f 。

另请参阅 setCurrentCharFormat()。

QFont QTextEdit::currentFont() const

返回当前格式的字体。

另请参阅 setCurrentFont()、setFontFamily() 和setFontPointSize()。

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

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

[signal] void QTextEdit::cursorPositionChanged()

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

QRect QTextEdit::cursorRect() const

返回一个矩形（以视口坐标为单位），该矩形包含文本编辑框的光标。

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

返回一个矩形（以视口坐标为单位），该矩形包含cursor 。

[slot] void QTextEdit::cut()

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

如果没有选中的文本，则不执行任何操作。

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

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

重写了：QAbstractScrollArea::dragEnterEvent(QDragEnterEvent *event)。

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

重写了：QAbstractScrollArea::dragLeaveEvent(QDragLeaveEvent *event)。

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

重写了：QAbstractScrollArea::dragMoveEvent(QDragMoveEvent *event)。

[override virtual protected] void QTextEdit::dropEvent(QDropEvent *e)

重写了：QAbstractScrollArea::dropEvent(QDropEvent *event)。

void QTextEdit::ensureCursorVisible()

如有必要，通过滚动文本编辑框来确保光标可见。

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

返回先前设置的额外选项。

另请参阅 ` setExtraSelections()`。

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

使用给定的options 查找字符串exp 的下一次出现位置。如果找到了exp ，则返回true 并将光标移至该匹配位置；否则返回false 。

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

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

若找到匹配项，则返回true 并将光标移动至该匹配项处；否则返回false 。

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

重写了：QWidget::focusInEvent(QFocusEvent *event)。

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

重新实现了：QWidget::focusNextPrevChild （bool next）。

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

重写了：QWidget::focusOutEvent(QFocusEvent *event)。

QString QTextEdit::fontFamily() const

返回当前格式的字体家族。

另请参阅 setFontFamily()、setCurrentFont() 和setFontPointSize()。

bool QTextEdit::fontItalic() const

如果当前格式的字体为斜体，则返回true ；否则返回false。

另请参阅 setFontItalic()。

qreal QTextEdit::fontPointSize() const

返回当前格式的字体点大小。

另请参阅 setFontFamily()、setCurrentFont() 和setFontPointSize()。

bool QTextEdit::fontUnderline() const

如果当前格式的字体带有下划线，则返回true ；否则返回false。

另请参阅 setFontUnderline()。

int QTextEdit::fontWeight() const

返回当前格式的字体粗细。

另请参阅 setFontWeight()、setCurrentFont()、setFontPointSize() 以及QFont::Weight 。

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

重写了：QWidget::inputMethodEvent(QInputMethodEvent *event)。

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

重写：QWidget::inputMethodQuery （Qt::InputMethodQuery query）const。

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

该函数将由source 指定的MIME数据对象的内容插入到文本编辑框中当前光标位置。每当通过剪贴板粘贴操作插入文本，或者文本编辑框接受拖放操作的数据时，都会调用该函数。

重写此函数以启用对其他 MIME 类型的拖放支持。

[slot] void QTextEdit::insertHtml(const QString &text)

一个便捷插槽，用于在当前光标位置插入text ，该内容被视为HTML格式。

其效果等同于：

edit->textCursor().insertHtml(fragment);

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

一个便捷插入槽，用于将text 插入到当前光标位置。

这相当于

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

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

重写了：QAbstractScrollArea::keyPressEvent(QKeyEvent *e)。

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

重写了：QWidget::keyReleaseEvent(QKeyEvent *event)。

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

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

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

另请参阅 QTextDocument::loadResource()。

void QTextEdit::mergeCurrentCharFormat(const QTextCharFormat &modifier)

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

另请参阅 QTextCursor::mergeCharFormat()。

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

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

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

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

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

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

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

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

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

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

如果mode 的值为QTextCursor::KeepAnchor ，则光标会选中其移动经过的文本。这与用户按住Shift键并使用方向键移动光标时所产生的效果相同。

另请参阅 QTextCursor::movePosition()。

[override virtual protected] void QTextEdit::paintEvent(QPaintEvent *event)

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

子类可以重写此事件处理函数，以接收通过 `event` 传递的绘制事件。通常在 `QTextEdit` 的子类中无需重写此函数。

[slot] void QTextEdit::paste()

将剪贴板中的文本粘贴到文本编辑框中，粘贴位置为当前光标所在处。

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

若要更改此函数的行为，即修改QTextEdit 可粘贴的内容及其粘贴方式，请重写虚拟函数canInsertFromMimeData()和insertFromMimeData()。

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

void QTextEdit::print(QPagedPaintDevice *printer) const

一个便捷函数，用于将文本编辑器的文档打印到指定的printer 上。这相当于直接调用文档的print方法，不同之处在于该函数还支持将QPrinter::Selection作为打印范围。

另请参阅 QTextDocument::print()。

[slot] void QTextEdit::redo()

重做上一次操作。

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

另请参阅 undo()。

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

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

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

重写了：QAbstractScrollArea::resizeEvent(QResizeEvent *event)。

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

重新实现了：QAbstractScrollArea::scrollContentsBy(int dx, int dy)。

[slot] void QTextEdit::scrollToAnchor(const QString &name)

滚动文本编辑框，使具有指定name 的锚点可见；如果name 为空、该锚点已可见或未找到，则不执行任何操作。

[slot] void QTextEdit::selectAll()

选中所有文本。

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

[signal] void QTextEdit::selectionChanged()

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

另请参阅 copyAvailable()。

[slot] void QTextEdit::setAlignment(Qt::Alignment a)

将当前段落的对齐方式设置为a 。有效的对齐方式包括Qt::AlignLeft 、Qt::AlignRight 、Qt::AlignJustify 以及Qt::AlignCenter （水平居中）。

另请参阅 alignment()。

void QTextEdit::setCurrentCharFormat(const QTextCharFormat &format)

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

另请参阅 currentCharFormat()。

[slot] void QTextEdit::setCurrentFont(const QFont &f)

将当前格式的字体设置为f 。

另请参阅 currentFont()、setFontPointSize() 和setFontFamily()。

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

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

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

[slot] void QTextEdit::setFontFamily(const QString &fontFamily)

将当前格式的字体家族设置为fontFamily 。

另请参阅 fontFamily() 和setCurrentFont()。

[slot] void QTextEdit::setFontItalic(bool italic)

如果italic 为真，则将当前格式设置为斜体；否则将当前格式设置为非斜体。

另请参阅 fontItalic()。

[slot] void QTextEdit::setFontPointSize(qreal s)

将当前格式的字号设置为s 。

请注意，如果 `s ` 为零或负数，则此函数的行为未定义。

另请参阅 fontPointSize()、setCurrentFont() 和setFontFamily()。

[slot] void QTextEdit::setFontUnderline(bool underline)

如果underline 为真，则将当前格式设置为带下划线；否则，将当前格式设置为不带下划线。

另请参阅 fontUnderline()。

[slot] void QTextEdit::setFontWeight(int weight)

将当前格式的字体粗细设置为给定的weight ，其中使用的值必须在QFont::Weight 枚举所定义的范围内。

另请参阅 fontWeight()、setCurrentFont() 和setFontFamily()。

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

将文本编辑框中的内容更改为字符串text 。之前的所有内容将被清除。

注：

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

另请参阅 toPlainText()。

[slot] void QTextEdit::setText(const QString &text)

设置文本编辑框的text 。文本可以是纯文本或HTML，文本编辑框会尝试识别正确的格式。

若要避免文本编辑框进行格式推测，请直接使用setHtml()或setPlainText()。

另请参阅 toPlainText() 和toHtml()。

[slot] void QTextEdit::setTextBackgroundColor(const QColor &c)

将当前格式的文本背景色设置为c 。

另请参阅 textBackgroundColor()。

[slot] void QTextEdit::setTextColor(const QColor &c)

将当前格式的文本颜色设置为c 。

另请参阅 textColor()。

void QTextEdit::setTextCursor(const QTextCursor &cursor)

设置可见的cursor 。

另请参阅 textCursor()。

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

重写了：QWidget::showEvent(QShowEvent *event)。

QColor QTextEdit::textBackgroundColor() const

返回当前格式的文本背景色。

另请参阅 setTextBackgroundColor()。

[signal] void QTextEdit::textChanged()

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

QColor QTextEdit::textColor() const

返回当前格式的文本颜色。

另请参阅 setTextColor()。

QTextCursor QTextEdit::textCursor() const

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

另请参阅 setTextCursor()。

QString QTextEdit::toPlainText() const

QString QTextEdit::toPlainText() const

返回文本编辑框中的文本内容，格式为纯文本。

另请参阅 QTextEdit::setPlainText()。

[slot] void QTextEdit::undo()

撤销上一步操作。

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

另请参阅 redo()。

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

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

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

重写了：QAbstractScrollArea::wheelEvent(QWheelEvent *e)。

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

通过将基础字号增大range 点，并重新计算所有字号以适应新大小，从而放大文本。这不会改变任何图片的大小。

另请参阅 zoomOut()。

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

通过将基础字号缩小range 点，并重新计算所有字号以适应新尺寸，从而使文本缩小。这不会改变任何图片的大小。

另请参阅 zoomIn()。