QPlainTextEdit

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

Synopsis

Functions

• def anchorAt (pos)

• def backgroundVisible ()

• def blockBoundingGeometry (block)

• def blockBoundingRect (block)

• def blockCount ()

• def canPaste ()

• def centerOnScroll ()

• def contentOffset ()

• def createStandardContextMenu ()

• def createStandardContextMenu (position)

• def currentCharFormat ()

• def cursorForPosition (pos)

• def cursorRect ()

• def cursorRect (cursor)

• def cursorWidth ()

• def document ()

• def documentTitle ()

• def ensureCursorVisible ()

• def extraSelections ()

• def find (exp[, options=QTextDocument.FindFlags()])

• def find (exp[, options=QTextDocument.FindFlags()])

• def find (exp[, options=QTextDocument.FindFlags()])

• def firstVisibleBlock ()

• def getPaintContext ()

• def inputMethodQuery (query, argument)

• def isReadOnly ()

• def isUndoRedoEnabled ()

• def lineWrapMode ()

• def maximumBlockCount ()

• def mergeCurrentCharFormat (modifier)

• def moveCursor (operation[, mode=QTextCursor.MoveAnchor])

• def overwriteMode ()

• def placeholderText ()

• def print_ (printer)

• def setBackgroundVisible (visible)

• def setCenterOnScroll (enabled)

• def setCurrentCharFormat (format)

• def setCursorWidth (width)

• def setDocument (document)

• def setDocumentTitle (title)

• def setExtraSelections (selections)

• def setLineWrapMode (mode)

• def setMaximumBlockCount (maximum)

• def setOverwriteMode (overwrite)

• def setPlaceholderText (placeholderText)

• def setReadOnly (ro)

• def setTabChangesFocus (b)

• def setTabStopDistance (distance)

• def setTabStopWidth (width)

• def setTextCursor (cursor)

• def setTextInteractionFlags (flags)

• def setUndoRedoEnabled (enable)

• def setWordWrapMode (policy)

• def tabChangesFocus ()

• def tabStopDistance ()

• def tabStopWidth ()

• def textCursor ()

• def textInteractionFlags ()

• def toPlainText ()

• def wordWrapMode ()

• def zoomInF (range)

Virtual functions

• def canInsertFromMimeData (source)

• def createMimeDataFromSelection ()

• def doSetTextCursor (cursor)

• def insertFromMimeData (source)

• def loadResource (type, name)

Slots

• def appendHtml (html)

• def appendPlainText (text)

• def centerCursor ()

• def clear ()

• def copy ()

• def cut ()

• def insertPlainText (text)

• def paste ()

• def redo ()

• def selectAll ()

• def setPlainText (text)

• def undo ()

• def zoomIn ([range=1])

• def zoomOut ([range=1])

Signals

• def blockCountChanged (newBlockCount)

• def copyAvailable (b)

• def cursorPositionChanged ()

• def modificationChanged (arg__1)

• def redoAvailable (b)

• def selectionChanged ()

• def textChanged ()

• def undoAvailable (b)

• def updateRequest (rect, dy)

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 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
UpArrow	Moves one line up.
DownArrow	Moves one line down.
LeftArrow	Moves one character to the left.
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 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 Rich Text Processing

class PySide2.QtWidgets.QPlainTextEdit([parent=None])

PySide2.QtWidgets.QPlainTextEdit(text[, parent=None])

param parent:

PySide2.QtWidgets.QWidget

param text:

str

Constructs an empty QPlainTextEdit with parent parent .

PySide2.QtWidgets.QPlainTextEdit.LineWrapMode

Constant	Description
QPlainTextEdit.NoWrap
QPlainTextEdit.WidgetWidth

PySide2.QtWidgets.QPlainTextEdit.anchorAt(pos)

Parameters:

pos – PySide2.QtCore.QPoint

Return type:

str

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

PySide2.QtWidgets.QPlainTextEdit.appendHtml(html)

Parameters:

html – str

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

appendPlainText()

PySide2.QtWidgets.QPlainTextEdit.appendPlainText(text)

Parameters:

text – str

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

See also

appendHtml()

