QPlainTextEdit Class

The QPlainTextEdit class provides a widget that is used to edit and display plain text. More...

Header:	#include <QPlainTextEdit>
qmake:	QT += widgets
Since:	Qt 4.4
Inherits:	QAbstractScrollArea

This class was introduced in Qt 4.4.

• List of all members, including inherited members
• Obsolete members

Public Types

enum	LineWrapMode { NoWrap, WidgetWidth }

Properties

backgroundVisible : bool blockCount : const int centerOnScroll : bool cursorWidth : int documentTitle : QString lineWrapMode : LineWrapMode maximumBlockCount : int overwriteMode : bool

placeholderText : QString plainText : QString readOnly : bool tabChangesFocus : bool tabStopDistance : qreal textInteractionFlags : Qt::TextInteractionFlags undoRedoEnabled : bool wordWrapMode : QTextOption::WrapMode

Public Functions

	QPlainTextEdit(const QString &text, QWidget *parent = nullptr)
	QPlainTextEdit(QWidget *parent = nullptr)
virtual	~QPlainTextEdit()
QString	anchorAt(const QPoint &pos) const
bool	backgroundVisible() const
int	blockCount() const
bool	canPaste() const
bool	centerOnScroll() const
QMenu *	createStandardContextMenu()
QMenu *	createStandardContextMenu(const QPoint &position)
QTextCharFormat	currentCharFormat() const
QTextCursor	cursorForPosition(const QPoint &pos) const
QRect	cursorRect(const QTextCursor &cursor) const
QRect	cursorRect() const
int	cursorWidth() const
QTextDocument *	document() const
QString	documentTitle() const
void	ensureCursorVisible()
QList<QTextEdit::ExtraSelection>	extraSelections() const
bool	find(const QString &exp, QTextDocument::FindFlags options = QTextDocument::FindFlags())
bool	find(const QRegExp &exp, QTextDocument::FindFlags options = QTextDocument::FindFlags())
bool	find(const QRegularExpression &exp, QTextDocument::FindFlags options = QTextDocument::FindFlags())
bool	isReadOnly() const
bool	isUndoRedoEnabled() const
QPlainTextEdit::LineWrapMode	lineWrapMode() const
virtual QVariant	loadResource(int type, const QUrl &name)
int	maximumBlockCount() const
void	mergeCurrentCharFormat(const QTextCharFormat &modifier)
void	moveCursor(QTextCursor::MoveOperation operation, QTextCursor::MoveMode mode = QTextCursor::MoveAnchor)
bool	overwriteMode() const
QString	placeholderText() const
void	print(QPagedPaintDevice *printer) const
void	setBackgroundVisible(bool visible)
void	setCenterOnScroll(bool enabled)
void	setCurrentCharFormat(const QTextCharFormat &format)
void	setCursorWidth(int width)
void	setDocument(QTextDocument *document)
void	setDocumentTitle(const QString &title)
void	setExtraSelections(const QList<QTextEdit::ExtraSelection> &selections)
void	setLineWrapMode(QPlainTextEdit::LineWrapMode mode)
void	setMaximumBlockCount(int maximum)
void	setOverwriteMode(bool overwrite)
void	setPlaceholderText(const QString &placeholderText)
void	setReadOnly(bool ro)
void	setTabChangesFocus(bool b)
void	setTabStopDistance(qreal distance)
void	setTextCursor(const QTextCursor &cursor)
void	setTextInteractionFlags(Qt::TextInteractionFlags flags)
void	setUndoRedoEnabled(bool enable)
void	setWordWrapMode(QTextOption::WrapMode policy)
bool	tabChangesFocus() const
qreal	tabStopDistance() const
QTextCursor	textCursor() const
Qt::TextInteractionFlags	textInteractionFlags() const
QString	toPlainText() const
QTextOption::WrapMode	wordWrapMode() const

Reimplemented Public Functions

virtual QVariant

inputMethodQuery(Qt::InputMethodQuery property) const override

Public Slots

void	appendHtml(const QString &html)
void	appendPlainText(const QString &text)
void	centerCursor()
void	clear()
void	copy()
void	cut()
void	insertPlainText(const QString &text)
void	paste()
void	redo()
void	selectAll()
void	setPlainText(const QString &text)
void	undo()
void	zoomIn(int range = 1)
void	zoomOut(int range = 1)

Signals

void	blockCountChanged(int newBlockCount)
void	copyAvailable(bool yes)
void	cursorPositionChanged()
void	modificationChanged(bool changed)
void	redoAvailable(bool available)
void	selectionChanged()
void	textChanged()
void	undoAvailable(bool available)
void	updateRequest(const QRect &rect, int dy)

