Defines if lines are wrapped.

Constructs an empty QPlainTextEdit with the given parent.

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

Destroys the current QPlainTextEdit object.

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

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

See also

appendPlainText()

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

See also

appendHtml()

Returns the value of the property.

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

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

See also

blockBoundingGeometry()

Returns the value of the property.

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

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.

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

Scrolls the document in order to center the cursor vertically.

See also

ensureCursorVisible(), centerOnScroll

Returns the value of the property.

Reimplemented from QFrame::changeEvent()

Deletes all the text in the text edit. The undo/redo history is cleared by this method.

See also

cut(), setPlainText()

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

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

Reimplemented from QAbstractScrollArea::contextMenuEvent()

Copies any selected text to the clipboard.

See also

copyAvailable()

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 status set to true. If no text has been selected or if the selected text is de-selected this signal is emitted with status set to false. If true then copy() can be used to copy the selection to the clipboard. If it is false then copy() does nothing.

See also

selectionChanged()

This method 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 method, be aware the ownership of the returned QMimeData object is passed to the caller. The selection can be retrieved by using the textCursor() function.

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

This method creates the standard context menu which is shown when the user clicks on the text edit with the right mouse button. Called from the default contextMenuEvent() handler. The given position indicates in document coordinates where the mouse click occurred.

This method may create a different menu based on the position where the user clicked. The popup menu's ownership is transferred to the caller.

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

See also

setCurrentCharFormat()

Returns a QTextCursor at position pos in viewport coordinates.

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

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

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

Returns the value of the property.

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

Returns a pointer to the underlying document.

See also

setDocument()

Returns the value of the property.

Reimplemented from QAbstractScrollArea::dragEnterEvent()

Reimplemented from QAbstractScrollArea::dragLeaveEvent()

Reimplemented from QAbstractScrollArea::dragMoveEvent()

Reimplemented from QAbstractScrollArea::dropEvent()

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

See also

centerCursor(), centerOnScroll

Reimplemented from QAbstractScrollArea::event()

Returns previously set extra selections.

See also

setExtraSelections()

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

The QTextDocument::FindCaseSensitively option will be ignored, use QRegularExpression::CaseInsensitiveOption instead.

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.

Returns the first visible block.

See also

blockBoundingRect()

Reimplemented from QWidget::focusInEvent()

Reimplemented from QWidget::focusNextPrevChild()

Reimplemented from QWidget::focusOutEvent()

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

Reimplemented from QWidget::inputMethodEvent()

Reimplemented from QWidget::inputMethodQuery()

Reimplemented from QWidget::inputMethodQuery()

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

This is a slot which inserts text at the current cursor position. Equivalent to calling the following.

Returns the value of the property.

Returns the value of the property.

Reimplemented from QAbstractScrollArea::keyPressEvent()

Reimplemented from QWidget::keyReleaseEvent()

Returns the value of the property.

Loads the resource specified by the given type and name. This method is an extension of QTextDocument::loadResource().

See also

QTextDocument::loadResource()

Returns the value of the property.

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

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.

Reimplemented from QAbstractScrollArea::mouseDoubleClickEvent()

Reimplemented from QAbstractScrollArea::mouseMoveEvent()

Reimplemented from QAbstractScrollArea::mousePressEvent()

Reimplemented from QAbstractScrollArea::mouseReleaseEvent()

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

Returns the value of the property.

Reimplemented from QAbstractScrollArea::paintEvent()

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 method, which will modify what QPlainTextEdit can paste and how it is being pasted, reimplement the virtual canInsertFromMimeData() and insertFromMimeData() methods.

See also

cut(), copy()

Returns the value of the property.

This method prints the text edit document to the given printer. This is equivalent to calling the print method on the document directly except this method also supports QPrinter::Selection as a print range.

See also

QTextDocument::print()

The last operation is redone. If there is no operation to redo, then there is no redo step in the undo/redo history and nothing happens.

See also

undo()

This signal is emitted when the redo operations become available. If redo operation is possible then status will be true, otherwise it will be false.

Reimplemented from QAbstractScrollArea::resizeEvent()

Reimplemented from QAbstractScrollArea::scrollContentsBy()

Selects all text.

See also

copy(), cut(), textCursor()

This signal is emitted whenever the selection changes.

See also

copyAvailable()

Sets the value of the property to visible.

Sets the value of the property to enable.

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

Sets the value of the property to width.

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

Sets the value of the property to title.

This method 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, extraSelections()

Sets the value of the property to mode.

Sets the value of the property to maximum.

Sets the value of the property to overwrite.

Sets the value of the property to placeholderText.

Changes the text for this QPlainTextEdit to text. Any previous text is removed and the undo/redo history is cleared.

See also

toPlainText()

Sets the value of the property to ro.

Sets the value of the property to enable.

Sets the value of the property to width.

Sets the visible cursor.

See also

textCursor()

Sets the value of the property to flags.

Sets the value of the property to enable.

Sets the value of the property to policy.

Reimplemented from QWidget::showEvent()

Returns the value of the property.

Returns the value of the property.

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

Returns a copy of the QTextCursor which represents the currently visible cursor. Changes on the returned cursor do not affect the QPlainTextEdit cursor. Use setTextCursor() to update the visible cursor.

See also

setTextCursor()

Returns the value of the property.

Reimplemented from QObject::timerEvent()

Returns the text for this QPlatTextEdit as plain text.

See also

QPlainTextEdit::setPlainText()

Undoes the last operation. If there is no operation to undo, there is no undo step in the undo/redo history and nothing happens.

See also

redo()

This signal is emitted when the undo operations become available. If the undo operation is possible then status will be true, otherwise it will be false.

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.

Reimplemented from QAbstractScrollArea::wheelEvent()

Returns the value of the property.

Increases the base font size by the given range which is specified in points. All font sizes are recalculated based on the new size. The size of any image is not affected.

See also

zoomOut()

Increases the base font size by the given range which is specified in points. All font sizes are recalculated based on the new size. The size of any image is not affected.

Decreases the base font size by the given range which is specified in points. All font sizes are recalculated based on the new size. The size of any image is not affected.

See also

zoomIn()

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

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

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

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

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

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

By default, this property contains an empty string.

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

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. This setting this property will apply the limit immediately to the document contents. Setting this property also disables the undo redo history.

The default value is 0.

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

This property holds the editor placeholder text. By default,this property contains an empty string.

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

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.

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

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.

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.

This property holds the tab stop width in pixels.

By default, this property contains a value of 80.

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 QPlainTextEdit is read-only or editable.

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.

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

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

See also

QTextOption::WrapMode