Member Function Documentation

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

Constructs a QTextEdit with parent parent. The text edit will display the text text. The text is interpreted as html.

QTextEdit::QTextEdit(QWidget *parent = nullptr)

Constructs an empty QTextEdit with parent parent.

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

Appends a new paragraph with text to the end of the text edit.

Note: The new paragraph appended will have the same character format and block format as the current paragraph, determined by the position of the cursor.

See also currentCharFormat() and QTextCursor::blockFormat().

[slot] void QTextEdit::clear()

Deletes all the text in the text edit.

Notes:

• The undo/redo history is also cleared.
• currentCharFormat() is reset, unless textCursor() is already at the beginning of the document.

See also cut(), setPlainText(), and setHtml().

[slot] void QTextEdit::copy()

Copies any selected text to the clipboard.

See also copyAvailable().

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

This signal is emitted when text is selected or de-selected in the text edit.

When text is selected this signal will be emitted with yes set to true. If no text has been selected or if the selected text is de-selected this signal is emitted with yes set to false.

If yes is true then copy() can be used to copy the selection to the clipboard. If yes is false then copy() does nothing.

See also selectionChanged().

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

This signal is emitted if the current character format has changed, for example caused by a change of the cursor position.

The new format is f.

See also setCurrentCharFormat().

[signal] void QTextEdit::cursorPositionChanged()

This signal is emitted whenever the position of the cursor changed.

[slot] void QTextEdit::cut()

Copies the selected text to the clipboard and deletes it from the text edit.

If there is no selected text nothing happens.

See also copy() and paste().

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

Convenience slot that inserts text which is assumed to be of html formatting at the current cursor position.

It is equivalent to:

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

Note: When using this function with a style sheet, the style sheet will only apply to the current block in the document. In order to apply a style sheet throughout a document, use QTextDocument::setDefaultStyleSheet() instead.

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

Convenience slot that inserts text at the current cursor position.

It is equivalent to

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

[slot] void QTextEdit::paste()

Pastes the text from the clipboard into the text edit at the current cursor position.

If there is no text in the clipboard nothing happens.

To change the behavior of this function, i.e. to modify what QTextEdit can paste and how it is being pasted, reimplement the virtual canInsertFromMimeData() and insertFromMimeData() functions.

See also cut() and copy().

[slot] void QTextEdit::redo()

Redoes the last operation.

If there is no operation to redo, i.e. there is no redo step in the undo/redo history, nothing happens.

This function was introduced in Qt 4.2.

See also undo().

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

This signal is emitted whenever redo operations become available (available is true) or unavailable (available is false).

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

Scrolls the text edit so that the anchor with the given name is visible; does nothing if the name is empty, or is already visible, or isn't found.

[slot] void QTextEdit::selectAll()

Selects all text.

See also copy(), cut(), and textCursor().

[signal] void QTextEdit::selectionChanged()

This signal is emitted whenever the selection changes.

See also copyAvailable().

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

Sets the alignment of the current paragraph to a. Valid alignments are Qt::AlignLeft, Qt::AlignRight, Qt::AlignJustify and Qt::AlignCenter (which centers horizontally).

See also alignment().

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

Sets the font of the current format to f.

See also currentFont(), setFontPointSize(), and setFontFamily().

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

Sets the font family of the current format to fontFamily.

See also fontFamily() and setCurrentFont().

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

If italic is true, sets the current format to italic; otherwise sets the current format to non-italic.

See also fontItalic().

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

Sets the point size of the current format to s.

Note that if s is zero or negative, the behavior of this function is not defined.

See also fontPointSize(), setCurrentFont(), and setFontFamily().

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

If underline is true, sets the current format to underline; otherwise sets the current format to non-underline.

See also fontUnderline().

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

Sets the font weight of the current format to the given weight, where the value used is in the range defined by the QFont::Weight enum.

See also fontWeight(), setCurrentFont(), and setFontFamily().

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

Changes the text of the text edit to the string text. Any previous text is removed.

Notes:

• text is interpreted as plain text.
• The undo/redo history is also cleared.
• currentCharFormat() is reset, unless textCursor() is already at the beginning of the document.

Note: Setter function for property plainText.

See also toPlainText().

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

Sets the text edit's text. The text can be plain text or HTML and the text edit will try to guess the right format.

Use setHtml() or setPlainText() directly to avoid text edit's guessing.

This function was introduced in Qt 4.2.

See also toPlainText() and toHtml().

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

Sets the text background color of the current format to c.

This function was introduced in Qt 4.4.

See also textBackgroundColor().

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

Sets the text color of the current format to c.

See also textColor().

[signal] void QTextEdit::textChanged()

This signal is emitted whenever the document's content changes; for example, when text is inserted or deleted, or when formatting is applied.

Note: Notifier signal for property html. Notifier signal for property markdown.

[slot] void QTextEdit::undo()

Undoes the last operation.