PySide2.QtWidgets.QPlainTextEdit.backgroundVisible()

Return type:

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.

PySide2.QtWidgets.QPlainTextEdit.blockBoundingGeometry(block)

Parameters:

block – PySide2.QtGui.QTextBlock

Return type:

PySide2.QtCore.QRectF

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

PySide2.QtWidgets.QPlainTextEdit.blockBoundingRect(block)

Parameters:

block – PySide2.QtGui.QTextBlock

Return type:

PySide2.QtCore.QRectF

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

See also

blockBoundingGeometry()

PySide2.QtWidgets.QPlainTextEdit.blockCount()

Return type:

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.

PySide2.QtWidgets.QPlainTextEdit.blockCountChanged(newBlockCount)

Parameters:

newBlockCount – int

PySide2.QtWidgets.QPlainTextEdit.canInsertFromMimeData(source)

Parameters:

source – PySide2.QtCore.QMimeData

Return type:

bool

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.

PySide2.QtWidgets.QPlainTextEdit.canPaste()

Return type:

bool

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

PySide2.QtWidgets.QPlainTextEdit.centerCursor()

Scrolls the document in order to center the cursor vertically.

See also

ensureCursorVisible() centerOnScroll

PySide2.QtWidgets.QPlainTextEdit.centerOnScroll()

Return type:

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.

See also

centerCursor() ensureCursorVisible()

PySide2.QtWidgets.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() setPlainText()

PySide2.QtWidgets.QPlainTextEdit.contentOffset()

Return type:

PySide2.QtCore.QPointF

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

PySide2.QtWidgets.QPlainTextEdit.copy()

Copies any selected text to the clipboard.

See also

copyAvailable()

PySide2.QtWidgets.QPlainTextEdit.copyAvailable(b)

Parameters:

b – bool

PySide2.QtWidgets.QPlainTextEdit.createMimeDataFromSelection()

Return type:

PySide2.QtCore.QMimeData

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.

PySide2.QtWidgets.QPlainTextEdit.createStandardContextMenu()

Return type:

PySide2.QtWidgets.QMenu

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 ( QPoint ) version instead which will enable the actions that are sensitive to where the user clicked.

PySide2.QtWidgets.QPlainTextEdit.createStandardContextMenu(position)

Parameters:

position – PySide2.QtCore.QPoint

Return type:

PySide2.QtWidgets.QMenu

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.

PySide2.QtWidgets.QPlainTextEdit.currentCharFormat()

Return type:

PySide2.QtGui.QTextCharFormat

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

See also

setCurrentCharFormat()

PySide2.QtWidgets.QPlainTextEdit.cursorForPosition(pos)

Parameters:

pos – PySide2.QtCore.QPoint

Return type:

PySide2.QtGui.QTextCursor

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

PySide2.QtWidgets.QPlainTextEdit.cursorPositionChanged()

PySide2.QtWidgets.QPlainTextEdit.cursorRect(cursor)

Parameters:

cursor – PySide2.QtGui.QTextCursor

Return type:

PySide2.QtCore.QRect

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

PySide2.QtWidgets.QPlainTextEdit.cursorRect()

Return type:

PySide2.QtCore.QRect

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

PySide2.QtWidgets.QPlainTextEdit.cursorWidth()

Return type:

int

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

PySide2.QtWidgets.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() paste()

PySide2.QtWidgets.QPlainTextEdit.doSetTextCursor(cursor)

Parameters:

cursor – PySide2.QtGui.QTextCursor

This provides a hook for subclasses to intercept cursor changes.

PySide2.QtWidgets.QPlainTextEdit.document()

Return type:

PySide2.QtGui.QTextDocument

Returns a pointer to the underlying document.

See also

setDocument()

PySide2.QtWidgets.QPlainTextEdit.documentTitle()

Return type:

str

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

By default, this property contains an empty string.

PySide2.QtWidgets.QPlainTextEdit.ensureCursorVisible()

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

See also

centerCursor() centerOnScroll

PySide2.QtWidgets.QPlainTextEdit.extraSelections()

Return type:

Returns previously set extra selections.

See also

setExtraSelections()

