- Extending Qt Creator Manual
- QtCreator
- PlainTextEdit
- Extending Qt Creator Manual 18.0.1

# Utils::PlainTextEdit Class

class Utils::PlainTextEdit

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

Header: | `#include <PlainTextEdit>`

- List of all members, including inherited 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

| PlainTextEdit(QWidget *parent = nullptr)
| PlainTextEdit(const QString &text, QWidget *parent = nullptr)
virtual | ~PlainTextEdit()
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
QRect | cursorRect(const QTextCursor &cursor) const
int | cursorWidth() const
QTextDocument * | document() const
QString | documentTitle() const
void | ensureCursorVisible()
int | extraSelections() const
bool | isReadOnly() const
bool | isUndoRedoEnabled() const
Utils::PlainTextEdit::LineWrapMode | lineWrapMode() const
virtual QVariant | loadResource(int type, const QUrl &name)
int | maximumBlockCount() const
void | mergeCurrentCharFormat(const QTextCharFormat &modifier)
bool | overwriteMode() const
QString | placeholderText() 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 int &selections)
void | setLineWrapMode(Utils::PlainTextEdit::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(int policy)
bool | tabChangesFocus() const
qreal | tabStopDistance() const
QTextCursor | textCursor() const
Qt::TextInteractionFlags | textInteractionFlags() const
QString | toPlainText() const
int | wordWrapMode() const

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

virtual bool | canInsertFromMimeData(const QMimeData *source) const
QPointF | contentOffset() const
virtual QMimeData * | createMimeDataFromSelection() const
int | firstVisibleBlock() const
virtual bool | focusNextPrevChild(bool next) override
int | getPaintContext() const
virtual void | insertFromMimeData(const QMimeData *source)
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

## Detailed Description

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

PlainTextEdit 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 PlainTextEdit is Qt::IBeamCursor by default. It can be changed through the `viewport()` cursor property.

### Using PlainTextEdit 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 PlainTextEdit, as it is for example useful in a log viewer, then you can use the maximumBlockCount property. The combination of setMaximumBlockCount() and appendPlainText() turns PlainTextEdit 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 PlainTextEdit 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 PlainTextEdit 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 PlainTextEdit as an Editor

All the information about using PlainTextEdit 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 PlainTextEdit 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().

PlainTextEdit 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 an `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, PlainTextEdit 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

PlainTextEdit 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 PlainTextDocumentLayout 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, Syntax Highlighter Example, and Rich Text Processing.

## Member Type Documentation

### enum PlainTextEdit::LineWrapMode

Holds the line wrap mode.

Constant | Value
--- | ---
`Utils::PlainTextEdit::NoWrap` | `0`
`Utils::PlainTextEdit::WidgetWidth` | `1`

## Property Documentation

### backgroundVisible : bool

This property holds whether the palette background is visible outside the document area.

If set to `true`, the plain text edit paints the palette background on the viewport area not covered by the text document. Otherwise, if set to `false`, it won't. The feature makes it possible for the user to visually distinguish between the area of the document, painted with the base color of the palette, and the empty area not covered by any document.

The default is `false`.

Access functions:

bool | backgroundVisible() const
void | setBackgroundVisible(bool visible)

### `[read-only]` blockCount : const int

This property holds the number of text blocks in the document.

By default, in an empty document, this property contains a value of 1.

Access functions:

int | blockCount() const

### centerOnScroll : bool

This property holds whether the cursor should be centered on screen.

If set to `true`, the plain text edit scrolls the document vertically to make the cursor visible at the center of the viewport. This also allows the text edit to scroll below the end of the document. Otherwise, if set to `false`, the plain text edit scrolls the smallest amount possible to ensure the cursor is visible. The same algorithm is applied to any new line appended through appendPlainText().

The default is `false`.

Access functions:

bool | centerOnScroll() const
void | setCenterOnScroll(bool enabled)

See also centerCursor() and ensureCursorVisible().

### cursorWidth : int

This property specifies the width of the cursor in pixels. The default value is 1.

Access functions:

int | cursorWidth() const
void | setCursorWidth(int width)

### documentTitle : QString

This property holds the title of the document parsed from the text.

By default, this property contains an empty string.

Access functions:

QString | documentTitle() const
void | setDocumentTitle(const QString &title)

### lineWrapMode : LineWrapMode

This property holds the line wrap mode

The default mode is WidgetWidth which causes words to be wrapped at the right edge of the text edit. Wrapping occurs at whitespace, keeping whole words intact. If you want wrapping to occur within words use setWordWrapMode().

Access functions:

Utils::PlainTextEdit::LineWrapMode | lineWrapMode() const
void | setLineWrapMode(Utils::PlainTextEdit::LineWrapMode mode)

### maximumBlockCount : int

This property holds the limit for blocks in the document.

Specifies the maximum number of blocks the document may have. If there are more blocks in the document that specified with this property blocks are removed from the beginning of the document.

A negative or zero value specifies that the document may contain an unlimited amount of blocks.

The default value is 0.

Note that setting this property will apply the limit immediately to the document contents. Setting this property also disables the undo redo history.

Access functions:

int | maximumBlockCount() const
void | setMaximumBlockCount(int maximum)

### overwriteMode : bool

This property holds whether text entered by the user will overwrite existing text

As with many text editors, the plain text editor widget can be configured to insert or overwrite existing text with new text entered by the user.

If this property is `true`, existing text is overwritten, character-for-character by new text; otherwise, text is inserted at the cursor position, displacing existing text.

By default, this property is `false` (new text does not overwrite existing text).

Access functions:

bool | overwriteMode() const
void | setOverwriteMode(bool overwrite)

### placeholderText : QString

This property holds the editor placeholder text

Setting this property makes the editor display a grayed-out placeholder text as long as the document() is empty.

By default, this property contains an empty string.

Access functions:

QString | placeholderText() const
void | setPlaceholderText(const QString &placeholderText)

See also document().

### plainText : QString

This property gets and sets the plain text editor's contents. The previous contents are removed and undo/redo history is reset when this property is set. currentCharFormat() is also reset, unless textCursor() is already at the beginning of the document.

By default, for an editor with no contents, this property contains an empty string.

Access functions:

QString | toPlainText() const
void | setPlainText(const QString &text)

Notifier signal:

void | textChanged()

### readOnly : bool

This property holds whether the text edit is read-only

In a read-only text edit the user can only navigate through the text and select text; modifying the text is not possible.

This property's default is `false`.

Access functions:

bool | isReadOnly() const
void | setReadOnly(bool ro)

### tabChangesFocus : bool

This property holds whether Tab changes focus or is accepted as input

In some occasions text edits should not allow the user to input tabulators or change indentation using the Tab key, as this breaks the focus chain. The default is `false`.

Access functions:

bool | tabChangesFocus() const
void | setTabChangesFocus(bool b)

### tabStopDistance : qreal

This property holds the tab stop distance in pixels

By default, this property contains a value of 80 pixels.

Do not set a value less than the horizontalAdvance() of the QChar::VisualTabCharacter character, otherwise the tab-character will be drawn incompletely.

Access functions:

qreal | tabStopDistance() const
void | setTabStopDistance(qreal distance)

See also QTextOption::ShowTabsAndSpaces and QTextDocument::defaultTextOption.

### textInteractionFlags : Qt::TextInteractionFlags

Specifies how the label should interact with user input if it displays text.

If the flags contain either Qt::LinksAccessibleByKeyboard or Qt::TextSelectableByKeyboard then the focus policy is also automatically set to Qt::ClickFocus.

The default value depends on whether the PlainTextEdit is read-only or editable.

Access functions:

Qt::TextInteractionFlags | textInteractionFlags() const
void | setTextInteractionFlags(Qt::TextInteractionFlags flags)

### undoRedoEnabled : bool

This property holds whether undo and redo are enabled

Users are only able to undo or redo actions if this property is `true`, and if there is an action that can be undone (or redone).

By default, this property is `true`.

Access functions:

bool | isUndoRedoEnabled() const
void | setUndoRedoEnabled(bool enable)

### wordWrapMode : QTextOption::WrapMode

This property holds the mode PlainTextEdit will use when wrapping text by words

By default, this property is set to QTextOption::WrapAtWordBoundaryOrAnywhere.

Access functions:

int | wordWrapMode() const
void | setWordWrapMode(int policy)

See also QTextOption::WrapMode.

## Member Function Documentation

### `[explicit]` PlainTextEdit::PlainTextEdit(QWidget *parent = nullptr)

Constructs an empty PlainTextEdit with parent parent.

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

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

### `[virtual noexcept]` PlainTextEdit::~PlainTextEdit()

Destructor.

### QString PlainTextEdit::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 PlainTextEdit::appendHtml(const QString &html)

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

appendPlainText()

### `[slot]` void PlainTextEdit::appendPlainText(const QString &text)

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

See also appendHtml().

### `[signal]` void PlainTextEdit::blockCountChanged(int newBlockCount)

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

### `[virtual protected]` bool PlainTextEdit::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 PlainTextEdit::canPaste() const

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

### `[slot]` void PlainTextEdit::centerCursor()

Scrolls the document in order to center the cursor vertically.

See also ensureCursorVisible() and centerOnScroll.

### `[slot]` void PlainTextEdit::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 PlainTextEdit::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(), QAbstractScrollArea::horizontalScrollBar(), and QAbstractScrollArea::verticalScrollBar().

### `[slot]` void PlainTextEdit::copy()

Copies any selected text to the clipboard.

See also copyAvailable().

### `[signal]` void PlainTextEdit::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 *PlainTextEdit::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 *PlainTextEdit::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 *PlainTextEdit::createStandardContextMenu(const QPoint &position)

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 PlainTextEdit::currentCharFormat() const

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

See also setCurrentCharFormat().

### QTextCursor PlainTextEdit::cursorForPosition(const QPoint &pos) const

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

### `[signal]` void PlainTextEdit::cursorPositionChanged()

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

### `[invokable]` QRect PlainTextEdit::cursorRect() const

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

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

### QRect PlainTextEdit::cursorRect(const QTextCursor &cursor) const

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

### `[slot]` void PlainTextEdit::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 *PlainTextEdit::document() const

Returns a pointer to the underlying document.

See also setDocument().

### void PlainTextEdit::ensureCursorVisible()

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

See also centerCursor() and centerOnScroll.

### int PlainTextEdit::extraSelections() const

Returns previously set extra selections.

See also setExtraSelections().

### `[protected]` int PlainTextEdit::firstVisibleBlock() const

Returns the first visible block.

### `[override virtual protected]` bool PlainTextEdit::focusNextPrevChild(bool next)

### `[protected]` int PlainTextEdit::getPaintContext() const

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

### `[virtual protected]` void PlainTextEdit::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 PlainTextEdit::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 PlainTextEdit::keyPressEvent(QKeyEvent *e)

### `[override virtual protected]` void PlainTextEdit::keyReleaseEvent(QKeyEvent *e)

### `[virtual]` QVariant PlainTextEdit::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 PlainTextEdit::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 PlainTextEdit::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 PlainTextEdit::mouseDoubleClickEvent(QMouseEvent *e)

### `[override virtual protected]` void PlainTextEdit::mouseMoveEvent(QMouseEvent *e)

### `[override virtual protected]` void PlainTextEdit::mousePressEvent(QMouseEvent *e)

### `[override virtual protected]` void PlainTextEdit::mouseReleaseEvent(QMouseEvent *e)

### `[override virtual protected]` void PlainTextEdit::paintEvent(QPaintEvent *e)

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

See also cut() and copy().

### `[slot]` void PlainTextEdit::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 PlainTextEdit::redoAvailable(bool available)

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

### `[slot]` void PlainTextEdit::selectAll()

Selects all text.

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

### `[signal]` void PlainTextEdit::selectionChanged()

This signal is emitted whenever the selection changes.

See also copyAvailable().

### void PlainTextEdit::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 PlainTextEdit::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 PlainTextDocumentLayout (see QTextDocument::setDocumentLayout()).

See also document().

### void PlainTextEdit::setExtraSelections(const int &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 PlainTextEdit::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().

### void PlainTextEdit::setTextCursor(const QTextCursor &cursor)

Sets the visible cursor.

See also textCursor().

### `[signal]` void PlainTextEdit::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.

### QTextCursor PlainTextEdit::textCursor() const

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

See also setTextCursor().

### QString PlainTextEdit::toPlainText() const

Returns the text of the text edit as plain text.

Note: Getter function for property plainText.

See also PlainTextEdit::setPlainText().

### `[slot]` void PlainTextEdit::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 PlainTextEdit::undoAvailable(bool available)

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

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