If there is no operation to undo, i.e. there is no undo step in the undo/redo history, nothing happens.

This function was introduced in Qt 4.2.

See also redo().

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

This signal is emitted whenever undo operations become available (available is true) or unavailable (available is false).

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

Zooms in on the text by making the base font size range points larger and recalculating all font sizes to be the new size. This does not change the size of any images.

See also zoomOut().

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

Zooms out on the text by making the base font size range points smaller and recalculating all font sizes to be the new size. This does not change the size of any images.

See also zoomIn().

[virtual] QTextEdit::~QTextEdit()

Destructor.

Qt::Alignment QTextEdit::alignment() const

Returns the alignment of the current paragraph.

See also setAlignment().

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

Returns the reference of the anchor at position pos, or an empty string if no anchor exists at that point.

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

This function returns true if the contents of the MIME data object, specified by source, can be decoded and inserted into the document. It is called for example when during a drag operation the mouse enters this widget and it is necessary to determine whether it is possible to accept the drag and drop operation.

Reimplement this function to enable drag and drop support for additional MIME types.

bool QTextEdit::canPaste() const

Returns whether text can be pasted from the clipboard into the textedit.

This function was introduced in Qt 4.2.

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

Reimplements: QFrame::changeEvent(QEvent *ev).

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

Reimplements: QAbstractScrollArea::contextMenuEvent(QContextMenuEvent *e).

Shows the standard context menu created with createStandardContextMenu().

If you do not want the text edit to have a context menu, you can set its contextMenuPolicy to Qt::NoContextMenu. If you want to customize the context menu, reimplement this function. If you want to extend the standard context menu, reimplement this function, call createStandardContextMenu() and extend the menu returned.

Information about the event is passed in the event object.

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

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

This function returns a new MIME data object to represent the contents of the text edit's current selection. It is called when the selection needs to be encapsulated into a new QMimeData object; for example, when a drag and drop operation is started, or when data is copied to the clipboard.

If you reimplement this function, note that the ownership of the returned QMimeData object is passed to the caller. The selection can be retrieved by using the textCursor() function.

QMenu *QTextEdit::createStandardContextMenu()

This function creates the standard context menu which is shown when the user clicks on the text edit with the right mouse button. It is called from the default contextMenuEvent() handler. The popup menu's ownership is transferred to the caller.

We recommend that you use the createStandardContextMenu(QPoint) version instead which will enable the actions that are sensitive to where the user clicked.

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

This function creates the standard context menu which is shown when the user clicks on the text edit with the right mouse button. It is called from the default contextMenuEvent() handler and it takes the position in document coordinates where the mouse click was. This can enable actions that are sensitive to the position where the user clicked. The popup menu's ownership is transferred to the caller.

This function was introduced in Qt 4.4.

QTextCharFormat QTextEdit::currentCharFormat() const

Returns the char format that is used when inserting new text.

See also setCurrentCharFormat().

QFont QTextEdit::currentFont() const

Returns the font of the current format.

See also setCurrentFont(), setFontFamily(), and setFontPointSize().

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

returns a QTextCursor at position pos (in viewport coordinates).

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

returns a rectangle (in viewport coordinates) that includes the cursor.

QRect QTextEdit::cursorRect() const

returns a rectangle (in viewport coordinates) that includes the cursor of the text edit.

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

Reimplements: QAbstractScrollArea::dragEnterEvent(QDragEnterEvent *event).

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

Reimplements: QAbstractScrollArea::dragLeaveEvent(QDragLeaveEvent *event).

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

Reimplements: QAbstractScrollArea::dragMoveEvent(QDragMoveEvent *event).

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

Reimplements: QAbstractScrollArea::dropEvent(QDropEvent *event).

void QTextEdit::ensureCursorVisible()

Ensures that the cursor is visible by scrolling the text edit if necessary.

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

Returns previously set extra selections.

This function was introduced in Qt 4.2.

See also setExtraSelections().

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

Finds the next occurrence of the string, exp, using the given options. Returns true if exp was found and changes the cursor to select the match; otherwise returns false.

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

This is an overloaded function.

Finds the next occurrence, matching the regular expression, exp, using the given options. The QTextDocument::FindCaseSensitively option is ignored for this overload, use QRegExp::caseSensitivity instead.

Returns true if a match was found and changes the cursor to select the match; otherwise returns false.

This function was introduced in Qt 5.3.

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

This is an overloaded function.

Finds the next occurrence, matching the regular expression, exp, using the given options. The QTextDocument::FindCaseSensitively option is ignored for this overload, use QRegularExpression::CaseInsensitiveOption instead.

Returns true if a match was found and changes the cursor to select the match; otherwise returns false.

This function was introduced in Qt 5.13.

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

Reimplements: QWidget::focusInEvent(QFocusEvent *event).

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

Reimplements: QWidget::focusNextPrevChild(bool next).

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

Reimplements: QWidget::focusOutEvent(QFocusEvent *event).