PySide2.QtWidgets.QPlainTextEdit.find(exp[, options=QTextDocument.FindFlags()])

Parameters:

• exp – PySide2.QtCore.QRegExp

• options – FindFlags

Return type:

bool

PySide2.QtWidgets.QPlainTextEdit.find(exp[, options=QTextDocument.FindFlags()])

Parameters:

• exp – PySide2.QtCore.QRegularExpression

• options – FindFlags

Return type:

bool

PySide2.QtWidgets.QPlainTextEdit.find(exp[, options=QTextDocument.FindFlags()])

Parameters:

• exp – str

• options – FindFlags

Return type:

bool

PySide2.QtWidgets.QPlainTextEdit.firstVisibleBlock()

Return type:

PySide2.QtGui.QTextBlock

Returns the first visible block.

See also

blockBoundingRect()

PySide2.QtWidgets.QPlainTextEdit.getPaintContext()

Return type:

PySide2.QtGui.QAbstractTextDocumentLayout.PaintContext

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

PySide2.QtWidgets.QPlainTextEdit.inputMethodQuery(query, argument)

Parameters:

• query – InputMethodQuery

• argument – object

Return type:

object

PySide2.QtWidgets.QPlainTextEdit.insertFromMimeData(source)

Parameters:

source – PySide2.QtCore.QMimeData

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.

PySide2.QtWidgets.QPlainTextEdit.insertPlainText(text)

Parameters:

text – str

Convenience slot that inserts text at the current cursor position.

It is equivalent to

edit.textCursor().insertText(text)

PySide2.QtWidgets.QPlainTextEdit.isReadOnly()

Return type:

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.

PySide2.QtWidgets.QPlainTextEdit.isUndoRedoEnabled()

Return type:

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 .

PySide2.QtWidgets.QPlainTextEdit.lineWrapMode()

Return type:

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

PySide2.QtWidgets.QPlainTextEdit.loadResource(type, name)

Parameters:

• type – int

• name – PySide2.QtCore.QUrl

Return type:

object

Loads the resource specified by the given type and name .

This function is an extension of loadResource() .

See also

loadResource()

PySide2.QtWidgets.QPlainTextEdit.maximumBlockCount()

Return type:

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.

PySide2.QtWidgets.QPlainTextEdit.mergeCurrentCharFormat(modifier)

Parameters:

modifier – PySide2.QtGui.QTextCharFormat

Merges the properties specified in modifier into the current character format by calling 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

mergeCharFormat()

PySide2.QtWidgets.QPlainTextEdit.modificationChanged(arg__1)

Parameters:

arg__1 – bool

PySide2.QtWidgets.QPlainTextEdit.moveCursor(operation[, mode=QTextCursor.MoveAnchor])

Parameters:

• operation – MoveOperation

• mode – MoveMode

Moves the cursor by performing the given operation .

If mode is 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

movePosition()

PySide2.QtWidgets.QPlainTextEdit.overwriteMode()

Return type:

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

PySide2.QtWidgets.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() copy()

PySide2.QtWidgets.QPlainTextEdit.placeholderText()

Return type:

str

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.

See also

document()

PySide2.QtWidgets.QPlainTextEdit.print_(printer)

Parameters:

printer – PySide2.QtGui.QPagedPaintDevice

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 Selection as print range.

See also

print()

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

PySide2.QtWidgets.QPlainTextEdit.redoAvailable(b)

Parameters:

b – bool

PySide2.QtWidgets.QPlainTextEdit.selectAll()

Selects all text.

See also

copy() cut() textCursor()

PySide2.QtWidgets.QPlainTextEdit.selectionChanged()

PySide2.QtWidgets.QPlainTextEdit.setBackgroundVisible(visible)

Parameters:

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

PySide2.QtWidgets.QPlainTextEdit.setCenterOnScroll(enabled)

Parameters:

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

See also

centerCursor() ensureCursorVisible()

PySide2.QtWidgets.QPlainTextEdit.setCurrentCharFormat(format)

Parameters:

format – PySide2.QtGui.QTextCharFormat

Sets the char format that is be used when inserting new text to format by calling 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()