Protected Functions

QRectF	blockBoundingGeometry(const QTextBlock &block) const
QRectF	blockBoundingRect(const QTextBlock &block) const
virtual bool	canInsertFromMimeData(const QMimeData *source) const
QPointF	contentOffset() const
virtual QMimeData *	createMimeDataFromSelection() const
QTextBlock	firstVisibleBlock() const
QAbstractTextDocumentLayout::PaintContext	getPaintContext() const
virtual void	insertFromMimeData(const QMimeData *source)

Reimplemented Protected Functions

virtual void	changeEvent(QEvent *e) override
virtual void	contextMenuEvent(QContextMenuEvent *event) override
virtual void	dragEnterEvent(QDragEnterEvent *e) override
virtual void	dragLeaveEvent(QDragLeaveEvent *e) override
virtual void	dragMoveEvent(QDragMoveEvent *e) override
virtual void	dropEvent(QDropEvent *e) override
virtual void	focusInEvent(QFocusEvent *e) override
virtual bool	focusNextPrevChild(bool next) override
virtual void	focusOutEvent(QFocusEvent *e) override
virtual void	inputMethodEvent(QInputMethodEvent *e) override
virtual void	keyPressEvent(QKeyEvent *e) override
virtual void	keyReleaseEvent(QKeyEvent *e) override
virtual void	mouseDoubleClickEvent(QMouseEvent *e) override
virtual void	mouseMoveEvent(QMouseEvent *e) override
virtual void	mousePressEvent(QMouseEvent *e) override
virtual void	mouseReleaseEvent(QMouseEvent *e) override
virtual void	paintEvent(QPaintEvent *e) override
virtual void	resizeEvent(QResizeEvent *e) override
virtual void	scrollContentsBy(int dx, int dy) override
virtual void	showEvent(QShowEvent *) override
virtual void	wheelEvent(QWheelEvent *e) override

Detailed Description

Introduction and Concepts

QPlainTextEdit is an advanced viewer/editor supporting plain text. It is optimized to handle large documents and to respond quickly to user input.

QPlainText uses very much the same technology and concepts as QTextEdit, but is optimized for plain text handling.

QPlainTextEdit works on paragraphs and characters. A paragraph is a formatted string which is word-wrapped to fit into the width of the widget. By default when reading plain text, one newline signifies a paragraph. A document consists of zero or more paragraphs. Paragraphs are separated by hard line breaks. Each character within a paragraph has its own attributes, for example, font and color.

The shape of the mouse cursor on a QPlainTextEdit is Qt::IBeamCursor by default. It can be changed through the viewport()'s cursor property.

Using QPlainTextEdit as a Display Widget

The text is set or replaced using setPlainText() which deletes the existing text and replaces it with the text passed to setPlainText().

Text can be inserted using the QTextCursor class or using the convenience functions insertPlainText(), appendPlainText() or paste().

By default, the text edit wraps words at whitespace to fit within the text edit widget. The setLineWrapMode() function is used to specify the kind of line wrap you want, WidgetWidth or NoWrap if you don't want any wrapping. If you use word wrap to the widget's width WidgetWidth, you can specify whether to break on whitespace or anywhere with setWordWrapMode().

The find() function can be used to find and select a given string within the text.

If you want to limit the total number of paragraphs in a QPlainTextEdit, as it is for example useful in a log viewer, then you can use the maximumBlockCount property. The combination of setMaximumBlockCount() and appendPlainText() turns QPlainTextEdit into an efficient viewer for log text. The scrolling can be reduced with the centerOnScroll() property, making the log viewer even faster. Text can be formatted in a limited way, either using a syntax highlighter (see below), or by appending html-formatted text with appendHtml(). While QPlainTextEdit does not support complex rich text rendering with tables and floats, it does support limited paragraph-based formatting that you may need in a log viewer.

Read-only Key Bindings

When QPlainTextEdit is used read-only the key bindings are limited to navigation, and text may only be selected with the mouse:

Keypresses	Action
Qt::UpArrow	Moves one line up.
Qt::DownArrow	Moves one line down.
Qt::LeftArrow	Moves one character to the left.
Qt::RightArrow	Moves one character to the right.
PageUp	Moves one (viewport) page up.
PageDown	Moves one (viewport) page down.
Home	Moves to the beginning of the text.
End	Moves to the end of the text.
Alt+Wheel	Scrolls the page horizontally (the Wheel is the mouse wheel).
Ctrl+Wheel	Zooms the text.
Ctrl+A	Selects all text.

Using QPlainTextEdit as an Editor

All the information about using QPlainTextEdit as a display widget also applies here.