QString QTextEdit::fontFamily() const

Returns the font family of the current format.

See also setFontFamily(), setCurrentFont(), and setFontPointSize().

bool QTextEdit::fontItalic() const

Returns true if the font of the current format is italic; otherwise returns false.

See also setFontItalic().

qreal QTextEdit::fontPointSize() const

Returns the point size of the font of the current format.

See also setFontFamily(), setCurrentFont(), and setFontPointSize().

bool QTextEdit::fontUnderline() const

Returns true if the font of the current format is underlined; otherwise returns false.

See also setFontUnderline().

int QTextEdit::fontWeight() const

Returns the font weight of the current format.

See also setFontWeight(), setCurrentFont(), setFontPointSize(), and QFont::Weight.

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

Reimplements: QWidget::inputMethodEvent(QInputMethodEvent *event).

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

Reimplements: QWidget::inputMethodQuery(Qt::InputMethodQuery query) const.

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

This function inserts the contents of the MIME data object, specified by source, into the text edit at the current cursor position. It is called whenever text is inserted as the result of a clipboard paste operation, or when the text edit accepts data from a drag and drop operation.

Reimplement this function to enable drag and drop support for additional MIME types.

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

Reimplements: QAbstractScrollArea::keyPressEvent(QKeyEvent *e).

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

Reimplements: QWidget::keyReleaseEvent(QKeyEvent *event).

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

Loads the resource specified by the given type and name.

This function is an extension of QTextDocument::loadResource().

Note: This function can be invoked via the meta-object system and from QML. See Q_INVOKABLE.

See also QTextDocument::loadResource().

void QTextEdit::mergeCurrentCharFormat(const QTextCharFormat &modifier)

Merges the properties specified in modifier into the current character format by calling QTextCursor::mergeCharFormat on the editor's cursor. If the editor has a selection then the properties of modifier are directly applied to the selection.

See also QTextCursor::mergeCharFormat().

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

Reimplements: QAbstractScrollArea::mouseDoubleClickEvent(QMouseEvent *e).

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

Reimplements: QAbstractScrollArea::mouseMoveEvent(QMouseEvent *e).

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

Reimplements: QAbstractScrollArea::mousePressEvent(QMouseEvent *e).

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

Reimplements: QAbstractScrollArea::mouseReleaseEvent(QMouseEvent *e).

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

Moves the cursor by performing the given operation.

If mode is QTextCursor::KeepAnchor, the cursor selects the text it moves over. This is the same effect that the user achieves when they hold down the Shift key and move the cursor with the cursor keys.

This function was introduced in Qt 4.2.

See also QTextCursor::movePosition().

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

Reimplements: QAbstractScrollArea::paintEvent(QPaintEvent *event).

This event handler can be reimplemented in a subclass to receive paint events passed in event. It is usually unnecessary to reimplement this function in a subclass of QTextEdit.

Warning: The underlying text document must not be modified from within a reimplementation of this function.

void QTextEdit::print(QPagedPaintDevice *printer) const

Convenience function to print the text edit's document to the given printer. This is equivalent to calling the print method on the document directly except that this function also supports QPrinter::Selection as print range.

This function was introduced in Qt 4.3.

See also QTextDocument::print().

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

Reimplements: QAbstractScrollArea::resizeEvent(QResizeEvent *event).

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

Reimplements: QAbstractScrollArea::scrollContentsBy(int dx, int dy).

void QTextEdit::setCurrentCharFormat(const QTextCharFormat &format)

Sets the char format that is be used when inserting new text to format by calling QTextCursor::setCharFormat() on the editor's cursor. If the editor has a selection then the char format is directly applied to the selection.

See also currentCharFormat().

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

This function allows temporarily marking certain regions in the document with a given color, specified as selections. This can be useful for example in a programming editor to mark a whole line of text with a given background color to indicate the existence of a breakpoint.

This function was introduced in Qt 4.2.

See also QTextEdit::ExtraSelection and extraSelections().

void QTextEdit::setTextCursor(const QTextCursor &cursor)

Sets the visible cursor.

See also textCursor().

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

Reimplements: QWidget::showEvent(QShowEvent *event).

QColor QTextEdit::textBackgroundColor() const

Returns the text background color of the current format.

This function was introduced in Qt 4.4.

See also setTextBackgroundColor().

QColor QTextEdit::textColor() const

Returns the text color of the current format.

See also setTextColor().

QTextCursor QTextEdit::textCursor() const

Returns a copy of the QTextCursor that represents the currently visible cursor. Note that changes on the returned cursor do not affect QTextEdit's cursor; use setTextCursor() to update the visible cursor.

See also setTextCursor().

QString QTextEdit::toPlainText() const

QString QTextEdit::toPlainText() const

Returns the text of the text edit as plain text.

Note: Getter function for property plainText.

See also QTextEdit::setPlainText().

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

Reimplements: QAbstractScrollArea::wheelEvent(QWheelEvent *e).