PySide2.QtWidgets.QPlainTextEdit.setCursorWidth(width)

Parameters:

width – int

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

PySide2.QtWidgets.QPlainTextEdit.setDocument(document)

Parameters:

document – PySide2.QtGui.QTextDocument

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

See also

document()

PySide2.QtWidgets.QPlainTextEdit.setDocumentTitle(title)

Parameters:

title – str

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

By default, this property contains an empty string.

PySide2.QtWidgets.QPlainTextEdit.setExtraSelections(selections)

Parameters:

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

ExtraSelection extraSelections()

PySide2.QtWidgets.QPlainTextEdit.setLineWrapMode(mode)

Parameters:

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

PySide2.QtWidgets.QPlainTextEdit.setMaximumBlockCount(maximum)

Parameters:

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

PySide2.QtWidgets.QPlainTextEdit.setOverwriteMode(overwrite)

Parameters:

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

PySide2.QtWidgets.QPlainTextEdit.setPlaceholderText(placeholderText)

Parameters:

placeholderText – str

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.

See also

document()

PySide2.QtWidgets.QPlainTextEdit.setPlainText(text)

Parameters:

text – str

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.

PySide2.QtWidgets.QPlainTextEdit.setReadOnly(ro)

Parameters:

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

PySide2.QtWidgets.QPlainTextEdit.setTabChangesFocus(b)

Parameters:

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

PySide2.QtWidgets.QPlainTextEdit.setTabStopDistance(distance)

Parameters:

distance – float

This property holds the tab stop distance in pixels.

By default, this property contains a value of 80.

PySide2.QtWidgets.QPlainTextEdit.setTabStopWidth(width)

Parameters:

width – int

Note

This function is deprecated.

This property holds the tab stop width in pixels in Qt 5.10. Use tabStopDistance instead..

By default, this property contains a value of 80.

PySide2.QtWidgets.QPlainTextEdit.setTextCursor(cursor)

Parameters:

cursor – PySide2.QtGui.QTextCursor

Sets the visible cursor .

See also

textCursor()

PySide2.QtWidgets.QPlainTextEdit.setTextInteractionFlags(flags)

Parameters:

flags – TextInteractionFlags

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

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

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

PySide2.QtWidgets.QPlainTextEdit.setUndoRedoEnabled(enable)

Parameters:

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

PySide2.QtWidgets.QPlainTextEdit.setWordWrapMode(policy)

Parameters:

policy – WrapMode

See also

wordWrapMode()

PySide2.QtWidgets.QPlainTextEdit.tabChangesFocus()

Return type:

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.

PySide2.QtWidgets.QPlainTextEdit.tabStopDistance()

Return type:

float

This property holds the tab stop distance in pixels.

By default, this property contains a value of 80.

PySide2.QtWidgets.QPlainTextEdit.tabStopWidth()

Return type:

int

Note

This function is deprecated.

This property holds the tab stop width in pixels in Qt 5.10. Use tabStopDistance instead..

By default, this property contains a value of 80.

PySide2.QtWidgets.QPlainTextEdit.textChanged()

PySide2.QtWidgets.QPlainTextEdit.textCursor()

Return type:

PySide2.QtGui.QTextCursor

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

PySide2.QtWidgets.QPlainTextEdit.textInteractionFlags()

Return type:

TextInteractionFlags

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

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

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

PySide2.QtWidgets.QPlainTextEdit.toPlainText()

Return type:

str

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.

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

PySide2.QtWidgets.QPlainTextEdit.undoAvailable(b)

Parameters:

b – bool

PySide2.QtWidgets.QPlainTextEdit.updateRequest(rect, dy)

Parameters:

• rect – PySide2.QtCore.QRect

• dy – int

PySide2.QtWidgets.QPlainTextEdit.wordWrapMode()

Return type:

WrapMode

See also

setWordWrapMode()

PySide2.QtWidgets.QPlainTextEdit.zoomIn([range=1])

Parameters:

range – int

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

PySide2.QtWidgets.QPlainTextEdit.zoomInF(range)

Parameters:

range – float

PySide2.QtWidgets.QPlainTextEdit.zoomOut([range=1])

Parameters:

range – int

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