QPlainTextEdit Class

Member Function Documentation

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

Constructs an empty QPlainTextEdit with parent parent.

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

Constructs a QPlainTextEdit with parent parent. The text edit will display the plain text text.

[virtual] QPlainTextEdit::~QPlainTextEdit()

Destructor.

QString QPlainTextEdit::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.

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

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

appendPlainText()

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

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

See also appendHtml().

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

Returns the bounding rectangle of the text block in content coordinates. Translate the rectangle with the contentOffset() to get visual coordinates on the viewport.

See also firstVisibleBlock() and blockBoundingRect().

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

Returns the bounding rectangle of the text block in the block's own coordinates.

See also blockBoundingGeometry().

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

This signal is emitted whenever the block count changes. The new block count is passed in newBlockCount.

[virtual protected] bool QPlainTextEdit::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.

bool QPlainTextEdit::canPaste() const

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

[slot] void QPlainTextEdit::centerCursor()

Scrolls the document in order to center the cursor vertically.

See also ensureCursorVisible() and centerOnScroll.

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

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

[slot] void QPlainTextEdit::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() and setPlainText().

[protected] QPointF QPlainTextEdit::contentOffset() const

Returns the content's origin in viewport coordinates.

The origin of the content of a plain text edit is always the top left corner of the first visible text block. The content offset is different from (0,0) when the text has been scrolled horizontally, or when the first visible block has been scrolled partially off the screen, i.e. the visible text does not start with the first line of the first visible block, or when the first visible block is the very first block and the editor displays a margin.

See also firstVisibleBlock(), horizontalScrollBar(), and verticalScrollBar().

[override virtual protected] void QPlainTextEdit::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 MyQPlainTextEdit::contextMenuEvent(QContextMenuEvent *event)
{
    QMenu *menu = createStandardContextMenu();
    menu->addAction(tr("My Menu Item"));
    //...
    menu->exec(event->globalPos());
    delete menu;
}

[slot] void QPlainTextEdit::copy()

Copies any selected text to the clipboard.

See also copyAvailable().

[signal] void QPlainTextEdit::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().

[virtual protected] QMimeData *QPlainTextEdit::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 *QPlainTextEdit::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 *QPlainTextEdit::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.

QTextCharFormat QPlainTextEdit::currentCharFormat() const

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

See also setCurrentCharFormat().

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

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

[signal] void QPlainTextEdit::cursorPositionChanged()

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

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

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

QRect QPlainTextEdit::cursorRect() const

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

[slot] void QPlainTextEdit::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().

QTextDocument *QPlainTextEdit::document() const

Returns a pointer to the underlying document.

See also setDocument().

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

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

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

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

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

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

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

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

void QPlainTextEdit::ensureCursorVisible()

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

See also centerCursor() and centerOnScroll.

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

Returns previously set extra selections.

See also setExtraSelections().

bool QPlainTextEdit::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 QPlainTextEdit::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.

[protected] QTextBlock QPlainTextEdit::firstVisibleBlock() const

Returns the first visible block.

See also blockBoundingRect().

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

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

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

Reimplements: QWidget::focusNextPrevChild(bool next).

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

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

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

Returns the paint context for the viewport(), useful only when reimplementing paintEvent().

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

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

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

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

[virtual protected] void QPlainTextEdit::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.

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

Convenience slot that inserts text at the current cursor position.

It is equivalent to

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

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

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

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

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

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

Loads the resource specified by the given type and name.

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

See also QTextDocument::loadResource().

void QPlainTextEdit::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().

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

This signal is emitted whenever the content of the document changes in a way that affects the modification state. If changed is true, the document has been modified; otherwise it is false.

For example, calling setModified(false) on a document and then inserting text causes the signal to get emitted. If you undo that operation, causing the document to return to its original unmodified state, the signal will get emitted again.

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

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

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

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

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

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

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

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

void QPlainTextEdit::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.

See also QTextCursor::movePosition().

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

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

[slot] void QPlainTextEdit::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 QPlainTextEdit can paste and how it is being pasted, reimplement the virtual canInsertFromMimeData() and insertFromMimeData() functions.

See also cut() and copy().

void QPlainTextEdit::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.

See also QTextDocument::print().

[slot] void QPlainTextEdit::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.

See also undo().

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

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

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

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

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

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

[slot] void QPlainTextEdit::selectAll()

Selects all text.

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

[signal] void QPlainTextEdit::selectionChanged()

This signal is emitted whenever the selection changes.

See also copyAvailable().

void QPlainTextEdit::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 QPlainTextEdit::setDocument(QTextDocument *document)

Makes document the new document of the text editor.

The parent QObject of the provided document remains the owner of the object. If the current document is a child of the text editor, then it is deleted.

The document must have a document layout that inherits QPlainTextDocumentLayout (see QTextDocument::setDocumentLayout()).

See also document().

void QPlainTextEdit::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.

See also QTextEdit::ExtraSelection and extraSelections().

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

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

text is interpreted as plain text.

Notes:

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

See also toPlainText().

void QPlainTextEdit::setTextCursor(const QTextCursor &cursor)

Sets the visible cursor.

See also textCursor().

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

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

[signal] void QPlainTextEdit::textChanged()

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

QTextCursor QPlainTextEdit::textCursor() const

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

See also setTextCursor().

QString QPlainTextEdit::toPlainText() const

Returns the text of the text edit as plain text.

See also QPlainTextEdit::setPlainText().

[slot] void QPlainTextEdit::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.

See also redo().

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

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

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

This signal is emitted when the text document needs an update of the specified rect. If the text is scrolled, rect will cover the entire viewport area. If the text is scrolled vertically, dy carries the amount of pixels the viewport was scrolled.

The purpose of the signal is to support extra widgets in plain text edit subclasses that e.g. show line numbers, breakpoints, or other extra information.

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

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

[slot] void QPlainTextEdit::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 QPlainTextEdit::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().