QTextEdit类

成员函数文档

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

使用父元素 parent 构造一个空的 QTextEdit。

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

构造具有父对象 parent 的 QTextEdit。该文本编辑将显示文本 text。文本将被解释为 HTML。

[虚函数 noexcept] QTextEdit::~QTextEdit()

析构函数。

Qt::Alignment QTextEdit::alignment() const

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

另请参阅setAlignment().

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

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

[槽函数] void QTextEdit::append(const QString &text)

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

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

[虚保护] bool QTextEdit::canInsertFromMimeData(const QMimeData *source) const

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

重新实现此函数以支持额外的 MIME 类型。

bool QTextEdit::canPaste() const

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

[重载虚保护] void QTextEdit::changeEvent(QEvent *e)

重写： QFrame::changeEvent(QEvent *ev).

[槽函数] void QTextEdit::clear()

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

注意

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

另请参阅cut()，setPlainText() 和 setHtml().

[重载虚保护] 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()处理程序中调用。弹出菜单的所有权传递给调用者。

我们建议您使用带有QPoint的版本createStandardContextMenu，这将启用对用户单击位置敏感的操作。

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

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

QTextCharFormat QTextEdit::currentCharFormat() const

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

另请参阅 setCurrentCharFormat()。

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

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

新的格式为 f。

另请参阅 setCurrentCharFormat()。

QFont QTextEdit::currentFont() const

返回当前格式的字体。

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

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

返回在视口坐标位置 pos 的 QTextCursor。

[信号] void QTextEdit::cursorPositionChanged()

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

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

返回一个包含 cursor 的矩形（在视口坐标中）。

QRect QTextEdit::cursorRect() const

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

[槽] void QTextEdit::cut()

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

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

另请参阅 copy() 和 paste。

[重写虚受保护] void QTextEdit::dragEnterEvent(QDragEnterEvent *e)

重写: QAbstractScrollArea::dragEnterEvent(QDragEnterEvent *event).

[重写虚受保护] void QTextEdit::dragLeaveEvent(QDragLeaveEvent *e)

重写: QAbstractScrollArea::dragLeaveEvent(QDragLeaveEvent *event).

[重写虚受保护] void QTextEdit::dragMoveEvent(QDragMoveEvent *e)

重写: QAbstractScrollArea::dragMoveEvent(QDragMoveEvent *event).

[重写虚受保护] 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。

[覆盖虚拟受保护] void QTextEdit::focusInEvent(QFocusEvent *e)

重新实现: QWidget::focusInEvent(QFocusEvent *event)。

[覆盖虚拟受保护] bool QTextEdit::focusNextPrevChild(bool next)

重新实现: QWidget::focusNextPrevChild(bool next)。

[覆盖虚拟受保护] 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。

[重写虚拟受保护] void QTextEdit::inputMethodEvent(QInputMethodEvent *e)

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

[重写虚拟] QVariant QTextEdit::inputMethodQuery(Qt::InputMethodQuery property) const

重写：QWidget::inputMethodQuery(Qt::InputMethodQuery query) const。

[虚拟受保护] void QTextEdit::insertFromMimeData(const QMimeData *source)

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

重新实现此函数以支持额外的 MIME 类型。

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

这是一个方便的槽，它在当前光标位置插入被认为是 HTML 格式的 text。

它等同于

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

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

这是一个方便的槽，它在当前光标位置插入 text。

它等同于

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

[重写虚拟受保护] void QTextEdit::keyPressEvent(QKeyEvent *e)

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

[重写虚拟受保护] void QTextEdit::keyReleaseEvent(QKeyEvent *e)

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

[虚拟可调用] 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。

[覆盖虚拟受保护] void QTextEdit::mouseDoubleClickEvent(QMouseEvent *e)

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

[覆盖虚拟受保护] void QTextEdit::mouseMoveEvent(QMouseEvent *e)

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

[覆盖虚拟受保护] void QTextEdit::mousePressEvent(QMouseEvent *e)

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

[覆盖虚拟受保护] 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。

[覆盖虚拟受保护] void QTextEdit::paintEvent(QPaintEvent *event)

重实现: QAbstractScrollArea::paintEvent(QPaintEvent *event)。

此事件处理程序可以在子类中重新实现，以接收传递给 event 的绘图事件。通常，不需要在 QTextEdit 的子类中重新实现此函数。

[槽] void QTextEdit::paste()

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

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

要改变此函数的行为，即修改 QTextEdit 能够粘贴的内容及其粘贴方式，需重新实现虚拟的 canInsertFromMimeData() 和 insertFromMimeData() 函数。

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

void QTextEdit::print(QPagedPaintDevice *printer) const

这是一个方便函数，用于将文本编辑的文档打印到给定的 printer。这相当于直接调用文档的打印方法，但此函数还支持 QPrinter::Selection 作为打印范围。

也请参阅QTextDocument::print()。

[slot] void QTextEdit::redo()

重做上一个操作。

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

也请参阅undo().

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

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

[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() 设置用于插入新文本的字符格式。如果编辑器有选择，则字符格式将直接应用于选择。

另请参阅 currentCharFormat。

[槽函数] void QTextEdit::setCurrentFont(const QFont &f)

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

另请参阅 currentFont、setFontPointSize 和 setFontFamily。

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

此功能允许使用指定的颜色临时标记文档中的一些区域，颜色指定为 selections。例如，在编程编辑器中，可以使用此功能将整行文本标记为指定的背景颜色，以指示断点的存在。

另请参阅 QTextEdit::ExtraSelection 和 extraSelections。

[槽函数] void QTextEdit::setFontFamily(const QString &fontFamily)

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

另请参阅 fontFamily 和 setCurrentFont。

[槽函数] void QTextEdit::setFontItalic(bool italic)

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

另请参阅 fontItalic。

[槽函数] void QTextEdit::setFontPointSize(qreal s)

将当前格式的磅值设置为 s。

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

另请参阅 fontPointSize、setCurrentFont 和 setFontFamily。

[槽函数] void QTextEdit::setFontUnderline(bool underline)

如果 underline 为 true，则将当前格式设置为下划线；否则，将当前格式设置为非下划线。

另请参阅 fontUnderline。

[槽函数] void QTextEdit::setFontWeight(int weight)

将当前格式的字体重量设置为给定的 weight，其中使用的值是 QFont::Weight 枚举定义的范围。

参阅以下函数: fontWeight(), setCurrentFont() 和 setFontFamily().

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

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

注意

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

参阅以下内容: 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)

设置可见的 光标。

参阅以下内容: 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().