Selection of text is handled by the QTextCursor class, which provides functionality for creating selections, retrieving the text contents or deleting selections. You can retrieve the object that corresponds with the user-visible cursor using the textCursor() method. If you want to set a selection in QPlainTextEdit just create one on a QTextCursor object and then make that cursor the visible cursor using setCursor(). The selection can be copied to the clipboard with copy(), or cut to the clipboard with cut(). The entire text can be selected using selectAll().

QPlainTextEdit holds a QTextDocument object which can be retrieved using the document() method. You can also set your own document object using setDocument(). QTextDocument emits a textChanged() signal if the text changes and it also provides a isModified() function which will return true if the text has been modified since it was either loaded or since the last call to setModified with false as argument. In addition it provides methods for undo and redo.

Syntax Highlighting

Just like QTextEdit, QPlainTextEdit works together with QSyntaxHighlighter.

Editing Key Bindings

The list of key bindings which are implemented for editing:

Keypresses	Action
Backspace	Deletes the character to the left of the cursor.
Delete	Deletes the character to the right of the cursor.
Ctrl+C	Copy the selected text to the clipboard.
Ctrl+Insert	Copy the selected text to the clipboard.
Ctrl+K	Deletes to the end of the line.
Ctrl+V	Pastes the clipboard text into text edit.
Shift+Insert	Pastes the clipboard text into text edit.
Ctrl+X	Deletes the selected text and copies it to the clipboard.
Shift+Delete	Deletes the selected text and copies it to the clipboard.
Ctrl+Z	Undoes the last operation.
Ctrl+Y	Redoes the last operation.
LeftArrow	Moves the cursor one character to the left.
Ctrl+LeftArrow	Moves the cursor one word to the left.
RightArrow	Moves the cursor one character to the right.
Ctrl+RightArrow	Moves the cursor one word to the right.
UpArrow	Moves the cursor one line up.
Ctrl+UpArrow	Moves the cursor one word up.
DownArrow	Moves the cursor one line down.
Ctrl+Down Arrow	Moves the cursor one word down.
PageUp	Moves the cursor one page up.
PageDown	Moves the cursor one page down.
Home	Moves the cursor to the beginning of the line.
Ctrl+Home	Moves the cursor to the beginning of the text.
End	Moves the cursor to the end of the line.
Ctrl+End	Moves the cursor to the end of the text.
Alt+Wheel	Scrolls the page horizontally (the Wheel is the mouse wheel).
Ctrl+Wheel	Zooms the text.

To select (mark) text hold down the Shift key whilst pressing one of the movement keystrokes, for example, Shift+Right Arrow will select the character to the right, and Shift+Ctrl+Right Arrow will select the word to the right, etc.

Differences to QTextEdit

QPlainTextEdit is a thin class, implemented by using most of the technology that is behind QTextEdit and QTextDocument. Its performance benefits over QTextEdit stem mostly from using a different and simplified text layout called QPlainTextDocumentLayout on the text document (see QTextDocument::setDocumentLayout()). The plain text document layout does not support tables nor embedded frames, and replaces a pixel-exact height calculation with a line-by-line respectively paragraph-by-paragraph scrolling approach. This makes it possible to handle significantly larger documents, and still resize the editor with line wrap enabled in real time. It also makes for a fast log viewer (see setMaximumBlockCount()).

See also QTextDocument, QTextCursor, Application Example, Code Editor Example, Syntax Highlighter Example, and Rich Text Processing.

Member Type Documentation

enum QPlainTextEdit::LineWrapMode

Constant	Value
QPlainTextEdit::NoWrap	0
QPlainTextEdit::WidgetWidth	1

Member Function Documentation

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

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

QPlainTextEdit::QPlainTextEdit(QWidget *parent = nullptr)

Constructs an empty QPlainTextEdit with parent parent.

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

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

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

[slot] void QPlainTextEdit::centerCursor()

Scrolls the document in order to center the cursor vertically.

See also ensureCursorVisible() and centerOnScroll.

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

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

[signal] void QPlainTextEdit::cursorPositionChanged()

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

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

[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);

[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.

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

[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).

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

[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.

Note: Setter function for property plainText.

See also toPlainText().

[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.

Note: Notifier signal for property plainText.

[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.

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

[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.

This function was introduced in Qt 4.7.

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

[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.

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

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

[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;
}

[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.

This function was introduced in Qt 5.5.

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).

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.

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 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 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.

This function was introduced in Qt 5.13.

[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.

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

[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).

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().

[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).

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().

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).

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.

Note: Getter function for property plainText.

See also QPlainTextEdit::setPlainText().

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

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